Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [XML Attrs](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#lattrs) \| [Ctors](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#pubctors) \| [Methods](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#inhmethods)

# AnimatedVectorDrawable

*** ** * ** ***


`
public


class
AnimatedVectorDrawable
`


`


`

`

extends https://developer.android.com/reference/android/graphics/drawable/Drawable


`

`


implements

https://developer.android.com/reference/android/graphics/drawable/Animatable2


`

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

<br />

*** ** * ** ***

This class animates properties of a `https://developer.android.com/reference/android/graphics/drawable/VectorDrawable` with
animations defined using `https://developer.android.com/reference/android/animation/ObjectAnimator` or
`https://developer.android.com/reference/android/animation/AnimatorSet`.


Starting from API 25, AnimatedVectorDrawable runs on RenderThread (as opposed to on UI thread for
earlier APIs). This means animations in AnimatedVectorDrawable can remain smooth even when there
is heavy workload on the UI thread. Note: If the UI thread is unresponsive, RenderThread may
continue animating until the UI thread is capable of pushing another frame. Therefore, it is not
possible to precisely coordinate a RenderThread-enabled AnimatedVectorDrawable with UI thread
animations. Additionally,
`https://developer.android.com/reference/android/graphics/drawable/Animatable2.AnimationCallback#onAnimationEnd(android.graphics.drawable.Drawable)` will be
called the frame after the AnimatedVectorDrawable finishes on the RenderThread.


AnimatedVectorDrawable can be defined in either [three separate XML files](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#ThreeXML),
or [one XML](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#OneXML).

### Define an AnimatedVectorDrawable in three separate XML files

-

  #### XML for the VectorDrawable containing properties to be animated


  Animations can be performed on the animatable attributes in
  `https://developer.android.com/reference/android/graphics/drawable/VectorDrawable`. These attributes will be animated by
  `https://developer.android.com/reference/android/animation/ObjectAnimator`. The ObjectAnimator's target can be the root element,
  a group element or a path element. The targeted elements need to be named uniquely within
  the same VectorDrawable. Elements without animation do not need to be named.


  Here are all the animatable attributes in `https://developer.android.com/reference/android/graphics/drawable/VectorDrawable`:

  | Element Name | Animatable attribute name |
  |---|---|
  | \<vector\> | alpha |
  | \<group\> | rotation |
  | \<group\> | pivotX |
  | \<group\> | pivotY |
  | \<group\> | scaleX |
  | \<group\> | scaleY |
  | \<group\> | translateX |
  | \<group\> | translateY |
  | \<path\> | pathData |
  | \<path\> | fillColor |
  | \<path\> | strokeColor |
  | \<path\> | strokeWidth |
  | \<path\> | strokeAlpha |
  | \<path\> | fillAlpha |
  | \<path\> | trimPathStart |
  | \<path\> | trimPathEnd |
  | \<path\> | trimPathOffset |
  | \<clip-path\> | pathData |

  <br />

  Below is an example of a VectorDrawable defined in vectordrawable.xml. This VectorDrawable is referred to by its file name (not including file suffix) in the [AnimatedVectorDrawable XML example](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#AVDExample).

  ```
  <vector xmlns:android="http://schemas.android.com/apk/res/android"
      android:height="64dp"
      android:width="64dp"
      android:viewportHeight="600"
      android:viewportWidth="600" >
      <group
          android:name="rotationGroup"
          android:pivotX="300.0"
          android:pivotY="300.0"
          android:rotation="45.0" >
          <path
              android:name="v"
              android:fillColor="#000000"
              android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" />
      </group>
  </vector>
  ```
-

  #### XML for AnimatedVectorDrawable


  An AnimatedVectorDrawable element has a VectorDrawable attribute, and one or more target
  element(s). The target element can specify its target by android:name attribute, and link the
  target with the proper ObjectAnimator or AnimatorSet by android:animation attribute.
  The following code sample defines an AnimatedVectorDrawable. Note that the names refer to the groups and paths in the [VectorDrawable XML above](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#VDExample).

  ```
  <animated-vector xmlns:android="http://schemas.android.com/apk/res/android"
      android:drawable="@drawable/vectordrawable" >
      <target
          android:name="rotationGroup"
          android:animation="@animator/rotation" />
      <target
          android:name="v"
          android:animation="@animator/path_morph" />
  </animated-vector>
  ```
-

  #### XML for Animations defined using ObjectAnimator or AnimatorSet


  From the previous [example of AnimatedVectorDrawable](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#AVDExample), two animations
  were used: rotation.xml and path_morph.xml.
  rotation.xml rotates the target group from 0 degree to 360 degrees over 6000ms:

  ```
  <objectAnimator
      android:duration="6000"
      android:propertyName="rotation"
      android:valueFrom="0"
      android:valueTo="360" />
  ```
  path_morph.xml morphs the path from one shape into the other. Note that the paths must be compatible for morphing. Specifically, the paths must have the same commands, in the same order, and must have the same number of parameters for each command. It is recommended to store path strings as string resources for reuse.

  ```
  <set xmlns:android="http://schemas.android.com/apk/res/android">
      <objectAnimator
          android:duration="3000"
          android:propertyName="pathData"
          android:valueFrom="M300,70 l 0,-70 70,70 0,0 -70,70z"
          android:valueTo="M300,70 l 0,-70 70,0  0,140 -70,0 z"
          android:valueType="pathType"/>
  </set>
  ```

### Define an AnimatedVectorDrawable all in one XML file


Since the AAPT tool supports a new format that bundles several related XML files together, we can
merge the XML files from the previous examples into one XML file:

```
<animated-vector xmlns:android="http://schemas.android.com/apk/res/android"
                 xmlns:aapt=&quothttp://schemas.android.com/aapt" >
    <aapt:attr name="android:drawable">
        <vector
            android:height="64dp"
            android:width="64dp"
            android:viewportHeight="600"
            android:viewportWidth="600" >
            <group
                android:name="rotationGroup"
                android:pivotX="300.0"
                android:pivotY="300.0"
                android:rotation="45.0" >
                <path
                    android:name="v"
                    android:fillColor="#000000"
                    android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" />
            </group>
        </vector>
    </aapt:attr>

    <target android:name="rotationGroup"> *
        <aapt:attr name="android:animation">
            <objectAnimator
            android:duration="6000"
            android:propertyName="rotation"
            android:valueFrom="0"
            android:valueTo="360" />
        </aapt:attr>
    </target>

    <target android:name="v" >
        <aapt:attr name="android:animation">
            <set>
                <objectAnimator
                    android:duration="3000"
                    android:propertyName="pathData"
                    android:valueFrom="M300,70 l 0,-70 70,70 0,0 -70,70z"
                    android:valueTo="M300,70 l 0,-70 70,0  0,140 -70,0 z"
                    android:valueType="pathType"/>
            </set>
        </aapt:attr>
     </target>
</animated-vector>
```

<br />

## Summary

| ### XML attributes ||
|---|---|
| [`android:animation`](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#attr_android:animation) | The animation for the target path, group or vector drawable. |
| [`android:drawable`](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#attr_android:drawable) | The static vector drawable. |
| [`android:name`](https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#attr_android:name) | The name of the target path, group or vector drawable. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#AnimatedVectorDrawable()() ` |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#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/AnimatedVectorDrawable#canApplyTheme()() ` |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#clearAnimationCallbacks()() ` Removes all existing animation callbacks. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#draw(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/Canvas canvas) ` Draws the AnimatedVectorDrawable into the given canvas. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#getAlpha()() ` For API 25 and later, AnimatedVectorDrawable runs on RenderThread. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#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/AnimatedVectorDrawable#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/AnimatedVectorDrawable#getConstantState()() ` Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#getIntrinsicHeight()() ` Returns the drawable's intrinsic height. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#getIntrinsicWidth()() ` Returns the drawable's intrinsic width. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#getOpacity()() ` *This method is deprecated. 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/AnimatedVectorDrawable#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/AnimatedVectorDrawable#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. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#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 res, 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. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#isRunning()() ` Indicates whether the animation is running. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#isStateful()() ` Indicates whether this drawable will change its appearance based on state. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#mutate()() ` Make this drawable mutable. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#onLayoutDirectionChanged(int)(int layoutDirection) ` Called when the drawable's resolved layout direction changes. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#registerAnimationCallback(android.graphics.drawable.Animatable2.AnimationCallback)(https://developer.android.com/reference/android/graphics/drawable/Animatable2.AnimationCallback callback) ` Adds a callback to listen to the animation events. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#reset()() ` Resets the AnimatedVectorDrawable to the start state as specified in the animators. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#setAlpha(int)(int alpha) ` Specify an alpha value for the drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#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/AnimatedVectorDrawable#setHotspot(float,%20float)(float x, float y) ` Specifies the hotspot's location within the drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#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/AnimatedVectorDrawable#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/AnimatedVectorDrawable#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/AnimatedVectorDrawable#setVisible(boolean,%20boolean)(boolean visible, boolean restart) ` Set whether this Drawable is visible. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#start()() ` Starts the drawable's animation. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#stop()() ` Stops the drawable's animation. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#unregisterAnimationCallback(android.graphics.drawable.Animatable2.AnimationCallback)(https://developer.android.com/reference/android/graphics/drawable/Animatable2.AnimationCallback callback) ` Removes the specified animation callback. |

| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable#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/AnimatedVectorDrawable#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/AnimatedVectorDrawable#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/Animatable2 ` |---|---| | ` abstract void` | ` https://developer.android.com/reference/android/graphics/drawable/Animatable2#clearAnimationCallbacks()() ` Removes all existing animation callbacks. | | ` abstract void` | ` https://developer.android.com/reference/android/graphics/drawable/Animatable2#registerAnimationCallback(android.graphics.drawable.Animatable2.AnimationCallback)(https://developer.android.com/reference/android/graphics/drawable/Animatable2.AnimationCallback callback) ` Adds a callback to listen to the animation events. | | ` abstract boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Animatable2#unregisterAnimationCallback(android.graphics.drawable.Animatable2.AnimationCallback)(https://developer.android.com/reference/android/graphics/drawable/Animatable2.AnimationCallback callback) ` Removes the specified animation callback. | ||
| From interface ` https://developer.android.com/reference/android/graphics/drawable/Animatable ` |---|---| | ` abstract boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Animatable#isRunning()() ` Indicates whether the animation is running. | | ` abstract void` | ` https://developer.android.com/reference/android/graphics/drawable/Animatable#start()() ` Starts the drawable's animation. | | ` abstract void` | ` https://developer.android.com/reference/android/graphics/drawable/Animatable#stop()() ` Stops the drawable's animation. | ||

## XML attributes

### android:animation

The animation for the target path, group or vector drawable.

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

<br />

### android:drawable

The static vector drawable.

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

<br />

### android:name

The name of the target path, group or vector drawable.

May be a string value, using '\\\\;' to escape characters such as
'\\\\n' or '\\\\uxxxx' for a unicode character;

<br />

## Public constructors

### AnimatedVectorDrawable

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public AnimatedVectorDrawable ()
```

<br />

<br />

## Public methods

### applyTheme

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `t` | `Resources.Theme`: the theme to apply. This value cannot be `null`. <br /> |

### canApplyTheme

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean canApplyTheme ()
```

<br />

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### clearAnimationCallbacks

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void clearAnimationCallbacks ()
```

Removes all existing animation callbacks.

<br />

### draw

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void draw (Canvas canvas)
```

Draws the AnimatedVectorDrawable into the given canvas.


**Note:** Calling this method with a software canvas when the
AnimatedVectorDrawable is being animated on RenderThread (for API 25 and later) may yield
outdated result, as the UI thread is not guaranteed to be in sync with RenderThread on
VectorDrawable's property changes during RenderThread animations.

<br />

<br />

| Parameters ||
|---|---|
| `canvas` | `Canvas`: The canvas to draw into <br /> |

### getAlpha

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getAlpha ()
```

For API 25 and later, AnimatedVectorDrawable runs on RenderThread. Therefore, when the
root alpha is being animated, this getter does not guarantee to return an up-to-date alpha
value.

<br />

| Returns ||
|---|---|
| `int` | the containing vector drawable's root alpha value. <br /> |

### getChangingConfigurations

Added in [API level 21](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.

<br />

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

### getColorFilter

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ColorFilter getColorFilter ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/ColorFilter` | the current color filter, or `null` if none set <br /> |

### getConstantState

Added in [API level 21](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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` | The ConstantState associated to that Drawable. This value may be `null`. <br /> |

### getIntrinsicHeight

Added in [API level 21](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.

<br />

| Returns ||
|---|---|
| `int` | the intrinsic height, or -1 if no intrinsic height <br /> |

### getIntrinsicWidth

Added in [API level 21](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.

<br />

| Returns ||
|---|---|
| `int` | the intrinsic width, or -1 if no intrinsic width <br /> |

### getOpacity

Added in [API level 21](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.

<br />

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

### getOpticalInsets

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Insets getOpticalInsets ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Insets` | This value cannot be `null`. <br /> |

### getOutline

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `outline` | `Outline`: This value cannot be `null`. <br /> |

### inflate

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void inflate (Resources res, 
                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.

<br />

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` |   |
| `https://developer.android.com/reference/org/xmlpull/v1/XmlPullParserException` |   |

### isRunning

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isRunning ()
```

Indicates whether the animation is running.

<br />

| Returns ||
|---|---|
| `boolean` | True if the animation is running, false otherwise. <br /> |

### isStateful

Added in [API level 21](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.

<br />

| Returns ||
|---|---|
| `boolean` | True if this drawable changes its appearance based on state, false otherwise. <br /> |

### mutate

Added in [API level 21](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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable` | This drawable. This value cannot be `null`. <br /> |

### onLayoutDirectionChanged

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean onLayoutDirectionChanged (int layoutDirection)
```

Called when the drawable's resolved layout direction changes.

<br />

| Parameters ||
|---|---|
| `layoutDirection` | `int`: Value is one of the following: - `https://developer.android.com/reference/android/view/View#LAYOUT_DIRECTION_LTR` - `https://developer.android.com/reference/android/view/View#LAYOUT_DIRECTION_RTL` |

| Returns ||
|---|---|
| `boolean` | `true` if the layout direction change has caused the appearance of the drawable to change such that it needs to be re-drawn, `false` otherwise <br /> |

### registerAnimationCallback

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void registerAnimationCallback (Animatable2.AnimationCallback callback)
```

Adds a callback to listen to the animation events.

<br />

| Parameters ||
|---|---|
| `callback` | `Animatable2.AnimationCallback`: This value cannot be `null`. <br /> |

### reset

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void reset ()
```

Resets the AnimatedVectorDrawable to the start state as specified in the animators.

<br />

### setAlpha

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `alpha` | `int`: Value is between 0 and 255 inclusive <br /> |

### setColorFilter

Added in [API level 21](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)`.

<br />

<br />

| Parameters ||
|---|---|
| `colorFilter` | `ColorFilter`: The color filter to apply, or `null` to remove the existing color filter <br /> |

### setHotspot

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `x` | `float`: The X coordinate of the center of the hotspot <br /> |
| `y` | `float`: The Y coordinate of the center of the hotspot <br /> |

### setHotspotBounds

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `left` | `int`: position in pixels of the left bound <br /> |
| `top` | `int`: position in pixels of the top bound <br /> |
| `right` | `int`: position in pixels of the right bound <br /> |
| `bottom` | `int`: position in pixels of the bottom bound <br /> |

### 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)`

<br />

<br />

| Parameters ||
|---|---|
| `blendMode` | `BlendMode`: This value cannot be `null`. <br /> |

### setTintList

Added in [API level 21](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.

<br />

<br />

| Parameters ||
|---|---|
| `tint` | `ColorStateList`: Color state list to use for tinting this drawable, or `null` to clear the tint <br /> |

### setVisible

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `visible` | `boolean`: Set to true if visible, false if not. <br /> |
| `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. <br /> |

| Returns ||
|---|---|
| `boolean` | boolean Returns true if the new visibility is different than its previous state. <br /> |

### start

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void start ()
```

Starts the drawable's animation.

<br />

### stop

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void stop ()
```

Stops the drawable's animation.

<br />

### unregisterAnimationCallback

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean unregisterAnimationCallback (Animatable2.AnimationCallback callback)
```

Removes the specified animation callback.

<br />

| Parameters ||
|---|---|
| `callback` | `Animatable2.AnimationCallback`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `false` if callback didn't exist in the call back list, or `true` if callback has been removed successfully. <br /> |

## Protected methods

### onBoundsChange

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `bounds` | `Rect`: This value cannot be `null`. <br /> |

### onLevelChange

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `level` | `int` <br /> |

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

### onStateChange

Added in [API level 21](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.

<br />

| Parameters ||
|---|---|
| `state` | `int`: This value cannot be `null`. <br /> |

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