VectorDrawableCompat


public class VectorDrawableCompat extends Drawable


For API 24 and above, this class delegates 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.

android:width

Used to define the intrinsic width of the drawable. This support all the dimension units, normally specified with dp.

android:height

Used to define the intrinsic height the drawable. This support all the dimension units, normally specified with dp.

android:viewportWidth

Used to define the width of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.

android:viewportHeight

Used to define the height of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.

android:tint

The color to apply to the drawable as a tint. By default, no tint is applied.

android:tintMode

The Porter-Duff blending mode for the tint color. Default is src_in.

android:autoMirrored

Indicates if the drawable needs to be mirrored when its layout direction is RTL (right-to-left). Default is false.

android:alpha

The opacity of this drawable. Default is 1.

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

android:rotation

The degrees of rotation of the group. Default is 0.

android:pivotX

The X coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space. Default is 0.

android:pivotY

The Y coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space. Default is 0.

android:scaleX

The amount of scale on the X Coordinate. Default is 1.

android:scaleY

The amount of scale on the Y coordinate. Default is 1.

android:translateX

The amount of translation on the X coordinate. This is defined in the viewport space. Default is 0.

android:translateY

The amount of translation on the Y coordinate. This is defined in the viewport space. Default is 0.

<path>

Defines paths to be drawn.

android:name

Defines the name of the path.

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.

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.

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.

android:strokeWidth

The width a path stroke. Default is 0.

android:strokeAlpha

The opacity of a path stroke. Default is 1.

android:fillAlpha

The opacity to fill the path with. Default is 1.

android:trimPathStart

The fraction of the path to trim from the start, in the range from 0 to 1. Default is 0.

android:trimPathEnd

The fraction of the path to trim from the end, in the range from 0 to 1. Default is 1.

android:trimPathOffset

Shift trim region (allows showed region to include the start and end), in the range from 0 to 1. Default is 0.

android:strokeLineCap

Sets the linecap for a stroked path: butt, round, square. Default is butt.

android:strokeLineJoin

Sets the lineJoin for a stroked path: miter,round,bevel. Default is miter.

android:strokeMiterLimit

Sets the Miter limit for a stroked path. Default is 4.

android:fillType

Sets the fillType for a path. The types can be either "evenOdd" or "nonZero". They behave the same as SVG's "fill-rule" properties. Default is nonZero. For more details, see FillRuleProperty

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

android:pathData

Defines clip path using the same format as "d" attribute in the SVG's path data.
Gradient support We support 3 types of gradients: android.graphics.LinearGradient, android.graphics.RadialGradient, or android.graphics.SweepGradient. And we support all of 3 types of tile modes android.graphics.Shader.TileMode: CLAMP, REPEAT, MIRROR. Note that different attributes are relevant for different types of gradient.
LinearGradient RadialGradient SweepGradient
startColor startColor startColor
centerColor centerColor centerColor
endColor endColor endColor
type type type
tileMode tileMode tileMode
startX centerX centerX
startY centerY centerY
endX gradientRadius
endY
Also note that if any color item is defined, then startColor, centerColor and endColor will be ignored. Note that theme attributes in XML file are supported through inflate.

Summary

Public methods

void
boolean
void
static @Nullable VectorDrawableCompat
create(
    @NonNull Resources res,
    @DrawableRes int resId,
    @Nullable Resources.Theme theme
)

Create a VectorDrawableCompat object.

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

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

void
draw(@NonNull Canvas canvas)
int
int
@Nullable ColorFilter
@NonNull Drawable.ConstantState
Drawable
int
int
int
int
int

This method is deprecated.

boolean
getPadding(Rect padding)
int[]
Region
void
inflate(
    @NonNull Resources res,
    @NonNull XmlPullParser parser,
    @NonNull AttributeSet attrs
)
void
inflate(
    @NonNull Resources res,
    @NonNull XmlPullParser parser,
    @NonNull AttributeSet attrs,
    @Nullable Resources.Theme theme
)
void
boolean
boolean
void
@NonNull Drawable
void
scheduleSelf(@NonNull Runnable what, long when)
void
setAlpha(int alpha)
void
setAutoMirrored(boolean mirrored)
void
void
void
setColorFilter(int color, PorterDuff.Mode mode)

This method is deprecated.

void
setFilterBitmap(boolean filter)
void
setHotspot(float x, float y)
void
setHotspotBounds(int left, int top, int right, int bottom)
boolean
setState(int[] stateSet)
void
setTint(int tint)
void
void
boolean
setVisible(boolean visible, boolean restart)
void

Protected methods

void
boolean
onLevelChange(int level)
boolean
onStateChange(int[] stateSet)

Inherited methods

