Skip to content

Most visited

Recently visited

navigation

Bitmap

public final class Bitmap
extends Object implements Parcelable

java.lang.Object
   ↳ android.graphics.Bitmap


Summary

Nested classes

enum Bitmap.CompressFormat

Specifies the known formats a bitmap can be compressed into  

enum Bitmap.Config

Possible bitmap configurations. 

Constants

int DENSITY_NONE

Indicates that the bitmap was created for an unknown pixel density.

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<Bitmap> CREATOR

Public methods

boolean compress(Bitmap.CompressFormat format, int quality, OutputStream stream)

Write a compressed version of the bitmap to the specified outputstream.

Bitmap copy(Bitmap.Config config, boolean isMutable)

Tries to make a new bitmap based on the dimensions of this bitmap, setting the new bitmap's config to the one specified, and then copying this bitmap's pixels into the new bitmap.

void copyPixelsFromBuffer(Buffer src)

Copy the pixels from the buffer, beginning at the current position, overwriting the bitmap's pixels.

void copyPixelsToBuffer(Buffer dst)

Copy the bitmap's pixels into the specified buffer (allocated by the caller).

static Bitmap createBitmap(Bitmap source, int x, int y, int width, int height)

Returns an immutable bitmap from the specified subset of the source bitmap.

static Bitmap createBitmap(int[] colors, int width, int height, Bitmap.Config config)

Returns a immutable bitmap with the specified width and height, with each pixel value set to the corresponding value in the colors array.

static Bitmap createBitmap(Bitmap source, int x, int y, int width, int height, Matrix m, boolean filter)

Returns an immutable bitmap from subset of the source bitmap, transformed by the optional matrix.

static Bitmap createBitmap(Bitmap src)

Returns an immutable bitmap from the source bitmap.

static Bitmap createBitmap(DisplayMetrics display, int[] colors, int offset, int stride, int width, int height, Bitmap.Config config)

Returns a immutable bitmap with the specified width and height, with each pixel value set to the corresponding value in the colors array.

static Bitmap createBitmap(DisplayMetrics display, int[] colors, int width, int height, Bitmap.Config config)

Returns a immutable bitmap with the specified width and height, with each pixel value set to the corresponding value in the colors array.

static Bitmap createBitmap(DisplayMetrics display, int width, int height, Bitmap.Config config)

Returns a mutable bitmap with the specified width and height.

static Bitmap createBitmap(int[] colors, int offset, int stride, int width, int height, Bitmap.Config config)

Returns a immutable bitmap with the specified width and height, with each pixel value set to the corresponding value in the colors array.

static Bitmap createBitmap(int width, int height, Bitmap.Config config)

Returns a mutable bitmap with the specified width and height.

static Bitmap createScaledBitmap(Bitmap src, int dstWidth, int dstHeight, boolean filter)

Creates a new bitmap, scaled from an existing bitmap, when possible.

int describeContents()

No special parcel contents.

void eraseColor(int c)

Fills the bitmap's pixels with the specified Color.

Bitmap extractAlpha()

Returns a new bitmap that captures the alpha values of the original.

Bitmap extractAlpha(Paint paint, int[] offsetXY)

Returns a new bitmap that captures the alpha values of the original.

final int getAllocationByteCount()

Returns the size of the allocated memory used to store this bitmap's pixels.

final int getByteCount()

Returns the minimum number of bytes that can be used to store this bitmap's pixels.

final Bitmap.Config getConfig()

If the bitmap's internal config is in one of the public formats, return that config, otherwise return null.

int getDensity()

Returns the density for this bitmap.

int getGenerationId()

Returns the generation ID of this bitmap.

final int getHeight()

Returns the bitmap's height

byte[] getNinePatchChunk()

Returns an optional array of private data, used by the UI system for some bitmaps.

int getPixel(int x, int y)

Returns the Color at the specified location.

void getPixels(int[] pixels, int offset, int stride, int x, int y, int width, int height)

Returns in pixels[] a copy of the data in the bitmap.

final int getRowBytes()

Return the number of bytes between rows in the bitmap's pixels.

int getScaledHeight(int targetDensity)

Convenience method that returns the height of this bitmap divided by the density scale factor.

int getScaledHeight(Canvas canvas)

Convenience for calling getScaledHeight(int) with the target density of the given Canvas.

int getScaledHeight(DisplayMetrics metrics)

