androidx.compose.ui.graphics.vector

Kotlin |Java

Classes

PathBuilder
PathNode	Class representing a singular path command in a vector.
PathParser
VectorApplier
VectorAsset	Vector graphics object that is generated as a result of VectorAssetBuilder It can be composed and rendered by passing it as an argument to rememberVectorPainter
VectorAssetBuilder	Builder used to construct a Vector graphic tree.
VectorGroup	Defines a group of paths or subgroups, plus transformation information.
VectorNode
VectorPainter	Painter implementation that abstracts the drawing of a Vector graphic.
VectorPath	Leaf node of a Vector graphics tree.
VNode

Top-level constants summary

const String	`DefaultGroupName`
const String	`DefaultPathName`
const Float	`DefaultPivotX`
const Float	`DefaultPivotY`
const Float	`DefaultRotation`
const Float	`DefaultScaleX`
const Float	`DefaultScaleY`
const Float	`DefaultStrokeLineMiter`
const Float	`DefaultStrokeLineWidth`
const Float	`DefaultTranslationX`
const Float	`DefaultTranslationY`
const Float	`DefaultTrimPathEnd`
const Float	`DefaultTrimPathOffset`
const Float	`DefaultTrimPathStart`
const String	`RootGroupName` Default identifier for the root group if a Vector graphic

Top-level functions summary

Unit	`Group(name: String = DefaultGroupName, rotation: Float = DefaultRotation, pivotX: Float = DefaultPivotX, pivotY: Float = DefaultPivotY, scaleX: Float = DefaultScaleX, scaleY: Float = DefaultScaleY, translationX: Float = DefaultTranslationX, translationY: Float = DefaultTranslationY, clipPathData: List<PathNode> = EmptyPath, children: () -> Unit)`
Unit	Path(pathData: List<PathNode>, pathFillType: PathFillType = DefaultFillType, name: String = DefaultPathName, fill: Brush? = null, fillAlpha: Float = 1.0f, stroke: Brush? = null, strokeAlpha: Float = 1.0f, strokeLineWidth: Float = DefaultStrokeLineWidth, strokeLineCap: StrokeCap = DefaultStrokeLineCap, strokeLineJoin: StrokeJoin = DefaultStrokeLineJoin, strokeLineMiter: Float = DefaultStrokeLineMiter, trimPathStart: Float = DefaultTrimPathStart, trimPathEnd: Float = DefaultTrimPathEnd, trimPathOffset: Float = DefaultTrimPathOffset)
List<PathNode>	`PathData(block: PathBuilder.() -> Unit)`
VectorPainter	`VectorPainter(defaultWidth: Dp, defaultHeight: Dp, viewportWidth: Float = Float.NaN, viewportHeight: Float = Float.NaN, name: String = RootGroupName, children: (viewportWidth: Float, viewportHeight: Float) -> Unit)` Create a VectorPainter with the Vector defined by the provided sub-composition
VectorPainter	`VectorPainter(asset: VectorAsset)` Create a VectorPainter with the given VectorAsset.
List<PathNode>	`addPathNodes(pathStr: String?)`
VectorPainter	`rememberVectorPainter(defaultWidth: Dp, defaultHeight: Dp, viewportWidth: Float = Float.NaN, viewportHeight: Float = Float.NaN, name: String = RootGroupName, children: (viewportWidth: Float, viewportHeight: Float) -> Unit)` Create a VectorPainter with the Vector defined by the provided sub-composition
VectorPainter	`rememberVectorPainter(asset: VectorAsset)` Create a VectorPainter with the given VectorAsset.

Top-level properties summary

PathFillType	`DefaultFillType`
StrokeCap	`DefaultStrokeLineCap`
StrokeJoin	`DefaultStrokeLineJoin`
BlendMode	`DefaultTintBlendMode`
Color	`DefaultTintColor`
List<PathNode>	`EmptyPath`

Extension functions summary

