Skip to content

Most visited

Recently visited

navigation

VectorDrawable

public class VectorDrawable
extends Drawable

java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.VectorDrawable


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.
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. May be a color or, for SDK 24+, a color state list or a gradient color (See GradientColor and 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.
Animatable : Yes.
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 GradientColor and 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.
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.
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. For more details, see FillRuleProperty
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.
  • 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>
     
  • And here is an example of linear gradient color, which is supported in SDK 24+. See more details in GradientColor and GradientColorItem.
     <gradient xmlns:android="http://schemas.android.com/apk/res/android"
         android:angle="90"
         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>
     
  • Summary

    Public constructors

    VectorDrawable()

    Public methods

    void applyTheme(Resources.Theme t)

    Applies the specified theme to this Drawable and its children.

    boolean canApplyTheme()
    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.

    int getIntrinsicHeight()

    Returns the drawable's intrinsic height.

    int getIntrinsicWidth()

    Returns the drawable's intrinsic width.

    int getOpacity()

    Return the opacity/transparency of this Drawable.

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

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

    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.

    Drawable mutate()

    Make this drawable mutable.

    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 setColorFilter(ColorFilter colorFilter)

    Specify an optional color filter for the 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.

    Protected methods

    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 constructors

    VectorDrawable

    Added in API level 21
    VectorDrawable ()

    Public methods

    applyTheme

    Added in API level 21
    void applyTheme (Resources.Theme t)

    Applies the specified theme to this Drawable and its children.

    Parameters
    t Resources.Theme: the theme to apply

    canApplyTheme

    Added in API level 21
    boolean canApplyTheme ()

    Returns
    boolean

    draw

    Added in API level 21
    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

    Added in API level 21
    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

    Added in API level 21
    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

    Added in API level 21
    ColorFilter getColorFilter ()

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

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

    getConstantState

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

    getIntrinsicHeight

    Added in API level 21
    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

    Added in API level 21
    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

    getOpacity

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

    inflate

    Added in API level 21
    void inflate (Resources r, 
                    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
    r 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

    isAutoMirrored

    Added in API level 21
    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

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

    mutate

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

    setAlpha

    Added in API level 21
    void setAlpha (int alpha)

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

    Parameters
    alpha int

    setAutoMirrored

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

    setColorFilter

    Added in API level 21
    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

    setTintList

    Added in API level 21
    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

    Added in API level 21
    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

    Protected methods

    onStateChange

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