From android.graphics.drawable.Drawable
void
void
final Rect
final void
copyBounds(Rect bounds)
static Drawable
static Drawable
createFromResourceStream(
    Resources res,
    TypedValue value,
    InputStream is,
    String srcName
)
static Drawable
static Drawable
static Drawable
createFromXmlInner(
    Resources r,
    XmlPullParser parser,
    AttributeSet attrs
)
final Rect
Drawable.Callback
Drawable
Rect
void
int
final int
int
int
Insets
void
boolean
getPadding(Rect padding)
int[]
Region
boolean
boolean
boolean
final boolean
void
void
boolean
onLayoutDirectionChanged(int layoutDirection)
boolean
onLevelChange(int level)
static int
resolveOpacity(int op1, int op2)
void
setBounds(int left, int top, int right, int bottom)
final void
void
void
setDither(boolean dither)

This method is deprecated.

void
setFilterBitmap(boolean filter)
void
setHotspot(float x, float y)
void
setHotspotBounds(int left, int top, int right, int bottom)
final boolean
setLayoutDirection(int layoutDirection)
final boolean
setLevel(int level)
boolean
setState(int[] stateSet)
void

Public methods

applyTheme

public void applyTheme(@NonNull Resources.Theme t)

canApplyTheme

public boolean canApplyTheme()

clearColorFilter

public void clearColorFilter()

create

Added in 1.0.0
public static @Nullable VectorDrawableCompat create(
    @NonNull Resources res,
    @DrawableRes int resId,
    @Nullable Resources.Theme theme
)

Create a VectorDrawableCompat object.

Parameters
@NonNull Resources res

the resources.

@DrawableRes int resId

the resource ID for VectorDrawableCompat object.

@Nullable Resources.Theme theme

the theme of this vector drawable, it can be null.

Returns
@Nullable VectorDrawableCompat

a new VectorDrawableCompat or null if parsing error is found.

createFromXmlInner

Added in 1.0.0
public static @NonNull VectorDrawableCompat createFromXmlInner(
    @NonNull Resources r,
    @NonNull XmlPullParser parser,
    @NonNull AttributeSet attrs,
    @Nullable Resources.Theme theme
)

Create a VectorDrawableCompat from inside an XML document using an optional 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.

draw

Added in 1.0.0
public void draw(@NonNull Canvas canvas)

getAlpha

public int getAlpha()

getChangingConfigurations

public int getChangingConfigurations()

getColorFilter

public @Nullable ColorFilter getColorFilter()

getConstantState

public @NonNull Drawable.ConstantState getConstantState()

getCurrent

public Drawable getCurrent()

getIntrinsicHeight

public int getIntrinsicHeight()

getIntrinsicWidth

public int getIntrinsicWidth()

getMinimumHeight

public int getMinimumHeight()

getMinimumWidth

public int getMinimumWidth()

getOpacity

Added in 1.0.0
public int getOpacity()

getPadding

public boolean getPadding(Rect padding)

getState

public int[] getState()

getTransparentRegion

public Region getTransparentRegion()

inflate

public void inflate(
    @NonNull Resources res,
    @NonNull XmlPullParser parser,
    @NonNull AttributeSet attrs
)

inflate

public void inflate(
    @NonNull Resources res,
    @NonNull XmlPullParser parser,
    @NonNull AttributeSet attrs,
    @Nullable Resources.Theme theme
)

invalidateSelf

public void invalidateSelf()

isAutoMirrored

public boolean isAutoMirrored()

isStateful

public boolean isStateful()

jumpToCurrentState

public void jumpToCurrentState()

mutate

public @NonNull Drawable mutate()

scheduleSelf

public void scheduleSelf(@NonNull Runnable what, long when)

setAlpha

Added in 1.0.0
public void setAlpha(int alpha)

setAutoMirrored

public void setAutoMirrored(boolean mirrored)

setChangingConfigurations

public void setChangingConfigurations(int configs)

setColorFilter

Added in 1.0.0
public void setColorFilter(@Nullable ColorFilter colorFilter)

setColorFilter

Added in 1.0.0
public void setColorFilter(int color, PorterDuff.Mode mode)

setFilterBitmap

public void setFilterBitmap(boolean filter)

setHotspot

public void setHotspot(float x, float y)

setHotspotBounds

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

setState

public boolean setState(int[] stateSet)

setTint

public void setTint(int tint)

setTintList

public void setTintList(@Nullable ColorStateList tint)

setTintMode

public void setTintMode(@Nullable PorterDuff.Mode tintMode)

setVisible

public boolean setVisible(boolean visible, boolean restart)

unscheduleSelf

public void unscheduleSelf(@NonNull Runnable what)

Protected methods

onBoundsChange

protected void onBoundsChange(Rect bounds)

onLevelChange

protected boolean onLevelChange(int level)

onStateChange

protected boolean onStateChange(int[] stateSet)