Android Dev Summit, October 23-24: two days of technical content, directly from the Android team. Sign-up for livestream updates.

VectorDrawableCompat

open class VectorDrawableCompat : VectorDrawableCommon
androidx.vectordrawable.graphics.drawable.VectorDrawableCompat

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(Resources, XmlPullParser, AttributeSet, Theme).

Summary

Public methods

open Boolean

open static VectorDrawableCompat?
create(@NonNull res: Resources, @DrawableRes resId: Int, @Nullable theme: Theme?)

Create a VectorDrawableCompat object.

open static VectorDrawableCompat!
createFromXmlInner(r: Resources!, parser: XmlPullParser!, attrs: AttributeSet!, theme: Theme!)

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

open Unit
draw(canvas: Canvas!)

open Int

open Int

open ColorFilter!

open ConstantState!

open Int

open Int

open Int

open Unit
inflate(res: Resources!, parser: XmlPullParser!, attrs: AttributeSet!)

open Unit
inflate(res: Resources!, parser: XmlPullParser!, attrs: AttributeSet!, theme: Theme!)

open Unit

open Boolean

open Boolean

open Drawable!

open Unit
scheduleSelf(what: Runnable!, when: Long)

open Unit
setAlpha(alpha: Int)

open Unit

open Unit
setColorFilter(colorFilter: ColorFilter!)

open Unit
setTint(tint: Int)

open Unit

open Unit
setTintMode(tintMode: Mode!)

open Boolean
setVisible(visible: Boolean, restart: Boolean)

open Unit

Protected methods

open Unit
onBoundsChange(bounds: Rect!)

open Boolean
onStateChange(stateSet: IntArray!)

Public methods

canApplyTheme

open fun canApplyTheme(): Boolean

create

@Nullable open static fun create(@NonNull res: Resources, @DrawableRes resId: Int, @Nullable theme: Theme?): VectorDrawableCompat?

Create a VectorDrawableCompat object.

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

createFromXmlInner

open static fun createFromXmlInner(r: Resources!, parser: XmlPullParser!, attrs: AttributeSet!, theme: Theme!): VectorDrawableCompat!

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

open fun draw(canvas: Canvas!): Unit

getAlpha

open fun getAlpha(): Int

getChangingConfigurations

open fun getChangingConfigurations(): Int

getColorFilter

open fun getColorFilter(): ColorFilter!

getConstantState

open fun getConstantState(): ConstantState!

getIntrinsicHeight

open fun getIntrinsicHeight(): Int

getIntrinsicWidth

open fun getIntrinsicWidth(): Int

getOpacity

open fun getOpacity(): Int

inflate

open fun inflate(res: Resources!, parser: XmlPullParser!, attrs: AttributeSet!): Unit

inflate

open fun inflate(res: Resources!, parser: XmlPullParser!, attrs: AttributeSet!, theme: Theme!): Unit

invalidateSelf

open fun invalidateSelf(): Unit

isAutoMirrored

open fun isAutoMirrored(): Boolean

isStateful

open fun isStateful(): Boolean

mutate

open fun mutate(): Drawable!

scheduleSelf

open fun scheduleSelf(what: Runnable!, when: Long): Unit

setAlpha

open fun setAlpha(alpha: Int): Unit

setAutoMirrored

open fun setAutoMirrored(mirrored: Boolean): Unit

setColorFilter

open fun setColorFilter(colorFilter: ColorFilter!): Unit

setTint

open fun setTint(tint: Int): Unit

setTintList

open fun setTintList(tint: ColorStateList!): Unit

setTintMode

open fun setTintMode(tintMode: Mode!): Unit

setVisible

open fun setVisible(visible: Boolean, restart: Boolean): Boolean

unscheduleSelf

open fun unscheduleSelf(what: Runnable!): Unit

Protected methods

onBoundsChange

protected open fun onBoundsChange(bounds: Rect!): Unit

onStateChange

protected open fun onStateChange(stateSet: IntArray!): Boolean