Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#pubctors) \| [Methods](https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#inhmethods)
# AdaptiveIconDrawable
*** ** * ** ***
`
public
class
AdaptiveIconDrawable
`
`
`
`
extends https://developer.android.com/reference/android/graphics/drawable/Drawable
`
`
implements
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback
`
|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.graphics.drawable.Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable) ||
| | ↳ | android.graphics.drawable.AdaptiveIconDrawable |
*** ** * ** ***
This class can also be created via XML inflation using `` tag
in addition to dynamic creation.
This drawable supports two drawable layers: foreground and background. The layers are clipped
when rendering using the mask defined in the device configuration.
- Both foreground and background layers should be sized at 108 x 108 dp.
- The inner 72 x 72 dp of the icon appears within the masked viewport.
- The outer 18 dp on each of the 4 sides of the layers is reserved for use by the system UI surfaces to create interesting visual effects, such as parallax or pulsing.
Such motion effect is achieved by internally setting the bounds of the foreground and background layer as following:
```
Rect(getBounds().left - getBounds().getWidth() * #getExtraInsetFraction(),
getBounds().top - getBounds().getHeight() * #getExtraInsetFraction(),
getBounds().right + getBounds().getWidth() * #getExtraInsetFraction(),
getBounds().bottom + getBounds().getHeight() * #getExtraInsetFraction())
```
An alternate drawable can be specified using `` tag which can be
drawn in place of the two (background and foreground) layers. This drawable is tinted
according to the device or surface theme.
## Summary
| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#AdaptiveIconDrawable(android.graphics.drawable.Drawable,%20android.graphics.drawable.Drawable)(https://developer.android.com/reference/android/graphics/drawable/Drawable backgroundDrawable, https://developer.android.com/reference/android/graphics/drawable/Drawable foregroundDrawable) ` Constructor used to dynamically create this drawable. |
| ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#AdaptiveIconDrawable(android.graphics.drawable.Drawable,%20android.graphics.drawable.Drawable,%20android.graphics.drawable.Drawable)(https://developer.android.com/reference/android/graphics/drawable/Drawable backgroundDrawable, https://developer.android.com/reference/android/graphics/drawable/Drawable foregroundDrawable, https://developer.android.com/reference/android/graphics/drawable/Drawable monochromeDrawable) ` Constructor used to dynamically create this drawable. |
| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#applyTheme(android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources.Theme t) ` Applies the specified theme to this Drawable and its children. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#canApplyTheme()() ` |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#draw(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/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` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getAlpha()() ` Gets the current alpha value for the drawable. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getBackground()() ` Returns the foreground drawable managed by this class. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getChangingConfigurations()() ` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getConstantState()() ` Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable. |
| ` static float` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getExtraInsetFraction()() ` All four sides of the layers are padded with extra inset so as to provide extra content to reveal within the clip path when performing affine transformations on the layers. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getForeground()() ` Returns the foreground drawable managed by this class. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getHotspotBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect outRect) ` Populates `outRect` with the hotspot bounds. |
| ` https://developer.android.com/reference/android/graphics/Path` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getIconMask()() ` When called before the bound is set, the returned path is identical to R.string.config_icon_mask. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getIntrinsicHeight()() ` Returns the drawable's intrinsic height. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getIntrinsicWidth()() ` Returns the drawable's intrinsic width. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getMonochrome()() ` Returns the monochrome version of this drawable. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getOpacity()() ` *This method is deprecated. This method is no longer used in graphics optimizations* |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getOutline(android.graphics.Outline)(https://developer.android.com/reference/android/graphics/Outline outline) ` Called to get the drawable to populate the Outline that defines its drawing area. |
| ` https://developer.android.com/reference/android/graphics/Region` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getTransparentRegion()() ` Returns a Region representing the part of the Drawable that is completely transparent. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#hasFocusStateSpecified()() ` Indicates whether this drawable has at least one state spec explicitly specifying `https://developer.android.com/reference/android/R.attr#state_focused`. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme) ` Inflate this Drawable from an XML resource optionally styled by a theme. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#invalidateDrawable(android.graphics.drawable.Drawable)(https://developer.android.com/reference/android/graphics/drawable/Drawable who) ` Called when the drawable needs to be redrawn. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#invalidateSelf()() ` Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable redrawn. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#isAutoMirrored()() ` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#isProjected()() ` Whether this drawable requests projection. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#isStateful()() ` Indicates whether this drawable will change its appearance based on state. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#jumpToCurrentState()() ` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#mutate()() ` Make this drawable mutable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)(https://developer.android.com/reference/android/graphics/drawable/Drawable who, https://developer.android.com/reference/java/lang/Runnable what, long when) ` A Drawable can call this to schedule the next frame of its animation. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setAlpha(int)(int alpha) ` Specify an alpha value for the drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setAutoMirrored(boolean)(boolean mirrored) ` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setColorFilter(android.graphics.ColorFilter)(https://developer.android.com/reference/android/graphics/ColorFilter colorFilter) ` Specify an optional color filter for the drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setDither(boolean)(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` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setHotspot(float,%20float)(float x, float y) ` Specifies the hotspot's location within the drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setHotspotBounds(int,%20int,%20int,%20int)(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. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setOpacity(int)(int opacity) ` |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setTintBlendMode(android.graphics.BlendMode)(https://developer.android.com/reference/android/graphics/BlendMode blendMode) ` Specifies a tint blending mode for this drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setTintList(android.content.res.ColorStateList)(https://developer.android.com/reference/android/content/res/ColorStateList tint) ` Specifies tint color for this drawable as a color state list. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#setVisible(boolean,%20boolean)(boolean visible, boolean restart) ` Set whether this Drawable is visible. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#unscheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable)(https://developer.android.com/reference/android/graphics/drawable/Drawable who, https://developer.android.com/reference/java/lang/Runnable what) ` A Drawable can call this to unschedule an action previously scheduled with `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)`. |
| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#onBoundsChange(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds) ` Override this in your subclass to change appearance if you vary based on the bounds. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#onLevelChange(int)(int level) ` Override this in your subclass to change appearance if you vary based on level. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#onStateChange(int[])(int[] state) ` Override this in your subclass to change appearance if you recognize the specified state. |
### Inherited methods
From class `
https://developer.android.com/reference/android/graphics/drawable/Drawable
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#applyTheme(android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources.Theme t)
`
Applies the specified theme to this Drawable and its children.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#canApplyTheme()()
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#clearColorFilter()()
`
Removes the color filter for this drawable.
`
final
https://developer.android.com/reference/android/graphics/Rect` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#copyBounds()()
`
Return a copy of the drawable's bounds in a new Rect.
`
final
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#copyBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds)
`
Return a copy of the drawable's bounds in the specified Rect (allocated
by the caller).
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromPath(java.lang.String)(https://developer.android.com/reference/java/lang/String pathName)
`
Create a drawable from file path name.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromResourceStream(android.content.res.Resources,%20android.util.TypedValue,%20java.io.InputStream,%20java.lang.String,%20android.graphics.BitmapFactory.Options)(https://developer.android.com/reference/android/content/res/Resources res, https://developer.android.com/reference/android/util/TypedValue value, https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName, https://developer.android.com/reference/android/graphics/BitmapFactory.Options opts)
`
*This method was deprecated
in API level 28.
Prefer the version without an Options object.*
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromResourceStream(android.content.res.Resources,%20android.util.TypedValue,%20java.io.InputStream,%20java.lang.String)(https://developer.android.com/reference/android/content/res/Resources res, https://developer.android.com/reference/android/util/TypedValue value, https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName)
`
Create a drawable from an inputstream, using the given resources and
value to determine density information.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromStream(java.io.InputStream,%20java.lang.String)(https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName)
`
Create a drawable from an inputstream
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXml(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser)
`
Create a drawable from an XML document.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXml(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/content/res/Resources.Theme theme)
`
Create a drawable from an XML document using an optional `https://developer.android.com/reference/android/content/res/Resources.Theme`.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXmlInner(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme)
`
Create a drawable from inside an XML document using an optional
`https://developer.android.com/reference/android/content/res/Resources.Theme`.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXmlInner(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs)
`
Create from inside an XML document.
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#draw(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/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` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getAlpha()()
`
Gets the current alpha value for the drawable.
`
final
https://developer.android.com/reference/android/graphics/Rect` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getBounds()()
`
Return the drawable's bounds Rect.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getCallback()()
`
Return the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation attached to this
Drawable.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getChangingConfigurations()()
`
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
`
https://developer.android.com/reference/android/graphics/ColorFilter` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getColorFilter()()
`
Returns the current color filter, or `null` if none set.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getConstantState()()
`
Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getCurrent()()
` `
https://developer.android.com/reference/android/graphics/Rect` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getDirtyBounds()()
`
Return the drawable's dirty bounds Rect.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getHotspotBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect outRect)
`
Populates `outRect` with the hotspot bounds.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getIntrinsicHeight()()
`
Returns the drawable's intrinsic height.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getIntrinsicWidth()()
`
Returns the drawable's intrinsic width.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getLayoutDirection()()
`
Returns the resolved layout direction for this Drawable.
`
final
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getLevel()()
`
Retrieve the current level.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getMinimumHeight()()
`
Returns the minimum height suggested by this Drawable.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getMinimumWidth()()
`
Returns the minimum width suggested by this Drawable.
`
abstract
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getOpacity()()
`
*This method was deprecated
in API level 29.
This method is no longer used in graphics optimizations*
`
https://developer.android.com/reference/android/graphics/Insets` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getOpticalInsets()()
`
Return in insets the layout insets suggested by this Drawable for use with alignment
operations during layout.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getOutline(android.graphics.Outline)(https://developer.android.com/reference/android/graphics/Outline outline)
`
Called to get the drawable to populate the Outline that defines its drawing area.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getPadding(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect padding)
`
Return in padding the insets suggested by this Drawable for placing
content inside the drawable's bounds.
`
int[]` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getState()()
`
Describes the current state, as a union of primitive states, such as
`https://developer.android.com/reference/android/R.attr#state_focused`,
`https://developer.android.com/reference/android/R.attr#state_selected`, etc.
`
https://developer.android.com/reference/android/graphics/Region` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getTransparentRegion()()
`
Returns a Region representing the part of the Drawable that is completely
transparent.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#hasFocusStateSpecified()()
`
Indicates whether this drawable has at least one state spec explicitly
specifying `https://developer.android.com/reference/android/R.attr#state_focused`.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme)
`
Inflate this Drawable from an XML resource optionally styled by a theme.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs)
`
Inflate this Drawable from an XML resource.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#invalidateSelf()()
`
Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable
redrawn.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isAutoMirrored()()
`
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isFilterBitmap()()
` `
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isProjected()()
`
Whether this drawable requests projection.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isStateful()()
`
Indicates whether this drawable will change its appearance based on
state.
`
final
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isVisible()()
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#jumpToCurrentState()()
`
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#mutate()()
`
Make this drawable mutable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#onBoundsChange(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds)
`
Override this in your subclass to change appearance if you vary based on
the bounds.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#onLayoutDirectionChanged(int)(int layoutDirection)
`
Called when the drawable's resolved layout direction changes.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#onLevelChange(int)(int level)
`
Override this in your subclass to change appearance if you vary based
on level.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#onStateChange(int[])(int[] state)
`
Override this in your subclass to change appearance if you recognize the
specified state.
`
static
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#resolveOpacity(int,%20int)(int op1, int op2)
`
Return the appropriate opacity value for two source opacities.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#scheduleSelf(java.lang.Runnable,%20long)(https://developer.android.com/reference/java/lang/Runnable what, long when)
`
Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable
scheduled.
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setAlpha(int)(int alpha)
`
Specify an alpha value for the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setAutoMirrored(boolean)(boolean mirrored)
`
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left).
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setBounds(int,%20int,%20int,%20int)(int left, int top, int right, int bottom)
`
Specify a bounding rectangle for the Drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds)
`
Specify a bounding rectangle for the Drawable.
`
final
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setCallback(android.graphics.drawable.Drawable.Callback)(https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback cb)
`
Bind a `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` object to this Drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setChangingConfigurations(int)(int configs)
`
Set a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(int,%20android.graphics.PorterDuff.Mode)(int color, https://developer.android.com/reference/android/graphics/PorterDuff.Mode mode)
`
*This method was deprecated
in API level 29.
use `https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)` with an instance
of `https://developer.android.com/reference/android/graphics/BlendModeColorFilter`*
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)(https://developer.android.com/reference/android/graphics/ColorFilter colorFilter)
`
Specify an optional color filter for the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setDither(boolean)(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` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setFilterBitmap(boolean)(boolean filter)
`
Set to true to have the drawable filter its bitmaps with bilinear
sampling when they are scaled or rotated.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setHotspot(float,%20float)(float x, float y)
`
Specifies the hotspot's location within the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setHotspotBounds(int,%20int,%20int,%20int)(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` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setLayoutDirection(int)(int layoutDirection)
`
Set the layout direction for this drawable.
`
final
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setLevel(int)(int level)
`
Specify the level for the drawable.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setState(int[])(int[] stateSet)
`
Specify a set of states for the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setTint(int)(int tintColor)
`
Specifies tint color for this drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintBlendMode(android.graphics.BlendMode)(https://developer.android.com/reference/android/graphics/BlendMode blendMode)
`
Specifies a tint blending mode for this drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintList(android.content.res.ColorStateList)(https://developer.android.com/reference/android/content/res/ColorStateList tint)
`
Specifies tint color for this drawable as a color state list.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintMode(android.graphics.PorterDuff.Mode)(https://developer.android.com/reference/android/graphics/PorterDuff.Mode tintMode)
`
Specifies a tint blending mode for this drawable.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setVisible(boolean,%20boolean)(boolean visible, boolean restart)
`
Set whether this Drawable is visible.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#unscheduleSelf(java.lang.Runnable)(https://developer.android.com/reference/java/lang/Runnable what)
`
Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable
unscheduled.
From class `
https://developer.android.com/reference/java/lang/Object
` `
https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`
Creates and returns a copy of this object.
`
boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`
Indicates whether some other object is "equal to" this one.
`
void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
`
final
https://developer.android.com/reference/java/lang/Class` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`
Returns the runtime class of this `Object`.
`
int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`
Returns a hash code value for the object.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`
Wakes up a single thread that is waiting on this object's
monitor.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`
Wakes up all threads that are waiting on this object's monitor.
`
https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`
Returns a string representation of the object.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` `
https://developer.android.com/reference/java/lang/Object#wait(long)(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` `
https://developer.android.com/reference/java/lang/Object#wait()()
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.
From interface `
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback
` `
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#invalidateDrawable(android.graphics.drawable.Drawable)(https://developer.android.com/reference/android/graphics/drawable/Drawable who)
`
Called when the drawable needs to be redrawn.
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)(https://developer.android.com/reference/android/graphics/drawable/Drawable who, https://developer.android.com/reference/java/lang/Runnable what, long when)
`
A Drawable can call this to schedule the next frame of its
animation.
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#unscheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable)(https://developer.android.com/reference/android/graphics/drawable/Drawable who, https://developer.android.com/reference/java/lang/Runnable what)
`
A Drawable can call this to unschedule an action previously
scheduled with `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)`.
## Public constructors
### AdaptiveIconDrawable
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public AdaptiveIconDrawable (Drawable backgroundDrawable,
Drawable foregroundDrawable)
```
Constructor used to dynamically create this drawable.
| Parameters ||
|---|---|
| `backgroundDrawable` | `Drawable`: drawable that should be rendered in the background
|
| `foregroundDrawable` | `Drawable`: drawable that should be rendered in the foreground
|
### AdaptiveIconDrawable
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public AdaptiveIconDrawable (Drawable backgroundDrawable,
Drawable foregroundDrawable,
Drawable monochromeDrawable)
```
Constructor used to dynamically create this drawable.
| Parameters ||
|---|---|
| `backgroundDrawable` | `Drawable`: drawable that should be rendered in the background. This value may be `null`.
|
| `foregroundDrawable` | `Drawable`: drawable that should be rendered in the foreground. This value may be `null`.
|
| `monochromeDrawable` | `Drawable`: an alternate drawable which can be tinted per system theme color. This value may be `null`.
|
## Public methods
### applyTheme
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void applyTheme (Resources.Theme t)
```
Applies the specified theme to this Drawable and its children.
| Parameters ||
|---|---|
| `t` | `Resources.Theme`: This value cannot be `null`.
|
### canApplyTheme
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean canApplyTheme ()
```
| Returns ||
|---|---|
| `boolean` |
|
### draw
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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
|
### getBackground
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Drawable getBackground ()
```
Returns the foreground drawable managed by this class. The bound of this drawable is
extended by `https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getExtraInsetFraction()` \* getBounds().width on left/right sides and by
`https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getExtraInsetFraction()` \* getBounds().height on top/bottom sides.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable` | the background drawable managed by this drawable
|
### getChangingConfigurations
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setChangingConfigurations(int)` or 0 by default. Subclasses
may extend this to or in the changing configurations of any other
drawables they hold.
| Returns ||
|---|---|
| `int` | Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_MCC` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_MNC` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_LOCALE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_TOUCHSCREEN` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_KEYBOARD` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_KEYBOARD_HIDDEN` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_NAVIGATION` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_ORIENTATION` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_SCREEN_LAYOUT` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_UI_MODE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_SCREEN_SIZE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_SMALLEST_SCREEN_SIZE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_DENSITY` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_LAYOUT_DIRECTION` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_COLOR_MODE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_FONT_SCALE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_GRAMMATICAL_GENDER` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_FONT_WEIGHT_ADJUSTMENT` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_ASSETS_PATHS` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_RESOURCES_UNUSED` |
### getConstantState
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Drawable.ConstantState getConstantState ()
```
Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` | The ConstantState associated to that Drawable. This value may be `null`.
|
### getExtraInsetFraction
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static float getExtraInsetFraction ()
```
All four sides of the layers are padded with extra inset so as to provide
extra content to reveal within the clip path when performing affine transformations on the
layers.
| Returns ||
|---|---|
| `float` |
|
**See also:**
- `https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getForeground()`
### getForeground
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Drawable getForeground ()
```
Returns the foreground drawable managed by this class. The bound of this drawable is
extended by `https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getExtraInsetFraction()` \* getBounds().width on left/right sides and by
`https://developer.android.com/reference/android/graphics/drawable/AdaptiveIconDrawable#getExtraInsetFraction()` \* getBounds().height on top/bottom sides.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable` | the foreground drawable managed by this drawable
|
### getHotspotBounds
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void getHotspotBounds (Rect outRect)
```
Populates `outRect` with the hotspot bounds.
| Parameters ||
|---|---|
| `outRect` | `Rect`: the rect to populate with the hotspot bounds. This value cannot be `null`.
|
### getIconMask
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Path getIconMask ()
```
When called before the bound is set, the returned path is identical to
R.string.config_icon_mask. After the bound is set, the
returned path's computed bound is same as the #getBounds().
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Path` | the mask path object used to clip the drawable
|
### getIntrinsicHeight
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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
|
### getMonochrome
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Drawable getMonochrome ()
```
Returns the monochrome version of this drawable. Callers can use a tinted version of
this drawable instead of the original drawable on surfaces stressing user theming.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable` | the monochrome drawable. This value may be `null`.
|
### getOpacity
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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
`https://developer.android.com/reference/android/graphics/PixelFormat`:
`https://developer.android.com/reference/android/graphics/PixelFormat#UNKNOWN`,
`https://developer.android.com/reference/android/graphics/PixelFormat#TRANSLUCENT`,
`https://developer.android.com/reference/android/graphics/PixelFormat#TRANSPARENT`, or
`https://developer.android.com/reference/android/graphics/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 `https://developer.android.com/reference/android/graphics/drawable/Drawable#resolveOpacity(int,%20int)` 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 `https://developer.android.com/reference/android/graphics/drawable/Drawable#setAlpha(int)` or `https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)` methods. Some subclasses,
such as `https://developer.android.com/reference/android/graphics/drawable/BitmapDrawable`, `https://developer.android.com/reference/android/graphics/drawable/ColorDrawable`, and `https://developer.android.com/reference/android/graphics/drawable/GradientDrawable`,
do account for the value of `https://developer.android.com/reference/android/graphics/drawable/Drawable#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 one of the following: - `https://developer.android.com/reference/android/graphics/PixelFormat#UNKNOWN` - `https://developer.android.com/reference/android/graphics/PixelFormat#TRANSLUCENT` - `https://developer.android.com/reference/android/graphics/PixelFormat#TRANSPARENT` - `https://developer.android.com/reference/android/graphics/PixelFormat#OPAQUE` |
### getOutline
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/view/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`.
|
### getTransparentRegion
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Region getTransparentRegion ()
```
Returns a Region representing the part of the Drawable that is completely
transparent. This can be used to perform drawing operations, identifying
which parts of the target will not change when rendering the Drawable.
The default implementation returns null, indicating no transparent
region; subclasses can optionally override this to return an actual
Region if they want to supply this optimization information, but it is
not required that they do so.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Region` | This value may be `null`.
|
### hasFocusStateSpecified
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean hasFocusStateSpecified ()
```
Indicates whether this drawable has at least one state spec explicitly
specifying `https://developer.android.com/reference/android/R.attr#state_focused`.
Note: A View uses a `https://developer.android.com/reference/android/graphics/drawable/Drawable` instance as its background and it
changes its appearance based on a state. On keyboard devices, it should
specify its `https://developer.android.com/reference/android/R.attr#state_focused` to make sure the user
knows which view is holding the focus.
| Returns ||
|---|---|
| `boolean` | `true` if `https://developer.android.com/reference/android/R.attr#state_focused` is specified for this drawable.
|
### inflate
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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`: This value cannot be `null`.
|
| `parser` | `XmlPullParser`: This value cannot be `null`.
|
| `attrs` | `AttributeSet`: This value cannot be `null`.
|
| `theme` | `Resources.Theme`: This value may be `null`.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | |
| `https://developer.android.com/reference/org/xmlpull/v1/XmlPullParserException` | |
### invalidateDrawable
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void invalidateDrawable (Drawable who)
```
Called when the drawable needs to be redrawn. A view at this point
should invalidate itself (or at least the part of itself where the
drawable appears).
| Parameters ||
|---|---|
| `who` | `Drawable`: This value cannot be `null`.
|
### invalidateSelf
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void invalidateSelf ()
```
Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable
redrawn. Does nothing if there is no Callback attached to the
Drawable.
### isAutoMirrored
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isAutoMirrored ()
```
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left. See `https://developer.android.com/reference/android/util/LayoutDirection`.
| Returns ||
|---|---|
| `boolean` | boolean Returns true if this Drawable will be automatically mirrored.
|
### isProjected
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isProjected ()
```
Whether this drawable requests projection. Indicates that the
`https://developer.android.com/reference/android/graphics/RenderNode` this Drawable will draw into should be drawn immediately
after the closest ancestor RenderNode containing a projection receiver.
| Returns ||
|---|---|
| `boolean` |
|
### isStateful
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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.
|
### jumpToCurrentState
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void jumpToCurrentState ()
```
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
### mutate
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Drawable mutate ()
```
Make this drawable mutable. This operation cannot be reversed. A mutable
drawable is guaranteed to not share its state with any other drawable.
This is especially useful when you need to modify properties of drawables
loaded from resources. By default, all drawables instances loaded from
the same resource share a common state; if you modify the state of one
instance, all the other instances will receive the same modification.
Calling this method on a mutable Drawable will have no effect.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable` | This drawable. This value cannot be `null`.
|
### scheduleDrawable
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void scheduleDrawable (Drawable who,
Runnable what,
long when)
```
A Drawable can call this to schedule the next frame of its
animation. An implementation can generally simply call
`https://developer.android.com/reference/android/os/Handler#postAtTime(java.lang.Runnable,%20java.lang.Object,%20long)` with
the parameters (what, who, when) to perform the
scheduling.
| Parameters ||
|---|---|
| `who` | `Drawable`: This value cannot be `null`.
|
| `what` | `Runnable`: This value cannot be `null`.
|
| `when` | `long`: The time (in milliseconds) to run. The timebase is `https://developer.android.com/reference/android/os/SystemClock#uptimeMillis()`
|
### setAlpha
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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
|
### setAutoMirrored
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setAutoMirrored (boolean mirrored)
```
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left). See `https://developer.android.com/reference/android/util/LayoutDirection`.
| Parameters ||
|---|---|
| `mirrored` | `boolean`: Set to true if the Drawable should be mirrored, false if not.
|
### setColorFilter
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintList(android.content.res.ColorStateList)`.
| Parameters ||
|---|---|
| `colorFilter` | `ColorFilter`: The color filter to apply, or `null` to remove the existing color filter
|
### setDither
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public 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.
| Parameters ||
|---|---|
| `dither` | `boolean`
|
### setHotspot
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setHotspot (float x,
float y)
```
Specifies the hotspot's location within the drawable.
| Parameters ||
|---|---|
| `x` | `float`: The X coordinate of the center of the hotspot
|
| `y` | `float`: The Y coordinate of the center of the hotspot
|
### setHotspotBounds
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public 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.
| Parameters ||
|---|---|
| `left` | `int`: position in pixels of the left bound
|
| `top` | `int`: position in pixels of the top bound
|
| `right` | `int`: position in pixels of the right bound
|
| `bottom` | `int`: position in pixels of the bottom bound
|
### setOpacity
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setOpacity (int opacity)
```
| Parameters ||
|---|---|
| `opacity` | `int`
|
### setTintBlendMode
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/graphics/BlendMode#SRC_IN`.
**Note:** Setting a color filter via
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)`
| Parameters ||
|---|---|
| `blendMode` | `BlendMode`: This value cannot be `null`.
|
### setTintList
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(int,%20android.graphics.PorterDuff.Mode)`.
**Note:** Setting a color filter via
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)` or
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(int,%20android.graphics.PorterDuff.Mode)` overrides tint.
| Parameters ||
|---|---|
| `tint` | `ColorStateList`: Color state list to use for tinting this drawable, or `null` to clear the tint
|
### setVisible
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean setVisible (boolean visible,
boolean restart)
```
Set whether this Drawable is visible. This generally does not impact
the Drawable's behavior, but is a hint that can be used by some
Drawables, for example, to decide whether run animations.
| Parameters ||
|---|---|
| `visible` | `boolean`: Set to true if visible, false if not.
|
| `restart` | `boolean`: You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart.
|
| Returns ||
|---|---|
| `boolean` | boolean Returns true if the new visibility is different than its previous state.
|
### unscheduleDrawable
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void unscheduleDrawable (Drawable who,
Runnable what)
```
A Drawable can call this to unschedule an action previously
scheduled with `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)`. An implementation can
generally simply call
`https://developer.android.com/reference/android/os/Handler#removeCallbacks(java.lang.Runnable,%20java.lang.Object)` with
the parameters (what, who) to unschedule the drawable.
| Parameters ||
|---|---|
| `who` | `Drawable`: This value cannot be `null`.
|
| `what` | `Runnable`: This value cannot be `null`.
|
## Protected methods
### onBoundsChange
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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`.
|
### onLevelChange
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected boolean onLevelChange (int level)
```
Override this in your subclass to change appearance if you vary based
on level.
| Parameters ||
|---|---|
| `level` | `int`
|
| Returns ||
|---|---|
| `boolean` | Returns true if the level 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 level.
|
### onStateChange
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected boolean onStateChange (int[] state)
```
Override this in your subclass to change appearance if you recognize the
specified state.
| Parameters ||
|---|---|
| `state` | `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.
|