AndroidPaint


Create a Compose Paint instance backed by an android.graphics.Paint object to be consumed by Compose applications running on the Android platform

Summary

Public constructors

Create a new AndroidPaint instance backed by a newly created android.graphics.Paint

android
AndroidPaint(internalPaint: Paint)
android

Public functions

open Paint
android

Public properties

open Float

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

android
open BlendMode

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

android
open Color

The color to use when stroking or filling a shape.

android
open ColorFilter?

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

android
open FilterQuality

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

android
open Boolean

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

android
open PathEffect?

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

android
open Shader?

The shader to use when stroking or filling a shape.

android
open StrokeCap

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

android
open StrokeJoin

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

android
open 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.

android
open Float

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

android
open PaintingStyle

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

android

Public constructors

AndroidPaint

AndroidPaint()

Create a new AndroidPaint instance backed by a newly created android.graphics.Paint

AndroidPaint

AndroidPaint(internalPaint: Paint)
Parameters
internalPaint: Paint

android.graphics.Paint to be wrapped by the AndroidPaint instance

Public functions

asFrameworkPaint

open fun asFrameworkPaint(): Paint

Public properties

alpha

open var alphaFloat

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

blendMode

open var blendModeBlendMode

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

open var colorColor

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

open var colorFilterColorFilter?

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

open var filterQualityFilterQuality

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

isAntiAlias

open var isAntiAliasBoolean

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

pathEffect

open var pathEffectPathEffect?

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

shader

open var shaderShader?

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

open var strokeCapStrokeCap

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

open var strokeJoinStrokeJoin

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

open var strokeMiterLimitFloat

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

open var strokeWidthFloat

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

open var stylePaintingStyle

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