Android - An Open Handset Alliance Project

android.graphics
public class

android.graphics.BitmapFactory

java.lang.Object
	android.graphics.BitmapFactory

Creates Bitmap objects from various sources, including files, streams, and byte-arrays.

Nested Classes

BitmapFactory.Options

Summary

Public Constructors

BitmapFactory()

Public Methods

static	Bitmap	decodeByteArray(byte[] data, int offset, int length)
		Decode an immutable bitmap from the specified byte array.
static	Bitmap	decodeByteArray(byte[] data, int offset, int length, Options opts)
		Decode an immutable bitmap from the specified byte array.
static	Bitmap	decodeFile(String pathName, Options opts)
		Decode a file path into a bitmap.
static	Bitmap	decodeFile(String pathName)
		Decode a file path into a bitmap.
static	Bitmap	decodeResource(Resources res, int id, Options opts)
		Decode an image referenced by a resource ID.
static	Bitmap	decodeResource(Resources res, int id)
		Decode an image referenced by a resource ID.
static	Bitmap	decodeStream(InputStream is)
		Decode an input stream into a bitmap.
static	Bitmap	decodeStream(InputStream is, Rect outPadding, Options opts)
		Decode an input stream into a bitmap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Public Constructors

public BitmapFactory()

Public Methods

public static Bitmap decodeByteArray(byte[] data, int offset, int length)

Decode an immutable bitmap from the specified byte array.

Parameters

data	byte array of compressed image data
offset	offset into imageData for where the decoder should begin parsing.
length	the number of bytes, beginning at offset, to parse

Returns

The decoded bitmap, or null if the image could not be decode.

public static Bitmap decodeByteArray(byte[] data, int offset, int length, Options opts)

Decode an immutable bitmap from the specified byte array.

Parameters

data	byte array of compressed image data
offset	offset into imageData for where the decoder should begin parsing.
length	the number of bytes, beginning at offset, to parse
opts	null-ok; Options that control downsampling and whether the image should be completely decoded, or just is size returned.

Returns

The decoded bitmap, or null if the image data could not be decoded, or, if opts is non-null, if opts requested only the size be returned (in opts.outWidth and opts.outHeight)

public static Bitmap decodeFile(String pathName, Options opts)

Decode a file path into a bitmap. If the specified file name is null, or cannot be decoded into a bitmap, the function returns null.

Parameters

pathName	complete path name for the file to be decoded.
opts	null-ok; Options that control downsampling and whether the image should be completely decoded, or just is size returned.

Returns

The decoded bitmap, or null if the image data could not be decoded, or, if opts is non-null, if opts requested only the size be returned (in opts.outWidth and opts.outHeight)

public static Bitmap decodeFile(String pathName)

Decode a file path into a bitmap. If the specified file name is null, or cannot be decoded into a bitmap, the function returns null.

Parameters

pathName	complete path name for the file to be decoded.

Returns

the resulting decoded bitmap, or null if it could not be decoded.

public static Bitmap decodeResource(Resources res, int id, Options opts)

Decode an image referenced by a resource ID.

Parameters

res	The resources object containing the image data
id	The resource id of the image data
opts	null-ok; Options that control downsampling and whether the image should be completely decoded, or just is size returned.

Returns

The decoded bitmap, or null if the image data could not be decoded, or, if opts is non-null, if opts requested only the size be returned (in opts.outWidth and opts.outHeight)

public static Bitmap decodeResource(Resources res, int id)

Decode an image referenced by a resource ID.

Parameters

res	The resources object containing the image data
id	The resource id of the image data

Returns

The decoded bitmap, or null if the image could not be decode.

public static Bitmap decodeStream(InputStream is)

Decode an input stream into a bitmap. If the input stream is null, or cannot be used to decode a bitmap, the function returns null.

Parameters

is	The input stream that holds the raw data to be decoded into a bitmap.

Returns

The decoded bitmap, or null if the image data could not be decoded, or, if opts is non-null, if opts requested only the size be returned (in opts.outWidth and opts.outHeight)

public static Bitmap decodeStream(InputStream is, Rect outPadding, Options opts)

Decode an input stream into a bitmap. If the input stream is null, or cannot be used to decode a bitmap, the function returns null.

Parameters

is	The input stream that holds the raw data to be decoded into a bitmap.
outPadding	If not null, return the padding rect for the bitmap if it exists, otherwise set padding to [-1,-1,-1,-1]. If no bitmap is returned (null) then padding is unchanged.
opts	null-ok; Options that control downsampling and whether the image should be completely decoded, or just is size returned.

Returns

The decoded bitmap, or null if the image data could not be decoded, or, if opts is non-null, if opts requested only the size be returned (in opts.outWidth and opts.outHeight)

Android - An Open Handset Alliance Project

Documentation

Goodies

android.graphics.BitmapFactory

Nested Classes

Summary

Public Constructors

Public Methods

Methods inherited from class java.lang.Object

Details

Public Constructors

public BitmapFactory()

Public Methods

public static Bitmap decodeByteArray(byte[] data, int offset, int length)

Parameters

Returns

public static Bitmap decodeByteArray(byte[] data, int offset, int length, Options opts)

Parameters

Returns

public static Bitmap decodeFile(String pathName, Options opts)

Parameters

Returns

public static Bitmap decodeFile(String pathName)

Parameters

Returns

public static Bitmap decodeResource(Resources res, int id, Options opts)

Parameters

Returns

public static Bitmap decodeResource(Resources res, int id)

Parameters

Returns

public static Bitmap decodeStream(InputStream is)

Parameters

Returns

public static Bitmap decodeStream(InputStream is, Rect outPadding, Options opts)

Parameters

Returns


e.g. "intent" or "activity"