Android APIs
public class

BitmapDrawable

extends Drawable
java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.BitmapDrawable

Class Overview

A Drawable that wraps a bitmap and can be tiled, stretched, or aligned. You can create a BitmapDrawable from a file path, an input stream, through XML inflation, or from a Bitmap object.

It can be defined in an XML file with the <bitmap> element. For more information, see the guide to Drawable Resources.

Also see the Bitmap class, which handles the management and transformation of raw bitmap graphics, and should be used when drawing to a Canvas.

Summary

XML Attributes
Attribute Name Related Method Description
android:antialias Enables or disables antialiasing. 
android:dither Enables or disables dithering of the bitmap if the bitmap does not have the same pixel configuration as the screen (for instance: a ARGB 8888 bitmap with an RGB 565 screen). 
android:filter Enables or disables bitmap filtering. 
android:gravity Defines the gravity for the bitmap. 
android:mipMap hasMipMap() Enables or disables the mipmap hint. 
android:src Identifier of the bitmap file. 
android:tileMode Defines the tile mode. 
android:tileModeX setTileModeX(Shader.TileMode) Defines the horizontal tile mode. 
android:tileModeY setTileModeY(Shader.TileMode) Defines the vertical tile mode. 
Public Constructors
BitmapDrawable()
This constructor was deprecated in API level 4. Use BitmapDrawable(android.content.res.Resources, android.graphics.Bitmap) instead to specify a bitmap to draw with and ensure the correct density is set.
BitmapDrawable(Resources res)
This constructor was deprecated in API level 18. Use BitmapDrawable(android.content.res.Resources, android.graphics.Bitmap) instead to specify a bitmap to draw with.
BitmapDrawable(Bitmap bitmap)
This constructor was deprecated in API level 4. Use BitmapDrawable(Resources, Bitmap) to ensure that the drawable has correctly set its target density.
BitmapDrawable(Resources res, Bitmap bitmap)
Create drawable from a bitmap, setting initial target density based on the display metrics of the resources.
BitmapDrawable(String filepath)
This constructor was deprecated in API level 5. Use BitmapDrawable(Resources, String) to ensure that the drawable has correctly set its target density.
BitmapDrawable(Resources res, String filepath)
Create a drawable by opening a given file path and decoding the bitmap.
BitmapDrawable(InputStream is)
This constructor was deprecated in API level 5. Use BitmapDrawable(Resources, java.io.InputStream) to ensure that the drawable has correctly set its target density.
BitmapDrawable(Resources res, InputStream is)
Create a drawable by decoding a bitmap from the given input stream.
Public Methods
void applyTheme(Resources.Theme t)
Applies the specified theme to this Drawable and its children.
boolean canApplyTheme()
void draw(Canvas canvas)
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
int getAlpha()
Gets the current alpha value for the drawable.
final Bitmap getBitmap()
Returns the bitmap used by this drawable to render.
int getChangingConfigurations()
Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
ColorFilter getColorFilter()
Returns the current color filter, or null if none set.
final Drawable.ConstantState getConstantState()
Return a Drawable.ConstantState instance that holds the shared state of this Drawable.
int getGravity()
Get the gravity used to position/stretch the bitmap within its bounds.
int getIntrinsicHeight()
Return the intrinsic height of the underlying drawable object.
int getIntrinsicWidth()
Return the intrinsic width of the underlying drawable object.
int getOpacity()
Return the opacity/transparency of this Drawable.
void getOutline(Outline outline)
Called to get the drawable to populate the Outline that defines its drawing area.
final Paint getPaint()
Returns the paint used to render this drawable.
Shader.TileMode getTileModeX()
Indicates the repeat behavior of this drawable on the X axis.
Shader.TileMode getTileModeY()
Indicates the repeat behavior of this drawable on the Y axis.
boolean hasAntiAlias()
Indicates whether anti-aliasing is enabled for this drawable.
boolean hasMipMap()
Indicates whether the mipmap hint is enabled on this drawable's bitmap.
void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme.
final boolean isAutoMirrored()
Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean isFilterBitmap()
boolean isStateful()
Indicates whether this drawable will change its appearance based on state.
Drawable mutate()
A mutable BitmapDrawable still shares its Bitmap with any other Drawable that comes from the same resource.
void setAlpha(int alpha)
Specify an alpha value for the drawable.
void setAntiAlias(boolean aa)
Enables or disables anti-aliasing for this drawable.
void setAutoMirrored(boolean mirrored)
Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void setColorFilter(ColorFilter colorFilter)
Specify an optional color filter for the drawable.
void setDither(boolean dither)
This method is deprecated. This property is ignored.
void setFilterBitmap(boolean filter)
Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.
void setGravity(int gravity)
Set the gravity used to position/stretch the bitmap within its bounds.
void setMipMap(boolean mipMap)
Enables or disables the mipmap hint for this drawable's bitmap.
void setTargetDensity(int density)
Set the density at which this drawable will be rendered.
void setTargetDensity(DisplayMetrics metrics)
Set the density scale at which this drawable will be rendered.
void setTargetDensity(Canvas canvas)
Set the density scale at which this drawable will be rendered.
void setTileModeX(Shader.TileMode mode)
Sets the repeat behavior of this drawable on the X axis.
void setTileModeXY(Shader.TileMode xmode, Shader.TileMode ymode)
Sets the repeat behavior of this drawable on both axis.
final void setTileModeY(Shader.TileMode mode)
Sets the repeat behavior of this drawable on the Y axis.
void setTintList(ColorStateList tint)
Specifies tint color for this drawable as a color state list.
void setTintMode(PorterDuff.Mode tintMode)
Specifies a tint blending mode for this drawable.
Protected Methods
void onBoundsChange(Rect bounds)
Override this in your subclass to change appearance if you vary based on the bounds.
boolean onStateChange(int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
[Expand]
Inherited Methods
From class android.graphics.drawable.Drawable
From class java.lang.Object

XML Attributes

android:antialias

Enables or disables antialiasing. Antialiasing can be used to smooth the edges of a bitmap when rotated. Default value is false.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol antialias.

Related Methods

android:dither

Enables or disables dithering of the bitmap if the bitmap does not have the same pixel configuration as the screen (for instance: a ARGB 8888 bitmap with an RGB 565 screen). Default value is true.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol dither.

Related Methods

android:filter

Enables or disables bitmap filtering. Filtering is used when the bitmap is shrunk or stretched to smooth its apperance. Default value is true.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol filter.

Related Methods

android:gravity

Defines the gravity for the bitmap. The gravity indicates where to position the drawable in its container if the bitmap is smaller than the container.

Must be one or more (separated by '|') of the following constant values.

ConstantValueDescription
top0x30 Push object to the top of its container, not changing its size.
bottom0x50 Push object to the bottom of its container, not changing its size.
left0x03 Push object to the left of its container, not changing its size.
right0x05 Push object to the right of its container, not changing its size.
center_vertical0x10 Place object in the vertical center of its container, not changing its size.
fill_vertical0x70 Grow the vertical size of the object if needed so it completely fills its container.
center_horizontal0x01 Place object in the horizontal center of its container, not changing its size.
fill_horizontal0x07 Grow the horizontal size of the object if needed so it completely fills its container.
center0x11 Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
fill0x77 Grow the horizontal and vertical size of the object if needed so it completely fills its container.
clip_vertical0x80 Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges.
clip_horizontal0x08 Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges.
start0x00800003 Push object to the beginning of its container, not changing its size.
end0x00800005 Push object to the end of its container, not changing its size.

This corresponds to the global attribute resource symbol gravity.

Related Methods

android:mipMap

Enables or disables the mipmap hint. See setHasMipMap(boolean) for more information. Default value is false.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol mipMap.

Related Methods

android:src

Identifier of the bitmap file. This attribute is mandatory.

May be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

May be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This corresponds to the global attribute resource symbol src.

Related Methods

android:tileMode

Defines the tile mode. When the tile mode is enabled, the bitmap is repeated. Gravity is ignored when the tile mode is enabled. Default value is "disabled".

Must be one of the following constant values.

ConstantValueDescription
disabled-1 Do not tile the bitmap. This is the default value.
clamp0 Replicates the edge color.
repeat1 Repeats the bitmap in both direction.
mirror2 Repeats the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam.

This corresponds to the global attribute resource symbol tileMode.

Related Methods

android:tileModeX

Defines the horizontal tile mode. When the tile mode is enabled, the bitmap is repeated. Gravity is ignored when the tile mode is enabled. Default value is "disabled".

Must be one of the following constant values.

ConstantValueDescription
disabled-1 Do not tile the bitmap. This is the default value.
clamp0 Replicates the edge color.
repeat1 Repeats the bitmap horizontally.
mirror2 Repeats the shader's image horizontally, alternating mirror images so that adjacent images always seam.

This corresponds to the global attribute resource symbol tileModeX.

android:tileModeY

Defines the vertical tile mode. When the tile mode is enabled, the bitmap is repeated. Gravity is ignored when the tile mode is enabled. Default value is "disabled".

Must be one of the following constant values.

ConstantValueDescription
disabled-1 Do not tile the bitmap. This is the default value.
clamp0 Replicates the edge color.
repeat1 Repeats the bitmap vertically.
mirror2 Repeats the shader's image vertically, alternating mirror images so that adjacent images always seam.

This corresponds to the global attribute resource symbol tileModeY.

Public Constructors

public BitmapDrawable ()

Added in API level 1

This constructor was deprecated in API level 4.
Use BitmapDrawable(android.content.res.Resources, android.graphics.Bitmap) instead to specify a bitmap to draw with and ensure the correct density is set.

Create an empty drawable, not dealing with density.

public BitmapDrawable (Resources res)

Added in API level 4

This constructor was deprecated in API level 18.
Use BitmapDrawable(android.content.res.Resources, android.graphics.Bitmap) instead to specify a bitmap to draw with.

Create an empty drawable, setting initial target density based on the display metrics of the resources.

Parameters
res Resources

public BitmapDrawable (Bitmap bitmap)

Added in API level 1

This constructor was deprecated in API level 4.
Use BitmapDrawable(Resources, Bitmap) to ensure that the drawable has correctly set its target density.

Create drawable from a bitmap, not dealing with density.

Parameters
bitmap Bitmap

public BitmapDrawable (Resources res, Bitmap bitmap)

Added in API level 4

Create drawable from a bitmap, setting initial target density based on the display metrics of the resources.

Parameters
res Resources
bitmap Bitmap

public BitmapDrawable (String filepath)

Added in API level 1

This constructor was deprecated in API level 5.
Use BitmapDrawable(Resources, String) to ensure that the drawable has correctly set its target density.

Create a drawable by opening a given file path and decoding the bitmap.

Parameters
filepath String

public BitmapDrawable (Resources res, String filepath)

Added in API level 5

Create a drawable by opening a given file path and decoding the bitmap.

Parameters
res Resources
filepath String

public BitmapDrawable (InputStream is)

Added in API level 1

This constructor was deprecated in API level 5.
Use BitmapDrawable(Resources, java.io.InputStream) to ensure that the drawable has correctly set its target density.

Create a drawable by decoding a bitmap from the given input stream.

Parameters
is InputStream

public BitmapDrawable (Resources res, InputStream is)

Added in API level 5

Create a drawable by decoding a bitmap from the given input stream.

Parameters
res Resources
is InputStream

Public Methods

public void applyTheme (Resources.Theme t)

Added in API level 21

Applies the specified theme to this Drawable and its children.

Parameters
t Resources.Theme

public boolean canApplyTheme ()

Added in API level 21

Returns
boolean

public void draw (Canvas canvas)

Added in API level 1

Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

Parameters
canvas Canvas: The canvas to draw into

public int getAlpha ()

Added in API level 19

Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.

Returns
int

public final Bitmap getBitmap ()

Added in API level 1

Returns the bitmap used by this drawable to render. May be null.

Returns
Bitmap

public int getChangingConfigurations ()

Added in API level 1

Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. The default implementation returns whatever was provided through setChangingConfigurations(int) or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.

Returns
int Returns a mask of the changing configuration parameters, as defined by ActivityInfo.

public ColorFilter getColorFilter ()

Added in API level 21

Returns the current color filter, or null if none set.

Returns
ColorFilter the current color filter, or null if none set

public final Drawable.ConstantState getConstantState ()

Added in API level 1

Return a Drawable.ConstantState instance that holds the shared state of this Drawable.

Returns
Drawable.ConstantState The ConstantState associated to that Drawable.

public int getGravity ()

Added in API level 1

Get the gravity used to position/stretch the bitmap within its bounds. See android.view.Gravity

Returns
int the gravity applied to the bitmap

public int getIntrinsicHeight ()

Added in API level 1

Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.

Returns
int

public int getIntrinsicWidth ()

Added in API level 1

Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.

Returns
int

public int getOpacity ()

Added in API level 1

Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat: UNKNOWN, TRANSLUCENT, TRANSPARENT, or OPAQUE.

An OPAQUE drawable is one that draws all all content within its bounds, completely covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable is a drawable in any other state, where the drawable will draw some, but not all, of the content within its bounds and at least some content behind the drawable will be visible. If the visibility of the drawable's contents cannot be determined, the safest/best return value is TRANSLUCENT.

Generally a Drawable should be as conservative as possible with the value it returns. For example, if it contains multiple child drawables and only shows one of them at a time, if only one of the children is TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be returned. You can use the method resolveOpacity(int, int) to perform a standard reduction of two opacities to the appropriate single output.

Note that the returned value does not necessarily take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(ColorFilter) methods. Some subclasses, such as BitmapDrawable, ColorDrawable, and GradientDrawable, do account for the value of setAlpha(int), but the general behavior is dependent upon the implementation of the subclass.

Returns
int int The opacity class of the Drawable.

public void getOutline (Outline outline)

Added in API level 21

Called to get the drawable to populate the Outline that defines its drawing area.

This method is called by the default ViewOutlineProvider to define the outline of the View.

The default behavior defines the outline to be the bounding rectangle of 0 alpha. Subclasses that wish to convey a different shape or alpha value must override this method.

Parameters
outline Outline

public final Paint getPaint ()

Added in API level 1

Returns the paint used to render this drawable.

Returns
Paint

public Shader.TileMode getTileModeX ()

Added in API level 1

Indicates the repeat behavior of this drawable on the X axis.

Returns
Shader.TileMode CLAMP if the bitmap does not repeat, REPEAT or MIRROR otherwise.

public Shader.TileMode getTileModeY ()

Added in API level 1

Indicates the repeat behavior of this drawable on the Y axis.

Returns
Shader.TileMode CLAMP if the bitmap does not repeat, REPEAT or MIRROR otherwise.

public boolean hasAntiAlias ()

Added in API level 18

Indicates whether anti-aliasing is enabled for this drawable.

Returns
boolean True if anti-aliasing is enabled, false otherwise.

public boolean hasMipMap ()

Added in API level 18

Indicates whether the mipmap hint is enabled on this drawable's bitmap.

Related XML Attributes:

Returns
boolean True if the mipmap hint is set, false otherwise. If the bitmap is null, this method always returns false.

See also:

public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

Added in API level 21

Inflate this Drawable from an XML resource optionally styled by a theme.

Parameters
r Resources: Resources used to resolve attribute values
parser XmlPullParser: XML parser from which to inflate this Drawable
attrs AttributeSet: Base set of attribute values
theme Resources.Theme: Theme to apply, may be null
Throws
XmlPullParserException
IOException

public final boolean isAutoMirrored ()

Added in API level 19

Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See LayoutDirection.

Returns
boolean boolean Returns true if this Drawable will be automatically mirrored.

public boolean isFilterBitmap ()

Added in API level 23

Returns
boolean whether this drawable filters its bitmaps

public boolean isStateful ()

Added in API level 1

Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.

Returns
boolean True if this drawable changes its appearance based on state, false otherwise.

public Drawable mutate ()

Added in API level 3

A mutable BitmapDrawable still shares its Bitmap with any other Drawable that comes from the same resource.

Returns
Drawable This drawable.

public void setAlpha (int alpha)

Added in API level 1

Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.

Parameters
alpha int

public void setAntiAlias (boolean aa)

Added in API level 1

Enables or disables anti-aliasing for this drawable. Anti-aliasing affects the edges of the bitmap only so it applies only when the drawable is rotated.

Parameters
aa boolean: True if the bitmap should be anti-aliased, false otherwise.

See also:

public void setAutoMirrored (boolean mirrored)

Added in API level 19

Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See LayoutDirection.

Parameters
mirrored boolean: Set to true if the Drawable should be mirrored, false if not.

public void setColorFilter (ColorFilter colorFilter)

Added in API level 1

Specify an optional color filter for the drawable.

If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas.

Pass null to remove any existing color filter.

Note: Setting a non-null color filter disables tint.

Parameters
colorFilter ColorFilter: The color filter to apply, or null to remove the existing color filter

public void setDither (boolean dither)

Added in API level 1

This method is deprecated.
This property is ignored.

Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.

Parameters
dither boolean

public void setFilterBitmap (boolean filter)

Added in API level 1

Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.

This can improve appearance when bitmaps are rotated. If the drawable does not use bitmaps, this call is ignored.

Parameters
filter boolean

public void setGravity (int gravity)

Added in API level 1

Set the gravity used to position/stretch the bitmap within its bounds. See android.view.Gravity

Parameters
gravity int: the gravity

public void setMipMap (boolean mipMap)

Added in API level 18

Enables or disables the mipmap hint for this drawable's bitmap. See setHasMipMap(boolean) for more information. If the bitmap is null calling this method has no effect.

Parameters
mipMap boolean: True if the bitmap should use mipmaps, false otherwise.

See also:

public void setTargetDensity (int density)

Added in API level 4

Set the density at which this drawable will be rendered.

Parameters
density int: The density scale for this drawable.

public void setTargetDensity (DisplayMetrics metrics)

Added in API level 4

Set the density scale at which this drawable will be rendered.

Parameters
metrics DisplayMetrics: The DisplayMetrics indicating the density scale for this drawable.

public void setTargetDensity (Canvas canvas)

Added in API level 4

Set the density scale at which this drawable will be rendered. This method assumes the drawable will be rendered at the same density as the specified canvas.

Parameters
canvas Canvas: The Canvas from which the density scale must be obtained.

public void setTileModeX (Shader.TileMode mode)

Added in API level 1

Sets the repeat behavior of this drawable on the X axis. By default, the drawable does not repeat its bitmap. Using REPEAT or MIRROR the bitmap can be repeated (or tiled) if the bitmap is smaller than this drawable.

Related XML Attributes:

Parameters
mode Shader.TileMode: The repeat mode for this drawable.

public void setTileModeXY (Shader.TileMode xmode, Shader.TileMode ymode)

Added in API level 1

Sets the repeat behavior of this drawable on both axis. By default, the drawable does not repeat its bitmap. Using REPEAT or MIRROR the bitmap can be repeated (or tiled) if the bitmap is smaller than this drawable.

Parameters
xmode Shader.TileMode: The X repeat mode for this drawable.
ymode Shader.TileMode: The Y repeat mode for this drawable.

public final void setTileModeY (Shader.TileMode mode)

Added in API level 1

Sets the repeat behavior of this drawable on the Y axis. By default, the drawable does not repeat its bitmap. Using REPEAT or MIRROR the bitmap can be repeated (or tiled) if the bitmap is smaller than this drawable.

Related XML Attributes:

Parameters
mode Shader.TileMode: The repeat mode for this drawable.

public void setTintList (ColorStateList tint)

Added in API level 21

Specifies tint color for this drawable as a color state list.

A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to setColorFilter(int, PorterDuff.Mode).

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters
tint ColorStateList: Color state list to use for tinting this drawable, or null to clear the tint

public void setTintMode (PorterDuff.Mode tintMode)

Added in API level 21

Specifies a tint blending mode for this drawable.

Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is SRC_IN.

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters
tintMode PorterDuff.Mode: A Porter-Duff blending mode

Protected Methods

protected void onBoundsChange (Rect bounds)

Added in API level 1

Override this in your subclass to change appearance if you vary based on the bounds.

Parameters
bounds Rect

protected boolean onStateChange (int[] stateSet)

Added in API level 1

Override this in your subclass to change appearance if you recognize the specified state.

Parameters
stateSet int
Returns
boolean Returns true if the state change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last state.