Added in API level 1

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.

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.
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	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 cf) Specify an optional color filter for the drawable.
void	setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
void	setFilterBitmap(boolean filter) Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps).
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	setTint(ColorStateList tint, PorterDuff.Mode tintMode) Specifies a tint and 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

void	applyTheme(Resources.Theme t) Applies the specified theme to this Drawable and its children.
boolean	canApplyTheme()
void	clearColorFilter() Removes the color filter for this drawable.
final Rect	copyBounds() Return a copy of the drawable's bounds in a new Rect.
final void	copyBounds(Rect bounds) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller).
static Drawable	createFromPath(String pathName) Create a drawable from file path name.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromStream(InputStream is, String srcName) Create a drawable from an inputstream
static Drawable	createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme) Create a drawable from an XML document using an optional `Resources.Theme`.
static Drawable	createFromXml(Resources r, XmlPullParser parser) Create a drawable from an XML document.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs) Create from inside an XML document.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Create a drawable from inside an XML document using an optional `Resources.Theme`.
abstract 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 Rect	getBounds() Return the drawable's bounds Rect.
Drawable.Callback	getCallback() Return the current `Drawable.Callback` implementation attached to this Drawable.
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.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
Drawable	getCurrent()
Rect	getDirtyBounds() Return the drawable's dirty bounds Rect.
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
final int	getLevel() Retrieve the current level.
int	getMinimumHeight() Returns the minimum height suggested by this Drawable.
int	getMinimumWidth() Returns the minimum width suggested by this Drawable.
abstract int	getOpacity() Return the opacity/transparency of this Drawable.
boolean	getOutline(Outline outline) Called to get the drawable to populate the Outline.
boolean	getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
int[]	getState() Describes the current state, as a union of primitve states, such as `state_focused`, `state_selected`, etc.
Region	getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs) Inflate this Drawable from an XML resource.
void	invalidateSelf() Use the current `Drawable.Callback` implementation to have this Drawable redrawn.
boolean	isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean	isStateful() Indicates whether this drawable will change its appearance based on state.
final boolean	isVisible()
void	jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
Drawable	mutate() Make this drawable mutable.
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds.
boolean	onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level.
boolean	onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state.
static int	resolveOpacity(int op1, int op2) Return the appropriate opacity value for two source opacities.
void	scheduleSelf(Runnable what, long when) Use the current `Drawable.Callback` implementation to have this Drawable scheduled.
abstract void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void	setBounds(Rect bounds) Specify a bounding rectangle for the Drawable.
void	setBounds(int left, int top, int right, int bottom) Specify a bounding rectangle for the Drawable.
final void	setCallback(Drawable.Callback cb) Bind a `Drawable.Callback` object to this Drawable.
void	setChangingConfigurations(int configs) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
abstract void	setColorFilter(ColorFilter cf) Specify an optional color filter for the drawable.
void	setColorFilter(int color, PorterDuff.Mode mode) Specify a color and Porter-Duff mode to be the color filter for this drawable.
void	setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
void	setFilterBitmap(boolean filter) Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps).
void	setHotspot(float x, float y) Specifies the hotspot's location within the drawable.
void	setHotspotBounds(int left, int top, int right, int bottom) Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
final boolean	setLevel(int level) Specify the level for the drawable.
boolean	setState(int[] stateSet) Specify a set of states for the drawable.
void	setTint(ColorStateList tint, PorterDuff.Mode tintMode) Specifies a tint and blending mode for this drawable.
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.
void	unscheduleSelf(Runnable what) Use the current `Drawable.Callback` implementation to have this Drawable unscheduled.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

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.