Convenience for calling getScaledHeight(int) with the target density of the given DisplayMetrics.

int getScaledWidth(int targetDensity)

Convenience method that returns the width of this bitmap divided by the density scale factor.

int getScaledWidth(DisplayMetrics metrics)

Convenience for calling getScaledWidth(int) with the target density of the given DisplayMetrics.

int getScaledWidth(Canvas canvas)

Convenience for calling getScaledWidth(int) with the target density of the given Canvas.

final int getWidth()

Returns the bitmap's width

final boolean hasAlpha()

Returns true if the bitmap's config supports per-pixel alpha, and if the pixels may contain non-opaque alpha values.

final boolean hasMipMap()

Indicates whether the renderer responsible for drawing this bitmap should attempt to use mipmaps when this bitmap is drawn scaled down.

final boolean isMutable()

Returns true if the bitmap is marked as mutable (i.e. can be drawn into)

final boolean isPremultiplied()

Indicates whether pixels stored in this bitmaps are stored pre-multiplied.

final boolean isRecycled()

Returns true if this bitmap has been recycled.

void prepareToDraw()

Rebuilds any caches associated with the bitmap that are used for drawing it.

void reconfigure(int width, int height, Bitmap.Config config)

Modifies the bitmap to have a specified width, height, and Bitmap.Config, without affecting the underlying allocation backing the bitmap.

void recycle()

Free the native object associated with this bitmap, and clear the reference to the pixel data.

boolean sameAs(Bitmap other)

Given another bitmap, return true if it has the same dimensions, config, and pixel data as this bitmap.

void setConfig(Bitmap.Config config)

Convenience method for calling reconfigure(int, int, Config) with the current height and width.

void setDensity(int density)

Specifies the density for this bitmap.

void setHasAlpha(boolean hasAlpha)

Tell the bitmap if all of the pixels are known to be opaque (false) or if some of the pixels may contain non-opaque alpha values (true).

final void setHasMipMap(boolean hasMipMap)

Set a hint for the renderer responsible for drawing this bitmap indicating that it should attempt to use mipmaps when this bitmap is drawn scaled down.

void setHeight(int height)

Convenience method for calling reconfigure(int, int, Config) with the current width and config.

void setPixel(int x, int y, int color)

Write the specified Color into the bitmap (assuming it is mutable) at the x,y coordinate.

void setPixels(int[] pixels, int offset, int stride, int x, int y, int width, int height)

Replace pixels in the bitmap with the colors in the array.

final void setPremultiplied(boolean premultiplied)

Sets whether the bitmap should treat its data as pre-multiplied.

void setWidth(int width)

Convenience method for calling reconfigure(int, int, Config) with the current height and config.

void writeToParcel(Parcel p, int flags)

Write the bitmap and its pixels to the parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

DENSITY_NONE

Added in API level 4
int DENSITY_NONE

Indicates that the bitmap was created for an unknown pixel density.

See also:

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 1
Creator<Bitmap> CREATOR

Public methods

compress

Added in API level 1
boolean compress (Bitmap.CompressFormat format, 
                int quality, 
                OutputStream stream)

Write a compressed version of the bitmap to the specified outputstream. If this returns true, the bitmap can be reconstructed by passing a corresponding inputstream to BitmapFactory.decodeStream(). Note: not all Formats support all bitmap configs directly, so it is possible that the returned bitmap from BitmapFactory could be in a different bitdepth, and/or may have lost per-pixel alpha (e.g. JPEG only supports opaque pixels).

Parameters
format Bitmap.CompressFormat: The format of the compressed image
quality int: Hint to the compressor, 0-100. 0 meaning compress for small size, 100 meaning compress for max quality. Some formats, like PNG which is lossless, will ignore the quality setting
stream OutputStream: The outputstream to write the compressed data.
Returns
boolean true if successfully compressed to the specified stream.

copy

Added in API level 1
Bitmap copy (Bitmap.Config config, 
                boolean isMutable)

Tries to make a new bitmap based on the dimensions of this bitmap, setting the new bitmap's config to the one specified, and then copying this bitmap's pixels into the new bitmap. If the conversion is not supported, or the allocator fails, then this returns NULL. The returned bitmap initially has the same density as the original.

Parameters
config Bitmap.Config: The desired config for the resulting bitmap
isMutable boolean: True if the resulting bitmap should be mutable (i.e. its pixels can be modified)
Returns
Bitmap the new bitmap, or null if the copy could not be made.

