Added in API level 1

Summary: XML Attrs | Ctors | Methods | Protected Methods | Inherited Methods

BitmapDrawable

Kotlin |Java

public class BitmapDrawable
extends Drawable

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

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
`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`	Enables or disables the mipmap hint.
`android:src`	Identifier of the bitmap file.
`android:tileMode`	Defines the tile mode.
`android:tileModeX`	Defines the horizontal tile mode.
`android:tileModeY`	Defines the vertical tile mode.

Public constructors
`BitmapDrawable()` This constructor is deprecated. 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 is deprecated. Use `BitmapDrawable(android.content.res.Resources, android.graphics.Bitmap)` instead to specify a bitmap to draw with.
`BitmapDrawable(Resources res, Bitmap bitmap)` Create drawable from a bitmap, setting initial target density based on the display metrics of the resources.
`BitmapDrawable(Resources res, InputStream is)` Create a drawable by decoding a bitmap from the given input stream.
`BitmapDrawable(Resources res, String filepath)` Create a drawable by opening a given file path and decoding the bitmap.
`BitmapDrawable(Bitmap bitmap)` This constructor is deprecated. Use `BitmapDrawable(android.content.res.Resources, android.graphics.Bitmap)` to ensure that the drawable has correctly set its target density.
`BitmapDrawable(InputStream is)` This constructor is deprecated. Use `BitmapDrawable(android.content.res.Resources, java.io.InputStream)` to ensure that the drawable has correctly set its target density.
`BitmapDrawable(String filepath)` This constructor is deprecated. Use `BitmapDrawable(android.content.res.Resources, java.lang.String)` to ensure that the drawable has correctly set its target density.

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 `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()` Returns the drawable's intrinsic height.
`int`	`getIntrinsicWidth()` Returns the drawable's intrinsic width.
`int`	`getOpacity()` This method is deprecated. This method is no longer used in graphics optimizations
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`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`	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `R.attr.state_focused`.
`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`	`setBitmap(Bitmap bitmap)` Switch to a new Bitmap object.
`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(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`	`setTargetDensity(int density)` Set the density 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`	`setTintBlendMode(BlendMode blendMode)` Specifies a tint blending mode for this drawable.
`void`	`setTintList(ColorStateList tint)` Specifies tint color for this drawable as a color state list.

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.

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)` This method was deprecated in API level 28. Prefer the version without an Options object.
`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)` Create a drawable from an XML document.
`static Drawable`	`createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme)` Create a drawable from an XML document using an optional `Theme`.
`static Drawable`	`createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)` Create a drawable from inside an XML document using an optional `Theme`.
`static Drawable`	`createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs)` Create from inside an XML document.
`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 `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 `ConstantState` instance that holds the shared state of this Drawable.
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()` Return the drawable's dirty bounds Rect.
`void`	`getHotspotBounds(Rect outRect)` Populates `outRect` with the hotspot bounds.
`int`	`getIntrinsicHeight()` Returns the drawable's intrinsic height.
`int`	`getIntrinsicWidth()` Returns the drawable's intrinsic width.
`int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`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()` This method was deprecated in API level 29. This method is no longer used in graphics optimizations
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`void`	`getOutline(Outline outline)` Called to get the drawable to populate the Outline that defines its drawing area.
`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 primitive states, such as `R.attr.state_focused`, `R.attr.state_selected`, etc.
`Region`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent.
`boolean`	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `R.attr.state_focused`.
`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 `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`	`isFilterBitmap()`
`boolean`	`isProjected()` Whether this drawable requests projection.
`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`	`onLayoutDirectionChanged(int layoutDirection)` Called when the drawable's resolved layout direction changes.
`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 `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(int left, int top, int right, int bottom)` Specify a bounding rectangle for the Drawable.
`void`	`setBounds(Rect bounds)` Specify a bounding rectangle for the Drawable.
`final void`	`setCallback(Drawable.Callback cb)` Bind a `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.
`void`	`setColorFilter(int color, PorterDuff.Mode mode)` This method was deprecated in API level 29. use `setColorFilter(android.graphics.ColorFilter)` with an instance of `BlendModeColorFilter`
`abstract void`	`setColorFilter(ColorFilter colorFilter)` Specify an optional color filter for the drawable.
`void`	`setDither(boolean dither)` This method was deprecated in API level 23. 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`	`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`	`setLayoutDirection(int layoutDirection)` Set the layout direction for this drawable.
`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(int tintColor)` Specifies tint color for this drawable.
`void`	`setTintBlendMode(BlendMode blendMode)` Specifies a tint blending mode for this drawable.
`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.
`boolean`	`setVisible(boolean visible, boolean restart)` Set whether this Drawable is visible.
`void`	`unscheduleSelf(Runnable what)` Use the current `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 obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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.

May be a boolean value, such as "true" or "false".

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.

May be a boolean value, such as "true" or "false".

android:filter

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

May be a boolean value, such as "true" or "false".

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
bottom	50	Push object to the bottom of its container, not changing its size.
center	11	Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
center_horizontal	1	Place object in the horizontal center of its container, not changing its size.
center_vertical	10	Place object in the vertical center of its container, not changing its size.
clip_horizontal	8	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.
clip_vertical	80	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.
end	800005	Push object to the end of its container, not changing its size.
fill	77	Grow the horizontal and vertical size of the object if needed so it completely fills its container.
fill_horizontal	7	Grow the horizontal size of the object if needed so it completely fills its container.
fill_vertical	70	Grow the vertical size of the object if needed so it completely fills its container.
left	3	Push object to the left of its container, not changing its size.
right	5	Push object to the right of its container, not changing its size.
start	800003	Push object to the beginning of its container, not changing its size.
top	30	Push object to the top of its container, not changing its size.

android:mipMap

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

May be a boolean value, such as "true" or "false".

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 a theme attribute in the form "?[package:]type/name".

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

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
clamp	0	Replicates the edge color.
disabled	ffffffff	Do not tile the bitmap. This is the default value.
mirror	2	Repeats the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam.
repeat	1	Repeats the bitmap in both direction.

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.

Constant	Value	Description
clamp	0	Replicates the edge color.
disabled	ffffffff	Do not tile the bitmap. This is the default value.
mirror	2	Repeats the shader's image horizontally, alternating mirror images so that adjacent images always seam.
repeat	1	Repeats the bitmap horizontally.

Related methods:

setTileModeX(Shader.TileMode)

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.

Constant	Value	Description
clamp	0	Replicates the edge color.
disabled	ffffffff	Do not tile the bitmap. This is the default value.
mirror	2	Repeats the shader's image vertically, alternating mirror images so that adjacent images always seam.
repeat	1	Repeats the bitmap vertically.

Related methods:

setTileModeY(Shader.TileMode)

Public constructors

BitmapDrawable

Added in API level 1

public BitmapDrawable ()

This constructor is deprecated.
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.

BitmapDrawable

Added in API level 4

public BitmapDrawable (Resources res)

This constructor is deprecated.
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`