For VectorAssetBuilder
VectorAssetBuilder	`VectorAssetBuilder.group(name: String = DefaultGroupName, rotate: Float = DefaultRotation, pivotX: Float = DefaultPivotX, pivotY: Float = DefaultPivotY, scaleX: Float = DefaultScaleX, scaleY: Float = DefaultScaleY, translationX: Float = DefaultTranslationX, translationY: Float = DefaultTranslationY, clipPathData: List<PathNode> = EmptyPath, block: VectorAssetBuilder.() -> Unit)` DSL extension for adding a VectorGroup to this.
VectorAssetBuilder	`VectorAssetBuilder.path(name: String = DefaultPathName, fill: Brush? = null, fillAlpha: Float = 1.0f, stroke: Brush? = null, strokeAlpha: Float = 1.0f, strokeLineWidth: Float = DefaultStrokeLineWidth, strokeLineCap: StrokeCap = DefaultStrokeLineCap, strokeLineJoin: StrokeJoin = DefaultStrokeLineJoin, strokeLineMiter: Float = DefaultStrokeLineMiter, pathFillType: PathFillType = DefaultFillType, pathBuilder: PathBuilder.() -> Unit)` DSL extension for adding a VectorPath to this.

Top-level constants

DefaultGroupName

const val DefaultGroupName: String

Value: ""

DefaultPathName

const val DefaultPathName: String

Value: ""

DefaultPivotX

const val DefaultPivotX: Float

Value: 0.0f

DefaultPivotY

const val DefaultPivotY: Float

Value: 0.0f

DefaultRotation

const val DefaultRotation: Float

Value: 0.0f

DefaultScaleX

const val DefaultScaleX: Float

Value: 1.0f

DefaultScaleY

const val DefaultScaleY: Float

Value: 1.0f

DefaultStrokeLineMiter

const val DefaultStrokeLineMiter: Float

Value: 4.0f

DefaultStrokeLineWidth

const val DefaultStrokeLineWidth: Float

Value: 0.0f

DefaultTranslationX

const val DefaultTranslationX: Float

Value: 0.0f

DefaultTranslationY

const val DefaultTranslationY: Float

Value: 0.0f

DefaultTrimPathEnd

const val DefaultTrimPathEnd: Float

Value: 1.0f

DefaultTrimPathOffset

const val DefaultTrimPathOffset: Float

Value: 0.0f

DefaultTrimPathStart

const val DefaultTrimPathStart: Float

Value: 0.0f

RootGroupName

const val RootGroupName: String

Default identifier for the root group if a Vector graphic

Value: "VectorRootGroup"

Top-level functions

Group

@Composable fun Group(
    name: String = DefaultGroupName, 
    rotation: Float = DefaultRotation, 
    pivotX: Float = DefaultPivotX, 
    pivotY: Float = DefaultPivotY, 
    scaleX: Float = DefaultScaleX, 
    scaleY: Float = DefaultScaleY, 
    translationX: Float = DefaultTranslationX, 
    translationY: Float = DefaultTranslationY, 
    clipPathData: List<PathNode> = EmptyPath, 
    children: () -> Unit
): Unit

Path

@Composable fun Path(
    pathData: List<PathNode>, 
    pathFillType: PathFillType = DefaultFillType, 
    name: String = DefaultPathName, 
    fill: Brush? = null, 
    fillAlpha: Float = 1.0f, 
    stroke: Brush? = null, 
    strokeAlpha: Float = 1.0f, 
    strokeLineWidth: Float = DefaultStrokeLineWidth, 
    strokeLineCap: StrokeCap = DefaultStrokeLineCap, 
    strokeLineJoin: StrokeJoin = DefaultStrokeLineJoin, 
    strokeLineMiter: Float = DefaultStrokeLineMiter, 
    trimPathStart: Float = DefaultTrimPathStart, 
    trimPathEnd: Float = DefaultTrimPathEnd, 
    trimPathOffset: Float = DefaultTrimPathOffset
): Unit

PathData

inline fun PathData(block: PathBuilder.() -> Unit): List<PathNode>

VectorPainter

@Composable fun VectorPainter(
    defaultWidth: Dp, 
    defaultHeight: Dp, 
    viewportWidth: Float = Float.NaN, 
    viewportHeight: Float = Float.NaN, 
    name: String = RootGroupName, 
    children: (viewportWidth: Float, viewportHeight: Float) -> Unit
): VectorPainter

Deprecated.

Create a VectorPainter with the Vector defined by the provided sub-composition

Parameters
defaultWidth: Dp	Intrinsic width of the Vector in Dp
defaultHeight: Dp