copyPixelsFromBuffer

Added in API level 3
void copyPixelsFromBuffer (Buffer src)

Copy the pixels from the buffer, beginning at the current position, overwriting the bitmap's pixels. The data in the buffer is not changed in any way (unlike setPixels(), which converts from unpremultipled 32bit to whatever the bitmap's native format is.

After this method returns, the current position of the buffer is updated: the position is incremented by the number of elements read from the buffer. If you need to read the bitmap from the buffer again you must first rewind the buffer.

Parameters
src Buffer

copyPixelsToBuffer

Added in API level 1
void copyPixelsToBuffer (Buffer dst)

Copy the bitmap's pixels into the specified buffer (allocated by the caller). An exception is thrown if the buffer is not large enough to hold all of the pixels (taking into account the number of bytes per pixel) or if the Buffer subclass is not one of the support types (ByteBuffer, ShortBuffer, IntBuffer).

The content of the bitmap is copied into the buffer as-is. This means that if this bitmap stores its pixels pre-multiplied (see isPremultiplied(), the values in the buffer will also be pre-multiplied.

After this method returns, the current position of the buffer is updated: the position is incremented by the number of elements written in the buffer.

Parameters
dst Buffer

createBitmap

Added in API level 1
Bitmap createBitmap (Bitmap source, 
                int x, 
                int y, 
                int width, 
                int height)

Returns an immutable bitmap from the specified subset of the source bitmap. The new bitmap may be the same object as source, or a copy may have been made. It is initialized with the same density as the original bitmap.

Parameters
source Bitmap: The bitmap we are subsetting
x int: The x coordinate of the first pixel in source
y int: The y coordinate of the first pixel in source
width int: The number of pixels in each row
height int: The number of rows
Returns
Bitmap A copy of a subset of the source bitmap or the source bitmap itself.
Throws
IllegalArgumentException if the x, y, width, height values are outside of the dimensions of the source bitmap, or width is <= 0, or height is <= 0

createBitmap

Added in API level 1
Bitmap createBitmap (int[] colors, 
                int width, 
                int height, 
                Bitmap.Config config)

Returns a immutable bitmap with the specified width and height, with each pixel value set to the corresponding value in the colors array. Its initial density is as per getDensity().

Parameters
colors int: Array of Color used to initialize the pixels. This array must be at least as large as width * height.
width int: The width of the bitmap
height int: The height of the bitmap
config Bitmap.Config: The bitmap config to create. If the config does not support per-pixel alpha (e.g. RGB_565), then the alpha bytes in the colors[] will be ignored (assumed to be FF)
Returns
Bitmap
Throws
IllegalArgumentException if the width or height are <= 0, or if the color array's length is less than the number of pixels.

createBitmap

Added in API level 1
Bitmap createBitmap (Bitmap source, 
                int x, 
                int y, 
                int width, 
                int height, 
                Matrix m, 
                boolean filter)

Returns an immutable bitmap from subset of the source bitmap, transformed by the optional matrix. The new bitmap may be the same object as source, or a copy may have been made. It is initialized with the same density as the original bitmap. If the source bitmap is immutable and the requested subset is the same as the source bitmap itself, then the source bitmap is returned and no new bitmap is created.

Parameters
source Bitmap: The bitmap we are subsetting
x int: The x coordinate of the first pixel in source
y int: The y coordinate of the first pixel in source
width int: The number of pixels in each row
height int: The number of rows
m Matrix: Optional matrix to be applied to the pixels
filter boolean: true if the source should be filtered. Only applies if the matrix contains more than just translation.
Returns
Bitmap A bitmap that represents the specified subset of source
Throws
IllegalArgumentException if the x, y, width, height values are outside of the dimensions of the source bitmap, or width is <= 0, or height is <= 0

createBitmap

Added in API level 1
Bitmap createBitmap (Bitmap src)

Returns an immutable bitmap from the source bitmap. The new bitmap may be the same object as source, or a copy may have been made. It is initialized with the same density as the original bitmap.

Parameters
src Bitmap
Returns
Bitmap

createBitmap

Added in API level 17
Bitmap createBitmap (DisplayMetrics display, 
                int[] colors, 
                int offset, 
                int stride, 
                int width, 
                int height, 
                Bitmap.Config config)

Returns a immutable bitmap with the specified width and height, with each pixel value set to the corresponding value in the colors array. Its initial density is determined from the given DisplayMetrics.

Parameters
display DisplayMetrics: Display metrics for the display this bitmap will be drawn on.
colors int: Array of Color used to initialize the pixels.
offset int: Number of values to skip before the first color in the array of colors.
stride int: Number of colors in the array between rows (must be >= width or <= -width).
width int: The width of the bitmap
height int: The height of the bitmap
config Bitmap.Config: The bitmap config to create. If the config does not support per-pixel alpha (e.g. RGB_565), then the alpha bytes in the colors[] will be ignored (assumed to be FF)
Returns
Bitmap
Throws
IllegalArgumentException if the width or height are <= 0, or if the color array's length is less than the number of pixels.

createBitmap

Added in API level 17
Bitmap createBitmap (DisplayMetrics display, 
                int[] colors, 
                int width, 
                int height, 
                Bitmap.Config config)

Returns a immutable bitmap with the specified width and height, with each pixel value set to the corresponding value in the colors array. Its initial density is determined from the given DisplayMetrics.

Parameters
display DisplayMetrics: Display metrics for the display this bitmap will be drawn on.
colors int: Array of Color used to initialize the pixels. This array must be at least as large as width * height.
width int: The width of the bitmap
height int: The height of the bitmap
config Bitmap.Config: The bitmap config to create. If the config does not support per-pixel alpha (e.g. RGB_565), then the alpha bytes in the colors[] will be ignored (assumed to be FF)
Returns
Bitmap
Throws
IllegalArgumentException if the width or height are <= 0, or if the color array's length is less than the number of pixels.

createBitmap

Added in API level 17
Bitmap createBitmap (DisplayMetrics display, 
                int width, 
                int height, 
                Bitmap.Config config)

Returns a mutable bitmap with the specified width and height. Its initial density is determined from the given DisplayMetrics.

Parameters
display DisplayMetrics: Display metrics for the display this bitmap will be drawn on.
width int: The width of the bitmap
height int: The height of the bitmap
config Bitmap.Config: The bitmap config to create.
Returns
Bitmap
Throws
IllegalArgumentException if the width or height are <= 0

createBitmap

Added in API level 1
Bitmap createBitmap (int[] colors, 
                int offset, 
                int stride, 
                int width, 
                int height, 
                Bitmap.Config config)

Returns a immutable bitmap with the specified width and height, with each pixel value set to the corresponding value in the colors array. Its initial density is as per getDensity().

Parameters
colors int: Array of Color used to initialize the pixels.
offset int: Number of values to skip before the first color in the array of colors.
stride int: Number of colors in the array between rows (must be >= width or <= -width).
width int: The width of the bitmap
height int: The height of the bitmap
config Bitmap.Config: The bitmap config to create. If the config does not support per-pixel alpha (e.g. RGB_565), then the alpha bytes in the colors[] will be ignored (assumed to be FF)
Returns
Bitmap
Throws
IllegalArgumentException if the width or height are <= 0, or if the color array's length is less than the number of pixels.

createBitmap

Added in API level 1
Bitmap createBitmap (int width, 
                int height, 
                Bitmap.Config config)

Returns a mutable bitmap with the specified width and height. Its initial density is as per getDensity().

Parameters
width int: The width of the bitmap
height int: The height of the bitmap
config Bitmap.Config: The bitmap config to create.
Returns
Bitmap
Throws
IllegalArgumentException if the width or height are <= 0

createScaledBitmap

Added in API level 1
Bitmap createScaledBitmap (Bitmap src, 
                int dstWidth, 
                int dstHeight, 
                boolean filter)

Creates a new bitmap, scaled from an existing bitmap, when possible. If the specified width and height are the same as the current width and height of the source bitmap, the source bitmap is returned and no new bitmap is created.

Parameters
src Bitmap: The source bitmap.
dstWidth int: The new bitmap's desired width.
dstHeight int: The new bitmap's desired height.
filter boolean: true if the source should be filtered.
Returns
Bitmap The new scaled bitmap or the source bitmap if no scaling is required.
Throws
IllegalArgumentException if width is <= 0, or height is <= 0

describeContents

Added in API level 1
int describeContents ()

No special parcel contents.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

eraseColor

Added in API level 1
void eraseColor (int c)

Fills the bitmap's pixels with the specified Color.

Parameters
c int
Throws
IllegalStateException if the bitmap is not mutable.

extractAlpha

Added in API level 1
Bitmap extractAlpha ()

Returns a new bitmap that captures the alpha values of the original. This may be drawn with Canvas.drawBitmap(), where the color(s) will be taken from the paint that is passed to the draw call.

Returns
Bitmap new bitmap containing the alpha channel of the original bitmap.

extractAlpha

Added in API level 1
Bitmap extractAlpha (Paint paint, 
                int[] offsetXY)

Returns a new bitmap that captures the alpha values of the original. These values may be affected by the optional Paint parameter, which can contain its own alpha, and may also contain a MaskFilter which could change the actual dimensions of the resulting bitmap (e.g. a blur maskfilter might enlarge the resulting bitmap). If offsetXY is not null, it returns the amount to offset the returned bitmap so that it will logically align with the original. For example, if the paint contains a blur of radius 2, then offsetXY[] would contains -2, -2, so that drawing the alpha bitmap offset by (-2, -2) and then drawing the original would result in the blur visually aligning with the original.

The initial density of the returned bitmap is the same as the original's.

Parameters
paint Paint: Optional paint used to modify the alpha values in the resulting bitmap. Pass null for default behavior.
offsetXY int: Optional array that returns the X (index 0) and Y (index 1) offset needed to position the returned bitmap so that it visually lines up with the original.
Returns
Bitmap new bitmap containing the (optionally modified by paint) alpha channel of the original bitmap. This may be drawn with Canvas.drawBitmap(), where the color(s) will be taken from the paint that is passed to the draw call.

getAllocationByteCount

Added in API level 19
int getAllocationByteCount ()

Returns the size of the allocated memory used to store this bitmap's pixels.

This can be larger than the result of getByteCount() if a bitmap is reused to decode other bitmaps of smaller size, or by manual reconfiguration. See reconfigure(int, int, Config), setWidth(int), setHeight(int), setConfig(Bitmap.Config), and BitmapFactory.Options.inBitmap. If a bitmap is not modified in this way, this value will be the same as that returned by getByteCount().

This value will not change over the lifetime of a Bitmap.

Returns
int

See also:

getByteCount

Added in API level 12
int getByteCount ()

Returns the minimum number of bytes that can be used to store this bitmap's pixels.

As of KITKAT, the result of this method can no longer be used to determine memory usage of a bitmap. See getAllocationByteCount().

Returns
int

getConfig

Added in API level 1
Bitmap.Config getConfig ()

If the bitmap's internal config is in one of the public formats, return that config, otherwise return null.

Returns
Bitmap.Config

getDensity

Added in API level 4
int getDensity ()

Returns the density for this bitmap.

The default density is the same density as the current display, unless the current application does not support different screen densities in which case it is DENSITY_DEFAULT. Note that compatibility mode is determined by the application that was initially loaded into a process -- applications that share the same process should all have the same compatibility, or ensure they explicitly set the density of their bitmaps appropriately.

Returns
int A scaling factor of the default density or DENSITY_NONE if the scaling factor is unknown.

See also:

getGenerationId

Added in API level 12
int getGenerationId ()

Returns the generation ID of this bitmap. The generation ID changes whenever the bitmap is modified. This can be used as an efficient way to check if a bitmap has changed.

Returns
int The current generation ID for this bitmap.

getHeight

Added in API level 1
int getHeight ()

Returns the bitmap's height

Returns
int

getNinePatchChunk

Added in API level 1
byte[] getNinePatchChunk ()

Returns an optional array of private data, used by the UI system for some bitmaps. Not intended to be called by applications.

Returns
byte[]

getPixel

Added in API level 1
int getPixel (int x, 
                int y)

Returns the Color at the specified location. Throws an exception if x or y are out of bounds (negative or >= to the width or height respectively). The returned color is a non-premultiplied ARGB value.

Parameters
x int: The x coordinate (0...width-1) of the pixel to return
y int: The y coordinate (0...height-1) of the pixel to return
Returns
int The argb Color at the specified coordinate
Throws
IllegalArgumentException if x, y exceed the bitmap's bounds

getPixels

Added in API level 1
void getPixels (int[] pixels, 
                int offset, 
                int stride, 
                int x, 
                int y, 
                int width, 
                int height)

Returns in pixels[] a copy of the data in the bitmap. Each value is a packed int representing a Color. The stride parameter allows the caller to allow for gaps in the returned pixels array between rows. For normal packed results, just pass width for the stride value. The returned colors are non-premultiplied ARGB values.

Parameters
pixels int: The array to receive the bitmap's colors
offset int: The first index to write into pixels[]
stride int: The number of entries in pixels[] to skip between rows (must be >= bitmap's width). Can be negative.
x int: The x coordinate of the first pixel to read from the bitmap
y int: The y coordinate of the first pixel to read from the bitmap
width int: The number of pixels to read from each row
height int: The number of rows to read
Throws
IllegalArgumentException if x, y, width, height exceed the bounds of the bitmap, or if abs(stride) < width.
ArrayIndexOutOfBoundsException if the pixels array is too small to receive the specified number of pixels.

getRowBytes

Added in API level 1
int getRowBytes ()

Return the number of bytes between rows in the bitmap's pixels. Note that this refers to the pixels as stored natively by the bitmap. If you call getPixels() or setPixels(), then the pixels are uniformly treated as 32bit values, packed according to the Color class.

As of KITKAT, this method should not be used to calculate the memory usage of the bitmap. Instead, see getAllocationByteCount().

Returns
int number of bytes between rows of the native bitmap pixels.

getScaledHeight

Added in API level 4
int getScaledHeight (int targetDensity)

Convenience method that returns the height of this bitmap divided by the density scale factor.

Parameters
targetDensity int: The density of the target canvas of the bitmap.
Returns
int The scaled height of this bitmap, according to the density scale factor.

getScaledHeight

Added in API level 4
int getScaledHeight (Canvas canvas)

Convenience for calling getScaledHeight(int) with the target density of the given Canvas.

Parameters
canvas Canvas
Returns
int

getScaledHeight

Added in API level 4
int getScaledHeight (DisplayMetrics metrics)

Convenience for calling getScaledHeight(int) with the target density of the given DisplayMetrics.

Parameters
metrics DisplayMetrics
Returns
int

getScaledWidth

Added in API level 4
int getScaledWidth (int targetDensity)

Convenience method that returns the width of this bitmap divided by the density scale factor.

Parameters
targetDensity int: The density of the target canvas of the bitmap.
Returns
int The scaled width of this bitmap, according to the density scale factor.

getScaledWidth

Added in API level 4
int getScaledWidth (DisplayMetrics metrics)

Convenience for calling getScaledWidth(int) with the target density of the given DisplayMetrics.

Parameters
metrics DisplayMetrics
Returns
int

getScaledWidth

Added in API level 4
int getScaledWidth (Canvas canvas)

Convenience for calling getScaledWidth(int) with the target density of the given Canvas.

Parameters
canvas Canvas
Returns
int

getWidth

Added in API level 1
int getWidth ()

Returns the bitmap's width

Returns
int

hasAlpha

Added in API level 1
boolean hasAlpha ()

Returns true if the bitmap's config supports per-pixel alpha, and if the pixels may contain non-opaque alpha values. For some configs, this is always false (e.g. RGB_565), since they do not support per-pixel alpha. However, for configs that do, the bitmap may be flagged to be known that all of its pixels are opaque. In this case hasAlpha() will also return false. If a config such as ARGB_8888 is not so flagged, it will return true by default.

Returns
boolean

hasMipMap

Added in API level 17
boolean hasMipMap ()

Indicates whether the renderer responsible for drawing this bitmap should attempt to use mipmaps when this bitmap is drawn scaled down. If you know that you are going to draw this bitmap at less than 50% of its original size, you may be able to obtain a higher quality This property is only a suggestion that can be ignored by the renderer. It is not guaranteed to have any effect.

Returns
boolean true if the renderer should attempt to use mipmaps, false otherwise

See also:

isMutable

Added in API level 1
boolean isMutable ()

Returns true if the bitmap is marked as mutable (i.e. can be drawn into)

Returns
boolean

isPremultiplied

Added in API level 17
boolean isPremultiplied ()

Indicates whether pixels stored in this bitmaps are stored pre-multiplied. When a pixel is pre-multiplied, the RGB components have been multiplied by the alpha component. For instance, if the original color is a 50% translucent red (128, 255, 0, 0), the pre-multiplied form is (128, 128, 0, 0).

This method always returns false if getConfig() is RGB_565.

The return value is undefined if getConfig() is ALPHA_8.

This method only returns true if hasAlpha() returns true. A bitmap with no alpha channel can be used both as a pre-multiplied and as a non pre-multiplied bitmap.

Only pre-multiplied bitmaps may be drawn by the view system or Canvas. If a non-pre-multiplied bitmap with an alpha channel is drawn to a Canvas, a RuntimeException will be thrown.

Returns
boolean true if the underlying pixels have been pre-multiplied, false otherwise

See also:

isRecycled

Added in API level 1
boolean isRecycled ()

Returns true if this bitmap has been recycled. If so, then it is an error to try to access its pixels, and the bitmap will not draw.

Returns
boolean true if the bitmap has been recycled

prepareToDraw

Added in API level 4
void prepareToDraw ()

Rebuilds any caches associated with the bitmap that are used for drawing it. In the case of purgeable bitmaps, this call will attempt to ensure that the pixels have been decoded. If this is called on more than one bitmap in sequence, the priority is given in LRU order (i.e. the last bitmap called will be given highest priority). For bitmaps with no associated caches, this call is effectively a no-op, and therefore is harmless.

reconfigure

Added in API level 19
void reconfigure (int width, 
                int height, 
                Bitmap.Config config)

Modifies the bitmap to have a specified width, height, and Bitmap.Config, without affecting the underlying allocation backing the bitmap. Bitmap pixel data is not re-initialized for the new configuration.

This method can be used to avoid allocating a new bitmap, instead reusing an existing bitmap's allocation for a new configuration of equal or lesser size. If the Bitmap's allocation isn't large enough to support the new configuration, an IllegalArgumentException will be thrown and the bitmap will not be modified.

The result of getByteCount() will reflect the new configuration, while getAllocationByteCount() will reflect that of the initial configuration.

Note: This may change this result of hasAlpha(). When converting to 565, the new bitmap will always be considered opaque. When converting from 565, the new bitmap will be considered non-opaque, and will respect the value set by setPremultiplied().

WARNING: This method should NOT be called on a bitmap currently in use by the view system, Canvas, or the AndroidBitmap NDK API. It does not make guarantees about how the underlying pixel buffer is remapped to the new config, just that the allocation is reused. Additionally, the view system does not account for bitmap properties being modifying during use, e.g. while attached to drawables.

In order to safely ensure that a Bitmap is no longer in use by the View system it is necessary to wait for a draw pass to occur after invalidate()'ing any view that had previously drawn the Bitmap in the last draw pass due to hardware acceleration's caching of draw commands. As an example, here is how this can be done for an ImageView:

      ImageView myImageView = ...;
      final Bitmap myBitmap = ...;
      myImageView.setImageDrawable(null);
      myImageView.post(new Runnable() {
          public void run() {
              // myBitmap is now no longer in use by the ImageView
              // and can be safely reconfigured.
              myBitmap.reconfigure(...);
          }
      });
 

Parameters
width int
height int
config Bitmap.Config

See also:

recycle

Added in API level 1
void recycle ()

Free the native object associated with this bitmap, and clear the reference to the pixel data. This will not free the pixel data synchronously; it simply allows it to be garbage collected if there are no other references. The bitmap is marked as "dead", meaning it will throw an exception if getPixels() or setPixels() is called, and will draw nothing. This operation cannot be reversed, so it should only be called if you are sure there are no further uses for the bitmap. This is an advanced call, and normally need not be called, since the normal GC process will free up this memory when there are no more references to this bitmap.

sameAs

Added in API level 12
boolean sameAs (Bitmap other)

Given another bitmap, return true if it has the same dimensions, config, and pixel data as this bitmap. If any of those differ, return false. If other is null, return false.

Parameters
other Bitmap
Returns
boolean

setConfig

Added in API level 19
void setConfig (Bitmap.Config config)

Convenience method for calling reconfigure(int, int, Config) with the current height and width.

WARNING: this method should not be used on bitmaps currently used by the view system, see reconfigure(int, int, Config) for more details.

Parameters
config Bitmap.Config

See also:

setDensity

Added in API level 4
void setDensity (int density)

Specifies the density for this bitmap. When the bitmap is drawn to a Canvas that also has a density, it will be scaled appropriately.

Parameters
density int: The density scaling factor to use with this bitmap or DENSITY_NONE if the density is unknown.

See also:

setHasAlpha

Added in API level 12
void setHasAlpha (boolean hasAlpha)

Tell the bitmap if all of the pixels are known to be opaque (false) or if some of the pixels may contain non-opaque alpha values (true). Note, for some configs (e.g. RGB_565) this call is ignored, since it does not support per-pixel alpha values. This is meant as a drawing hint, as in some cases a bitmap that is known to be opaque can take a faster drawing case than one that may have non-opaque per-pixel alpha values.

Parameters
hasAlpha boolean

setHasMipMap

Added in API level 17
void setHasMipMap (boolean hasMipMap)

Set a hint for the renderer responsible for drawing this bitmap indicating that it should attempt to use mipmaps when this bitmap is drawn scaled down. If you know that you are going to draw this bitmap at less than 50% of its original size, you may be able to obtain a higher quality by turning this property on. Note that if the renderer respects this hint it might have to allocate extra memory to hold the mipmap levels for this bitmap. This property is only a suggestion that can be ignored by the renderer. It is not guaranteed to have any effect.

Parameters
hasMipMap boolean: indicates whether the renderer should attempt to use mipmaps

See also:

setHeight

Added in API level 19
void setHeight (int height)

Convenience method for calling reconfigure(int, int, Config) with the current width and config.

WARNING: this method should not be used on bitmaps currently used by the view system, see reconfigure(int, int, Config) for more details.

Parameters
height int

See also:

setPixel

Added in API level 1
void setPixel (int x, 
                int y, 
                int color)

Write the specified Color into the bitmap (assuming it is mutable) at the x,y coordinate. The color must be a non-premultiplied ARGB value.

Parameters
x int: The x coordinate of the pixel to replace (0...width-1)
y int: The y coordinate of the pixel to replace (0...height-1)
color int: The ARGB color to write into the bitmap
Throws
IllegalStateException if the bitmap is not mutable
IllegalArgumentException if x, y are outside of the bitmap's bounds.

setPixels

Added in API level 1
void setPixels (int[] pixels, 
                int offset, 
                int stride, 
                int x, 
                int y, 
                int width, 
                int height)

Replace pixels in the bitmap with the colors in the array. Each element in the array is a packed int prepresenting a non-premultiplied ARGB Color.

Parameters
pixels int: The colors to write to the bitmap
offset int: The index of the first color to read from pixels[]
stride int: The number of colors in pixels[] to skip between rows. Normally this value will be the same as the width of the bitmap, but it can be larger (or negative).
x int: The x coordinate of the first pixel to write to in the bitmap.
y int: The y coordinate of the first pixel to write to in the bitmap.
width int: The number of colors to copy from pixels[] per row
height int: The number of rows to write to the bitmap
Throws
IllegalStateException if the bitmap is not mutable
IllegalArgumentException if x, y, width, height are outside of the bitmap's bounds.
ArrayIndexOutOfBoundsException if the pixels array is too small to receive the specified number of pixels.

setPremultiplied

Added in API level 19
void setPremultiplied (boolean premultiplied)

Sets whether the bitmap should treat its data as pre-multiplied.

Bitmaps are always treated as pre-multiplied by the view system and Canvas for performance reasons. Storing un-pre-multiplied data in a Bitmap (through setPixel(int, int, int), setPixels(int[], int, int, int, int, int, int), or BitmapFactory.Options.inPremultiplied) can lead to incorrect blending if drawn by the framework.

This method will not affect the behavior of a bitmap without an alpha channel, or if hasAlpha() returns false.

Calling createBitmap(Bitmap) or createScaledBitmap(Bitmap, int, int, boolean) with a source Bitmap whose colors are not pre-multiplied may result in a RuntimeException, since those functions require drawing the source, which is not supported for un-pre-multiplied Bitmaps.

Parameters
premultiplied boolean

See also:

setWidth

Added in API level 19
void setWidth (int width)

Convenience method for calling reconfigure(int, int, Config) with the current height and config.

WARNING: this method should not be used on bitmaps currently used by the view system, see reconfigure(int, int, Config) for more details.

Parameters
width int

See also:

writeToParcel

Added in API level 1
void writeToParcel (Parcel p, 
                int flags)

Write the bitmap and its pixels to the parcel. The bitmap can be rebuilt from the parcel by calling CREATOR.createFromParcel().

Parameters
p Parcel: Parcel object to write the bitmap data into
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.