Skip to content

Most visited

Recently visited

navigation

VectorDrawableCompat

public class VectorDrawableCompat
extends Drawable

java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.support.graphics.drawable.VectorDrawableCompat


For API 24 and above, this class is delegating to the framework's VectorDrawable. For older API version, this class lets you create a drawable based on an XML vector graphic.

You can always create a VectorDrawableCompat object and use it as a Drawable by the Java API. In order to refer to VectorDrawableCompat inside a XML file, you can use app:srcCompat attribute in AppCompat library's ImageButton or ImageView.

Note: To optimize for the re-drawing performance, one bitmap cache is created for each VectorDrawableCompat. Therefore, referring to the same VectorDrawableCompat means sharing the same bitmap cache. If these references don't agree upon on the same size, the bitmap will be recreated and redrawn every time size is changed. In other words, if a VectorDrawable is used for different sizes, it is more efficient to create multiple VectorDrawables, one for each size.

VectorDrawableCompat can be defined in an XML file with the <vector> element.

The VectorDrawableCompat has the following elements:

<vector>
Used to define a vector drawable
android:name
Defines the name of this vector drawable.
Animatable : No.
android:width
Used to define the intrinsic width of the drawable. This support all the dimension units, normally specified with dp.
Animatable : No.
android:height
Used to define the intrinsic height the drawable. This support all the dimension units, normally specified with dp.
Animatable : No.
android:viewportWidth
Used to define the width of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.
Animatable : No.
android:viewportHeight
Used to define the height of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.
Animatable : No.
android:tint
The color to apply to the drawable as a tint. By default, no tint is applied.
Animatable : No.
android:tintMode
The Porter-Duff blending mode for the tint color. The default value is src_in.
Animatable : No.
android:autoMirrored
Indicates if the drawable needs to be mirrored when its layout direction is RTL (right-to-left).
Animatable : No.
android:alpha
The opacity of this drawable.
Animatable : Yes.
<group>
Defines a group of paths or subgroups, plus transformation information. The transformations are defined in the same coordinates as the viewport. And the transformations are applied in the order of scale, rotate then translate.
android:name
Defines the name of the group.
Animatable : No.
android:rotation
The degrees of rotation of the group.
Animatable : Yes.
android:pivotX
The X coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space.
Animatable : Yes.
android:pivotY
The Y coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space.
Animatable : Yes.
android:scaleX
The amount of scale on the X Coordinate.
Animatable : Yes.
android:scaleY
The amount of scale on the Y coordinate.
Animatable : Yes.
android:translateX
The amount of translation on the X coordinate. This is defined in the viewport space.
Animatable : Yes.
android:translateY
The amount of translation on the Y coordinate. This is defined in the viewport space.
Animatable : Yes.
<path>
Defines paths to be drawn.
android:name
Defines the name of the path.
Animatable : No.
android:pathData
Defines path data using exactly same format as "d" attribute in the SVG's path data. This is defined in the viewport space.
Animatable : Yes.
android:fillColor
Specifies the color used to fill the path. If this property is animated, any value set by the animation will override the original value. No path fill is drawn if this property is not specified.
Animatable : Yes.
android:strokeColor
Specifies the color used to draw the path outline. If this property is animated, any value set by the animation will override the original value. No path outline is drawn if this property is not specified.
Animatable : Yes.
android:strokeWidth
The width a path stroke.
Animatable : Yes.
android:strokeAlpha
The opacity of a path stroke.
Animatable : Yes.
android:fillAlpha
The opacity to fill the path with.
Animatable : Yes.
android:trimPathStart
The fraction of the path to trim from the start, in the range from 0 to 1.
Animatable : Yes.
android:trimPathEnd
The fraction of the path to trim from the end, in the range from 0 to 1.
Animatable : Yes.
android:trimPathOffset
Shift trim region (allows showed region to include the start and end), in the range from 0 to 1.
Animatable : Yes.
android:strokeLineCap
Sets the linecap for a stroked path: butt, round, square.
Animatable : No.
android:strokeLineJoin
Sets the lineJoin for a stroked path: miter,round,bevel.
Animatable : No.
android:strokeMiterLimit
Sets the Miter limit for a stroked path.
Animatable : No.
<clip-path>
Defines path to be the current clip. Note that the clip path only apply to the current group and its children.
android:name
Defines the name of the clip path.
Animatable : No.
android:pathData
Defines clip path using the same format as "d" attribute in the SVG's path data.
Animatable : Yes.