Constant	Value	Description
`top`	0x30	Push object to the top of its container, not changing its size.
`bottom`	0x50	Push object to the bottom of its container, not changing its size.
`left`	0x03	Push object to the left of its container, not changing its size.
`right`	0x05	Push object to the right of its container, not changing its size.
`center_vertical`	0x10	Place object in the vertical center of its container, not changing its size.
`fill_vertical`	0x70	Grow the vertical size of the object if needed so it completely fills its container.
`center_horizontal`	0x01	Place object in the horizontal center of its container, not changing its size.
`fill_horizontal`	0x07	Grow the horizontal size of the object if needed so it completely fills its container.
`center`	0x11	Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
`fill`	0x77	Grow the horizontal and vertical size of the object if needed so it completely fills its container.
`clip_vertical`	0x80	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_horizontal`	0x08	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.
`start`	0x00800003	Push object to the beginning of its container, not changing its size.
`end`	0x00800005	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

hasMipMap()

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.

Constant	Value	Description
`disabled`	-1	Do not tile the bitmap. This is the default value.
`clamp`	0	Replicates the edge color.
`repeat`	1	Repeats the bitmap in both direction.
`mirror`	2	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

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.

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.

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.

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.

public BitmapDrawable (Resources res, String filepath)

Added in API level 5

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

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.

public BitmapDrawable (Resources res, InputStream is)

Added in API level 5

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

Public Methods

public void applyTheme (Resources.Theme t)

Applies the specified theme to this Drawable and its children.

public boolean canApplyTheme ()

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	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.

public final Bitmap getBitmap ()

Added in API level 1

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

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

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

public ColorFilter getColorFilter ()

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

Returns

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

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

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.

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.

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.

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 take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(ColorFilter) methods.

Returns

int The opacity class of the Drawable.

public final Paint getPaint ()

Added in API level 1

Returns the paint used to render this drawable.

public Shader.TileMode getTileModeX ()

Added in API level 1

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

Returns

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

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

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

android:mipMap

Returns

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

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

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

Parameters

r	Resources used to resolve attribute values
parser	XML parser from which to inflate this Drawable
attrs	Base set of attribute values
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 Returns true if this Drawable will be automatically mirrored.

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

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

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.

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	True if the bitmap should be anti-aliased, false otherwise.

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	Set to true if the Drawable should be mirrored, false if not.

public void setColorFilter (ColorFilter cf)

Added in API level 1

Specify an optional color filter for the drawable. Pass null to remove any existing color filter.

Parameters

cf	the color filter to apply, or `null` to remove the existing color filter

public void setDither (boolean dither)

Added in API level 1

Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. This can improve the look on those devices, but can also slow down the drawing a little.

public void setFilterBitmap (boolean filter)

Added in API level 1

Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps). If the drawable does not use bitmaps, this call is ignored. This can improve the look when scaled or rotated, but also slows down the drawing.

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	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	True if the bitmap should use mipmaps, false otherwise.

public void setTargetDensity (int density)

Added in API level 4

Set the density at which this drawable will be rendered.

Parameters

density	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	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	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.

Parameters

mode	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	The X repeat mode for this drawable.
ymode	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.

Parameters

mode	The repeat mode for this drawable.

public void setTint (ColorStateList tint, PorterDuff.Mode tintMode)

Specifies a tint and blending mode for this drawable.

Setting a color filter via setColorFilter(ColorFilter) overrides tint.

Parameters

tint	Color state list to use for tinting this drawable, or null to clear the tint
tintMode	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.

protected boolean onStateChange (int[] stateSet)

Added in API level 1

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

Returns

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.

Results

Interfaces

Classes

Enums

BitmapDrawable

Class Overview

Summary

XML Attributes

android:antialias

Related Methods

android:dither

Related Methods

android:filter

Related Methods

android:gravity

Related Methods

android:mipMap

Related Methods

android:src

Related Methods

android:tileMode

Related Methods

Public Constructors

public BitmapDrawable ()

public BitmapDrawable (Resources res)

public BitmapDrawable (Bitmap bitmap)

public BitmapDrawable (Resources res, Bitmap bitmap)

public BitmapDrawable (String filepath)

public BitmapDrawable (Resources res, String filepath)

public BitmapDrawable (InputStream is)

public BitmapDrawable (Resources res, InputStream is)

Public Methods

public void applyTheme (Resources.Theme t)

public boolean canApplyTheme ()

public void draw (Canvas canvas)

Parameters

public int getAlpha ()

public final Bitmap getBitmap ()

public int getChangingConfigurations ()

Returns

public ColorFilter getColorFilter ()

Returns

public final Drawable.ConstantState getConstantState ()

Returns

public int getGravity ()

Returns

public int getIntrinsicHeight ()

public int getIntrinsicWidth ()

public int getOpacity ()

Returns

public final Paint getPaint ()

public Shader.TileMode getTileModeX ()

Returns

public Shader.TileMode getTileModeY ()

Returns

public boolean hasAntiAlias ()

Returns

See Also

public boolean hasMipMap ()

Related XML Attributes

Returns

See Also

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

Parameters

Throws

public final boolean isAutoMirrored ()

Returns

public boolean isStateful ()

Returns

public Drawable mutate ()

Returns

public void setAlpha (int alpha)

public void setAntiAlias (boolean aa)

Parameters

See Also

public void setAutoMirrored (boolean mirrored)

Parameters

public void setColorFilter (ColorFilter cf)

Parameters

public void setDither (boolean dither)