Google is committed to advancing racial equity for Black communities. See how.

Paint

interface Paint
androidx.compose.ui.graphics.Paint

Summary

Public methods
abstract NativePaint

Properties
abstract Float

Configures the alpha value between 0f to 1f representing fully transparent to fully opaque for the color drawn with this Paint

abstract BlendMode

A blend mode to apply when a shape is drawn or a layer is composited.

abstract Color

The color to use when stroking or filling a shape.

abstract ColorFilter?

A color filter to apply when a shape is drawn or when a layer is composited.

abstract FilterQuality

Controls the performance vs quality trade-off to use when applying when drawing images, as with Canvas.drawImageRect Defaults to FilterQuality.None.

abstract Boolean

Whether to apply anti-aliasing to lines and images drawn on the canvas.

abstract NativePathEffect?

abstract PathEffect?

Specifies the PathEffect applied to the geometry of the shape that is drawn

abstract Shader?

The shader to use when stroking or filling a shape.

abstract StrokeCap

The kind of finish to place on the end of lines drawn when style is set to PaintingStyle.Stroke.

abstract StrokeJoin

The kind of finish to place on the joins between segments.

abstract Float

The limit for miters to be drawn on segments when the join is set to StrokeJoin.Miter and the style is set to PaintingStyle.Stroke.

abstract Float

How wide to make edges drawn when style is set to PaintingStyle.Stroke.

abstract PaintingStyle

Whether to paint inside shapes, the edges of shapes, or both.

Public methods

asFrameworkPaint

abstract fun asFrameworkPaint(): NativePaint

Properties

alpha

abstract var alpha: Float

Configures the alpha value between 0f to 1f representing fully transparent to fully opaque for the color drawn with this Paint

blendMode

abstract var blendMode: BlendMode

A blend mode to apply when a shape is drawn or a layer is composited. The source colors are from the shape being drawn (e.g. from Canvas.drawPath) or layer being composited (the graphics that were drawn between the Canvas.saveLayer and Canvas.restore calls), after applying the colorFilter, if any. The destination colors are from the background onto which the shape or layer is being composited. Defaults to BlendMode.SrcOver. See also: Canvas.saveLayer, which uses its Paint's blendMode to composite the layer when Canvas.restore is called. BlendMode, which discusses the user of Canvas.saveLayer with blendMode.

color

abstract var color: Color

The color to use when stroking or filling a shape. Defaults to opaque black. See also: style, which controls whether to stroke or fill (or both). colorFilter, which overrides color. shader, which overrides color with more elaborate effects. This color is not used when compositing. To colorize a layer, use colorFilter.

colorFilter

abstract var colorFilter: ColorFilter?

A color filter to apply when a shape is drawn or when a layer is composited. See ColorFilter for details. When a shape is being drawn, colorFilter overrides color and shader.

filterQuality

abstract var filterQuality: FilterQuality

Controls the performance vs quality trade-off to use when applying when drawing images, as with Canvas.drawImageRect Defaults to FilterQuality.None.

isAntiAlias

abstract var isAntiAlias: Boolean

Whether to apply anti-aliasing to lines and images drawn on the canvas. Defaults to true.

nativePathEffect

abstract var nativePathEffect: NativePathEffect?

Deprecated.

pathEffect

abstract var pathEffect: PathEffect?

Specifies the PathEffect applied to the geometry of the shape that is drawn

shader

abstract var shader: Shader?

The shader to use when stroking or filling a shape.

When this is null, the color is used instead.

See also: LinearGradientShader, RadialGradientShader, or SweepGradientShader shaders that paint a color gradient. ImageShader, a shader that tiles an ImageBitmap. colorFilter, which overrides shader. color, which is used if shader and colorFilter are null.

strokeCap

abstract var strokeCap: StrokeCap

The kind of finish to place on the end of lines drawn when style is set to PaintingStyle.Stroke. Defaults to StrokeCap.Butt, i.e. no caps.

strokeJoin

abstract var strokeJoin: StrokeJoin

The kind of finish to place on the joins between segments. This applies to paths drawn when style is set to PaintingStyle.Stroke, It does not apply to points drawn as lines with Canvas.drawPoints. Defaults to StrokeJoin.Miter, i.e. sharp corners. See also strokeMiterLimit to control when miters are replaced by bevels.

strokeMiterLimit

abstract var strokeMiterLimit: Float

The limit for miters to be drawn on segments when the join is set to StrokeJoin.Miter and the style is set to PaintingStyle.Stroke. If this limit is exceeded, then a StrokeJoin.Bevel join will be drawn instead. This may cause some 'popping' of the corners of a path if the angle between line segments is animated. This limit is expressed as a limit on the length of the miter. Defaults to 4.0. Using zero as a limit will cause a StrokeJoin.Bevel join to be used all the time.

strokeWidth

abstract var strokeWidth: Float

How wide to make edges drawn when style is set to PaintingStyle.Stroke. The width is given in logical pixels measured in the direction orthogonal to the direction of the path. Defaults to 0.0, which correspond to a hairline width.

style

abstract var style: PaintingStyle

Whether to paint inside shapes, the edges of shapes, or both. Defaults to PaintingStyle.Fill.