Summary

Public methods

void applyTheme(Resources.Theme t)

Applies the specified theme to this Drawable and its children.

boolean canApplyTheme()
void clearColorFilter()

Removes the color filter for this drawable.

static VectorDrawableCompat create(Resources res, int resId, Resources.Theme theme)

Create a VectorDrawableCompat object.

static VectorDrawableCompat createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

Create a VectorDrawableCompat from inside an XML document using an optional Resources.Theme.

void draw(Canvas canvas)

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

int getAlpha()

Gets the current alpha value for the drawable.

int getChangingConfigurations()

Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.

ColorFilter getColorFilter()

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

Drawable.ConstantState getConstantState()

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

Drawable getCurrent()
int getIntrinsicHeight()

Returns the drawable's intrinsic height.

int getIntrinsicWidth()

Returns the drawable's intrinsic width.

int getMinimumHeight()

Returns the minimum height suggested by this Drawable.

int getMinimumWidth()

Returns the minimum width suggested by this Drawable.

int getOpacity()

Return the opacity/transparency of this Drawable.

boolean getPadding(Rect padding)

Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.

int[] getState()

Describes the current state, as a union of primitve states, such as state_focused, state_selected, etc.

Region getTransparentRegion()

Returns a Region representing the part of the Drawable that is completely transparent.

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

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

void inflate(Resources res, XmlPullParser parser, AttributeSet attrs)

Inflate this Drawable from an XML resource.

void invalidateSelf()

Use the current Drawable.Callback implementation to have this Drawable redrawn.

boolean isAutoMirrored()

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

boolean isStateful()

Indicates whether this drawable will change its appearance based on state.

void jumpToCurrentState()

If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.

Drawable mutate()

Make this drawable mutable.

void scheduleSelf(Runnable what, long when)

Use the current Drawable.Callback implementation to have this Drawable scheduled.

void setAlpha(int alpha)

Specify an alpha value for the drawable.

void setAutoMirrored(boolean mirrored)

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

void setChangingConfigurations(int configs)

Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.

void setColorFilter(ColorFilter colorFilter)

Specify an optional color filter for the drawable.

void setColorFilter(int color, PorterDuff.Mode mode)

Specify a color and Porter-Duff mode to be the color filter for this drawable.

void setFilterBitmap(boolean filter)

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

void setHotspot(float x, float y)

Specifies the hotspot's location within the drawable.

void setHotspotBounds(int left, int top, int right, int bottom)

Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.

boolean setState(int[] stateSet)

Specify a set of states for the drawable.

void setTint(int tint)

Specifies tint color for this drawable.

void setTintList(ColorStateList tint)

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

void setTintMode(PorterDuff.Mode tintMode)

Specifies a tint blending mode for this drawable.

boolean setVisible(boolean visible, boolean restart)

Set whether this Drawable is visible.

void unscheduleSelf(Runnable what)

Use the current Drawable.Callback implementation to have this Drawable unscheduled.

Protected methods

void onBoundsChange(Rect bounds)

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

boolean onLevelChange(int level)

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

boolean onStateChange(int[] stateSet)

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

Inherited methods

From class android.graphics.drawable.Drawable
From class java.lang.Object

Public methods

applyTheme

void applyTheme (Resources.Theme t)

Applies the specified theme to this Drawable and its children.

Parameters
t Resources.Theme: the theme to apply

canApplyTheme

boolean canApplyTheme ()

Returns
boolean

clearColorFilter

void clearColorFilter ()

Removes the color filter for this drawable.

create

VectorDrawableCompat create (Resources res, 
                int resId, 
                Resources.Theme theme)

Create a VectorDrawableCompat object.

Parameters
res Resources: the resources.
resId int: the resource ID for VectorDrawableCompat object.
theme Resources.Theme: the theme of this vector drawable, it can be null.
Returns
VectorDrawableCompat a new VectorDrawableCompat or null if parsing error is found.

createFromXmlInner

VectorDrawableCompat createFromXmlInner (Resources r, 
                XmlPullParser parser, 
                AttributeSet attrs, 
                Resources.Theme theme)

Create a VectorDrawableCompat from inside an XML document using an optional Resources.Theme. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.

Parameters
r Resources
parser XmlPullParser
attrs AttributeSet
theme Resources.Theme
Returns
VectorDrawableCompat
Throws
XmlPullParserException
IOException