BitmapDrawable

Added in API level 4

public BitmapDrawable (Resources res, 
                Bitmap bitmap)

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

Parameters
`res`	`Resources`
`bitmap`	`Bitmap`

BitmapDrawable

Added in API level 5

public BitmapDrawable (Resources res, 
                InputStream is)

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

Parameters
`res`	`Resources`
`is`	`InputStream`

BitmapDrawable

Added in API level 5

public BitmapDrawable (Resources res, 
                String filepath)

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

Parameters
`res`	`Resources`
`filepath`	`String`

BitmapDrawable

Added in API level 1

public BitmapDrawable (Bitmap bitmap)

This constructor is deprecated.
Use BitmapDrawable(android.content.res.Resources, android.graphics.Bitmap) to ensure that the drawable has correctly set its target density.

Create drawable from a bitmap, not dealing with density.

Parameters
`bitmap`	`Bitmap`

BitmapDrawable

Added in API level 1

public BitmapDrawable (InputStream is)

This constructor is deprecated.
Use BitmapDrawable(android.content.res.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`

BitmapDrawable

Added in API level 1

public BitmapDrawable (String filepath)

This constructor is deprecated.
Use BitmapDrawable(android.content.res.Resources, java.lang.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 methods

applyTheme

Added in API level 21

public void applyTheme (Resources.Theme t)

Applies the specified theme to this Drawable and its children.

Parameters
`t`	`Resources.Theme`: the theme to apply This value cannot be `null`.

canApplyTheme

Added in API level 21

public boolean canApplyTheme ()

Returns
`boolean`

draw

Added in API level 1

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

Parameters
`canvas`	`Canvas`: The canvas to draw into This value cannot be `null`.

getAlpha

Added in API level 19

public int getAlpha ()

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`	Value is between 0 and 255 inclusive

getBitmap

Added in API level 1

public final Bitmap getBitmap ()

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

Returns
`Bitmap`

getChangingConfigurations

Added in API level 1

public int getChangingConfigurations ()

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
`int`	Value is either `0` or a combination of `ActivityInfo.CONFIG_MCC`, `ActivityInfo.CONFIG_MNC`, `ActivityInfo.CONFIG_LOCALE`, `ActivityInfo.CONFIG_TOUCHSCREEN`, `ActivityInfo.CONFIG_KEYBOARD`, `ActivityInfo.CONFIG_KEYBOARD_HIDDEN`, `ActivityInfo.CONFIG_NAVIGATION`, `ActivityInfo.CONFIG_ORIENTATION`, `ActivityInfo.CONFIG_SCREEN_LAYOUT`, `ActivityInfo.CONFIG_UI_MODE`, `ActivityInfo.CONFIG_SCREEN_SIZE`, `ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE`, `ActivityInfo.CONFIG_DENSITY`, `ActivityInfo.CONFIG_LAYOUT_DIRECTION`, `ActivityInfo.CONFIG_COLOR_MODE`, `ActivityInfo.CONFIG_FONT_SCALE`, `ActivityInfo.CONFIG_GRAMMATICAL_GENDER`, `ActivityInfo.CONFIG_ASSETS_PATHS`, and `ActivityInfo.CONFIG_RESOURCES_UNUSED`

int

Value is either 0 or a combination of ActivityInfo.CONFIG_MCC, ActivityInfo.CONFIG_MNC, ActivityInfo.CONFIG_LOCALE, ActivityInfo.CONFIG_TOUCHSCREEN, ActivityInfo.CONFIG_KEYBOARD, ActivityInfo.CONFIG_KEYBOARD_HIDDEN, ActivityInfo.CONFIG_NAVIGATION, ActivityInfo.CONFIG_ORIENTATION, ActivityInfo.CONFIG_SCREEN_LAYOUT, ActivityInfo.CONFIG_UI_MODE, ActivityInfo.CONFIG_SCREEN_SIZE, ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE, ActivityInfo.CONFIG_DENSITY, ActivityInfo.CONFIG_LAYOUT_DIRECTION, ActivityInfo.CONFIG_COLOR_MODE, ActivityInfo.CONFIG_FONT_SCALE, ActivityInfo.CONFIG_GRAMMATICAL_GENDER, ActivityInfo.CONFIG_ASSETS_PATHS, and ActivityInfo.CONFIG_RESOURCES_UNUSED

getColorFilter

Added in API level 21

public ColorFilter getColorFilter ()

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

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

getConstantState

Added in API level 1

public final Drawable.ConstantState getConstantState ()

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

Returns
`Drawable.ConstantState`	The ConstantState associated to that Drawable. This value may be `null`.

getGravity

Added in API level 1

public int getGravity ()

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

Returns
`int`	the gravity applied to the bitmap

getIntrinsicHeight

Added in API level 1

public int getIntrinsicHeight ()

Returns the drawable's intrinsic height.

Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.

Returns
`int`	the intrinsic height, or -1 if no intrinsic height

getIntrinsicWidth

Added in API level 1

public int getIntrinsicWidth ()

Returns the drawable's intrinsic width.

Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.

Returns
`int`	the intrinsic width, or -1 if no intrinsic width

getOpacity

Added in API level 1

public int getOpacity ()

This method is deprecated.
This method is no longer used in graphics optimizations

Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat: PixelFormat.UNKNOWN, PixelFormat.TRANSLUCENT, PixelFormat.TRANSPARENT, or PixelFormat.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. Value is `PixelFormat.UNKNOWN`, `PixelFormat.TRANSLUCENT`, `PixelFormat.TRANSPARENT`, or `PixelFormat.OPAQUE`

getOpticalInsets

Added in API level 29

public Insets getOpticalInsets ()

Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.

Returns
`Insets`	This value cannot be `null`.

getOutline

Added in API level 21

public void getOutline (Outline outline)

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`: This value cannot be `null`.

getPaint

Added in API level 1

public final Paint getPaint ()

Returns the paint used to render this drawable.

Returns
`Paint`

getTileModeX

Added in API level 1

public Shader.TileMode getTileModeX ()

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

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

getTileModeY

Added in API level 1

public Shader.TileMode getTileModeY ()

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

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

hasAntiAlias

Added in API level 18

public boolean hasAntiAlias ()

Indicates whether anti-aliasing is enabled for this drawable.

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

See also:

setAntiAlias(boolean)

hasFocusStateSpecified

Added in API level 31

public boolean hasFocusStateSpecified ()

Indicates whether this drawable has at least one state spec explicitly specifying R.attr.state_focused.

Note: A View uses a Drawable instance as its background and it changes its appearance based on a state. On keyboard devices, it should specify its R.attr.state_focused to make sure the user knows which view is holding the focus.

Returns
`boolean`	`true` if `R.attr.state_focused` is specified for this drawable.

hasMipMap

Added in API level 18

public boolean hasMipMap ()

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

Related XML Attributes:

android:mipMap

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

See also:

setMipMap(boolean)

inflate

Added in API level 21

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

Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource.

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

Throws
`IOException`
`XmlPullParserException`

isAutoMirrored

Added in API level 19

public final boolean isAutoMirrored ()

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.

isFilterBitmap

Added in API level 23

public boolean isFilterBitmap ()

Returns
`boolean`	whether this drawable filters its bitmaps

isStateful

Added in API level 1

public boolean isStateful ()

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.

mutate

Added in API level 3

public Drawable mutate ()

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

Returns
`Drawable`	This drawable.

setAlpha

Added in API level 1

public void setAlpha (int alpha)

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

Parameters
`alpha`	`int`: Value is between 0 and 255 inclusive

setAntiAlias

Added in API level 1

public void setAntiAlias (boolean aa)

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:

hasAntiAlias()

setAutoMirrored

Added in API level 19

public void setAutoMirrored (boolean mirrored)

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.

setBitmap

Added in API level 31

public void setBitmap (Bitmap bitmap)

Switch to a new Bitmap object.

Parameters
`bitmap`	`Bitmap`: This value may be `null`.

setColorFilter

Added in API level 1

public void setColorFilter (ColorFilter colorFilter)

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

setDither

Added in API level 1

public void setDither (boolean dither)

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`

setFilterBitmap

Added in API level 1

public void setFilterBitmap (boolean filter)

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`

setGravity

Added in API level 1

public void setGravity (int gravity)

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

Parameters
`gravity`	`int`: the gravity

setMipMap

Added in API level 18

public void setMipMap (boolean mipMap)

Enables or disables the mipmap hint for this drawable's bitmap. See Bitmap.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:

hasMipMap()

setTargetDensity

Added in API level 4

public void setTargetDensity (DisplayMetrics metrics)

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

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

See also:

setTargetDensity

Added in API level 4

public void setTargetDensity (Canvas canvas)

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.

See also:

setTargetDensity

Added in API level 4

public void setTargetDensity (int density)

Set the density at which this drawable will be rendered.

Parameters
`density`	`int`: The density scale for this drawable.

See also:

setTileModeX

Added in API level 1

public void setTileModeX (Shader.TileMode mode)

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

Related XML Attributes:

android:tileModeX

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

See also:

setTileModeXY

Added in API level 1

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

Sets the repeat behavior of this drawable on both axis. By default, the drawable does not repeat its bitmap. Using Shader.TileMode.REPEAT or Shader.TileMode.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.

See also:

setTileModeY

Added in API level 1

public final void setTileModeY (Shader.TileMode mode)

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

Related XML Attributes:

android:tileModeY

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

See also:

setTintBlendMode

Added in API level 29

public void setTintBlendMode (BlendMode blendMode)

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

Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter)

Parameters
`blendMode`	`BlendMode`: This value cannot be `null`.

setTintList

Added in API level 21

public void setTintList (ColorStateList tint)

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, android.graphics.PorterDuff.Mode).

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

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

Protected methods

onBoundsChange

Added in API level 1

protected void onBoundsChange (Rect bounds)

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

Parameters
`bounds`	`Rect`: This value cannot be `null`.

onStateChange

Added in API level 1

protected boolean onStateChange (int[] stateSet)

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

Parameters
`stateSet`	`int`: This value cannot be `null`.

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.