Added in API level 21

VectorDrawable


open class VectorDrawable : Drawable

This lets you create a drawable based on an XML vector graphic.

Note: To optimize for the re-drawing performance, one bitmap cache is created for each VectorDrawable. Therefore, referring to the same VectorDrawable 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.

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

The vector drawable 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 supports all the dimension units, normally specified with dp.
android:height
Used to define the intrinsic height of the drawable. This supports 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.0.
<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. May be a color or, for SDK 24+, a color state list or a gradient color (See android.R.styleable#GradientColor and android.R.styleable#GradientColorItem). 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. May be a color or, for SDK 24+, a color state list or a gradient color (See android.R.styleable#GradientColor and android.R.styleable#GradientColorItem). 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
For SDK 24+, 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.
Animatable : No.
android:pathData
Defines clip path using the same format as "d" attribute in the SVG's path data.
Animatable : Yes.
  • Here is a simple VectorDrawable in this vectordrawable.xml file.
    <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>
      
  • 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.

    All of the attributes are listed in android.R.styleable#GradientColor. 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 android.R.styleable#GradientColorItem is defined, then startColor, centerColor and endColor will be ignored.

    See more details in android.R.styleable#GradientColor and android.R.styleable#GradientColorItem.

    Here is a simple example that defines a linear gradient.
    <gradient xmlns:android="http://schemas.android.com/apk/res/android"
          android:startColor="?android:attr/colorPrimary"
          android:endColor="?android:attr/colorControlActivated"
          android:centerColor="#f00"
          android:startX="0"
          android:startY="0"
          android:endX="100"
          android:endY="100"
          android:type="linear">
      </gradient>
      
    And here is a simple example that defines a radial gradient using color items.
    <gradient xmlns:android="http://schemas.android.com/apk/res/android"
          android:centerX="300"
          android:centerY="300"
          android:gradientRadius="100"
          android:type="radial">
          <item android:offset="0.1" android:color="#0ff"/>
          <item android:offset="0.4" android:color="#fff"/>
          <item android:offset="0.9" android:color="#ff0"/>
      </gradient>
      

    Summary

    Public constructors

    Public methods
    open Unit

    open Boolean

    open Unit
    draw(canvas: Canvas)

    open Int

    open Int

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

    open ColorFilter?

    open Drawable.ConstantState?

    open Int

    open Int

    open Int

    open Insets

    open Boolean

    open Unit
    inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)

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

    open Boolean

    open Boolean

    open Drawable

    open Unit
    setAlpha(alpha: Int)

    open Unit

    open Unit
    setColorFilter(colorFilter: ColorFilter?)

    open Unit

    Specifies a tint blending mode for this drawable.

    open Unit

    Protected methods
    open Boolean

    Inherited functions
    Unit clearColorFilter()

    Removes the color filter for this drawable.

    Rect copyBounds()

    Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).

    Unit copyBounds(bounds: Rect)

    Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.

    Drawable? createFromPath(pathName: String!)

    Create a drawable from file path name.

    Drawable? createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)

    Create a drawable from an inputstream, using the given resources and value to determine density information.

    Drawable? createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)

    Create a drawable from an inputstream, using the given resources and value to determine density information.

    Drawable? createFromStream(is: InputStream?, srcName: String?)

    Create a drawable from an inputstream

    Drawable createFromXml(r: Resources, parser: XmlPullParser)

    Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.

    Drawable createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)

    Create a drawable from an XML document using an optional Theme. For more information on how to create resources in XML, see Drawable Resources.

    Drawable createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)

    Create from inside an XML document. 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.

    Drawable createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)

    Create a drawable 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.

    Rect getBounds()

    Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.

    Drawable.Callback? getCallback()

    Return the current Callback implementation attached to this Drawable.

    Drawable getCurrent()

    Rect getDirtyBounds()

    Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed).

    By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.

    Unit getHotspotBounds(outRect: Rect)

    Populates outRect with the hotspot bounds.

    Int getLayoutDirection()

    Returns the resolved layout direction for this Drawable.

    Int getLevel()

    Retrieve the current level.

    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.

    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.

    Unit getOutline(outline: Outline)

    Called to get the drawable to populate the Outline that defines its drawing area.

    This method is called by the default 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.

    Boolean getPadding(padding: Rect)

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

    IntArray getState()

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

    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.

    Unit inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)

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

    Unit invalidateSelf()

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

    Boolean isFilterBitmap()

    Boolean isProjected()

    Whether this drawable requests projection. Indicates that the android.graphics.RenderNode this Drawable will draw into should be drawn immediately after the closest ancestor RenderNode containing a projection receiver.

    Boolean isVisible()

    Unit jumpToCurrentState()

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

    Unit onBoundsChange(bounds: Rect)

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

    Boolean onLayoutDirectionChanged(layoutDirection: Int)

    Called when the drawable's resolved layout direction changes.

    Boolean onLevelChange(level: Int)

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

    Int resolveOpacity(op1: Int, op2: Int)

    Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned.

    This is to help in implementing getOpacity.

    Unit scheduleSelf(what: Runnable, when: Long)

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

    Unit setBounds(bounds: Rect)

    Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.

    Unit setBounds(left: Int, top: Int, right: Int, bottom: Int)

    Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.

    Unit setCallback(cb: Drawable.Callback?)

    Bind a Callback object to this Drawable. Required for clients that want to support animated drawables.

    Unit setChangingConfigurations(configs: Int)

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

    Unit setColorFilter(color: Int, mode: PorterDuff.Mode)

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

    Convenience for setColorFilter(android.graphics.ColorFilter) which constructs a PorterDuffColorFilter.

    Note: Setting a color filter disables tint.

    Unit setDither(dither: Boolean)

    Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.

    Unit setFilterBitmap(filter: Boolean)

    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.

    Unit setHotspot(x: Float, y: Float)

    Specifies the hotspot's location within the drawable.

    Unit setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)

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

    Boolean setLayoutDirection(layoutDirection: Int)

    Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.

    Boolean setLevel(level: Int)

    Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level.

    If the new level 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.

    Boolean setState(stateSet: IntArray)

    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: [android.R.attr#state_focused, android.R.attr#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.

    Unit setTint(tintColor: Int)

    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,android.graphics.PorterDuff.Mode).

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

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

    Unit setTintMode(tintMode: PorterDuff.Mode?)

    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 PorterDuff.Mode.SRC_IN.

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

    Boolean setVisible(visible: Boolean, restart: Boolean)

    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.

    Unit unscheduleSelf(what: Runnable)

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

    Public constructors

    VectorDrawable

    Added in API level 21
    VectorDrawable()

    Public methods

    applyTheme

    Added in API level 21
    open fun applyTheme(t: Resources.Theme): Unit
    Parameters
    t Resources.Theme: the theme to apply This value cannot be null.

    canApplyTheme

    Added in API level 21
    open fun canApplyTheme(): Boolean

    draw

    Added in API level 21
    open fun draw(canvas: Canvas): Unit
    Parameters
    canvas Canvas: The canvas to draw into This value cannot be null.

    getAlpha

    Added in API level 21
    open fun getAlpha(): Int
    Return
    Int Value is between 0 and 255 inclusive

    getColorFilter

    Added in API level 21
    open fun getColorFilter(): ColorFilter?
    Return
    ColorFilter? the current color filter, or null if none set

    getConstantState

    Added in API level 21
    open fun getConstantState(): Drawable.ConstantState?
    Return
    Drawable.ConstantState? The ConstantState associated to that Drawable. This value may be null.

    getIntrinsicHeight

    Added in API level 21
    open fun getIntrinsicHeight(): Int
    Return
    Int the intrinsic height, or -1 if no intrinsic height

    getIntrinsicWidth

    Added in API level 21
    open fun getIntrinsicWidth(): Int
    Return
    Int the intrinsic width, or -1 if no intrinsic width

    getOpticalInsets

    Added in API level 29
    open fun getOpticalInsets(): Insets
    Return
    Insets This value cannot be null.

    hasFocusStateSpecified

    Added in API level 31
    open fun hasFocusStateSpecified(): Boolean
    Return
    Boolean true if android.R.attr#state_focused is specified for this drawable.

    inflate

    Added in API level 21
    open fun inflate(
        r: Resources,
        parser: XmlPullParser,
        attrs: AttributeSet,
        theme: Resources.Theme?
    ): Unit

    Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource.

    Parameters
    r Resources: This value cannot be null.
    parser XmlPullParser: This value cannot be null.
    attrs AttributeSet: This value cannot be null.
    theme Resources.Theme?: This value may be null.
    Exceptions
    org.xmlpull.v1.XmlPullParserException
    java.io.IOException

    isAutoMirrored

    Added in API level 21
    open fun isAutoMirrored(): Boolean
    Return
    Boolean boolean Returns true if this Drawable will be automatically mirrored.

    isStateful

    Added in API level 21
    open fun isStateful(): Boolean
    Return
    Boolean True if this drawable changes its appearance based on state, false otherwise.

    mutate

    Added in API level 21
    open fun mutate(): Drawable
    Return
    Drawable This drawable. This value cannot be null.

    setAlpha

    Added in API level 21
    open fun setAlpha(alpha: Int): Unit
    Parameters
    alpha Int: Value is between 0 and 255 inclusive

    setAutoMirrored

    Added in API level 21
    open fun setAutoMirrored(mirrored: Boolean): Unit
    Parameters
    mirrored Boolean: Set to true if the Drawable should be mirrored, false if not.

    setColorFilter

    Added in API level 21
    open fun setColorFilter(colorFilter: ColorFilter?): Unit
    Parameters
    colorFilter ColorFilter?: The color filter to apply, or null to remove the existing color filter

    setTintBlendMode

    Added in API level 29
    open fun setTintBlendMode(blendMode: BlendMode!): Unit

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

    Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter)

    Parameters
    blendMode BlendMode!: This value cannot be null.

    setTintList

    Added in API level 21
    open fun setTintList(tint: ColorStateList?): Unit
    Parameters
    tint ColorStateList?: Color state list to use for tinting this drawable, or null to clear the tint

    Protected methods

    onStateChange

    Added in API level 21
    protected open fun onStateChange(stateSet: IntArray): Boolean
    Parameters
    state This value cannot be null.
    Return
    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.