draw

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

getAlpha

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

getChangingConfigurations

int getChangingConfigurations ()

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

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

getColorFilter

ColorFilter getColorFilter ()

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

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

getConstantState

Drawable.ConstantState getConstantState ()

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

Returns
Drawable.ConstantState The ConstantState associated to that Drawable.

getCurrent

Drawable getCurrent ()

Returns
Drawable The current drawable that will be used by this drawable. For simple drawables, this is just the drawable itself. For drawables that change state like StateListDrawable and LevelListDrawable this will be the child drawable currently in use.

getIntrinsicHeight

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

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

getMinimumHeight

int getMinimumHeight ()

Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.

Returns
int The minimum height suggested by this Drawable. If this Drawable doesn't have a suggested minimum height, 0 is returned.

getMinimumWidth

int getMinimumWidth ()

Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.

Returns
int The minimum width suggested by this Drawable. If this Drawable doesn't have a suggested minimum width, 0 is returned.

getOpacity

int getOpacity ()

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

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

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

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

Returns
int int The opacity class of the Drawable.

getPadding

boolean getPadding (Rect padding)

Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).

Parameters
padding Rect
Returns
boolean true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

getState

int[] getState ()

Describes the current state, as a union of primitve states, such as state_focused, state_selected, etc. Some drawables may modify their imagery based on the selected state.

Returns
int[] An array of resource Ids describing the current state.

getTransparentRegion

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
Region Returns null if the Drawables has no transparent region to report, else a Region holding the parts of the Drawable's bounds that are transparent.

inflate

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.

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

inflate

void inflate (Resources res, 
                XmlPullParser parser, 
                AttributeSet attrs)

Inflate this Drawable from an XML resource. Does not apply a theme.

Parameters
res Resources
parser XmlPullParser
attrs AttributeSet
Throws
XmlPullParserException
IOException

invalidateSelf

void invalidateSelf ()

Use the current Drawable.Callback implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.

isAutoMirrored

boolean isAutoMirrored ()

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

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

isStateful

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

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

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
Drawable This drawable.

scheduleSelf

void scheduleSelf (Runnable what, 
                long when)

Use the current Drawable.Callback implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.

Parameters
what Runnable: The action being scheduled.
when long: The time (in milliseconds) to run.

setAlpha

void setAlpha (int alpha)

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

Parameters
alpha int

setAutoMirrored

void setAutoMirrored (boolean mirrored)

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

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

setChangingConfigurations

void setChangingConfigurations (int configs)

Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.

Parameters
configs int: A mask of the changing configuration parameters, as defined by ActivityInfo.

setColorFilter

void setColorFilter (ColorFilter colorFilter)

Specify an optional color filter for the drawable.

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

Pass null to remove any existing color filter.

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

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

setColorFilter

void setColorFilter (int color, 
                PorterDuff.Mode mode)

Specify a color and Porter-Duff mode to be the color filter for this drawable.

Convenience for setColorFilter(ColorFilter) which constructs a PorterDuffColorFilter.

Note: Setting a color filter disables tint.

Parameters
color int
mode PorterDuff.Mode

setFilterBitmap

void setFilterBitmap (boolean filter)

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

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

Parameters
filter boolean

setHotspot

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

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

setState

boolean setState (int[] stateSet)

Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [state_focused, state_pressed].

If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf() in order to have itself redrawn, and true will be returned from this function.

Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.

Parameters
stateSet int: The new set of states to be displayed.
Returns
boolean Returns true if this change in state has caused the appearance of the Drawable to change (hence requiring an invalidate), otherwise returns false.

setTint

void setTint (int tint)

Specifies tint color for this drawable.

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

To clear the tint, pass null to setTintList(ColorStateList).

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

Parameters
tint int: Color to use for tinting this drawable

setTintList

void setTintList (ColorStateList tint)

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

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

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

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

setTintMode

void setTintMode (PorterDuff.Mode tintMode)

Specifies a tint blending mode for this drawable.

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

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

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

setVisible

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.

unscheduleSelf

void unscheduleSelf (Runnable what)

Use the current Drawable.Callback implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

Parameters
what Runnable: The runnable that you no longer want called.

Protected methods

onBoundsChange

void onBoundsChange (Rect bounds)

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

Parameters
bounds Rect

onLevelChange

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

boolean onStateChange (int[] stateSet)

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

Parameters
stateSet int
Returns
boolean Returns true if the state change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last state.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.