ContentDrawScope

Kotlin |Java

abstract class ContentDrawScope : DrawScope

kotlin.Any
↳	androidx.compose.ui.graphics.drawscope.DrawScope
	↳	androidx.compose.ui.ContentDrawScope

Receiver scope for drawing content into a layout, where the content can be drawn between other canvas operations. If drawContent is not called, the contents of the layout will not be drawn.

Summary

Public constructors
<init>() Receiver scope for drawing content into a layout, where the content can be drawn between other canvas operations.

Public methods
abstract Unit	drawContent() Causes child drawing operations to run during the onPaint lambda.

Inherited functions
From class DrawScope Unit draw(canvas: Canvas, size: Size, block: DrawScope.() -> Unit) Draws into the provided Canvas with the commands specified in the lambda with this DrawScope as a receiver Unit drawArc(brush: Brush, startAngle: Float, sweepAngle: Float, useCenter: Boolean, topLeft: Offset = Offset.Zero, size: Size = this.size.offsetSize(topLeft), @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draw an arc scaled to fit inside the given rectangle. It starts from startAngle degrees around the oval up to startAngle + sweepAngle degrees around the oval, with zero degrees being the point on the right hand side of the oval that crosses the horizontal line that intersects the center of the rectangle and with positive angles going clockwise around the oval. If useCenter is true, the arc is closed back to the center, forming a circle sector. Otherwise, the arc is not closed, forming a circle segment. Unit drawArc(color: Color, startAngle: Float, sweepAngle: Float, useCenter: Boolean, topLeft: Offset = Offset.Zero, size: Size = this.size.offsetSize(topLeft), @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draw an arc scaled to fit inside the given rectangle. It starts from startAngle degrees around the oval up to startAngle + sweepAngle degrees around the oval, with zero degrees being the point on the right hand side of the oval that crosses the horizontal line that intersects the center of the rectangle and with positive angles going clockwise around the oval. If useCenter is true, the arc is closed back to the center, forming a circle sector. Otherwise, the arc is not closed, forming a circle segment. Unit drawCircle(brush: Brush, radius: Float = size.minDimension / 2.0f, center: Offset = this.center, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a circle at the provided center coordinate and radius. If no center point is provided the center of the bounds is used. Unit drawCircle(color: Color, radius: Float = size.minDimension / 2.0f, center: Offset = this.center, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a circle at the provided center coordinate and radius. If no center point is provided the center of the bounds is used. Unit drawImage(image: ImageAsset, topLeft: Offset = Offset.Zero, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws the given ImageAsset into the canvas with its top-left corner at the given Offset. The image is composited into the canvas using the given Paint. Unit drawImage(image: ImageAsset, srcOffset: IntOffset = IntOffset.Zero, srcSize: IntSize = IntSize(image.width, image.height), dstOffset: IntOffset = IntOffset.Zero, dstSize: IntSize = srcSize, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws the subset of the given image described by the src argument into the canvas in the axis-aligned rectangle given by the dst argument. If no src rect is provided, the entire image is scaled into the corresponding destination bounds Unit drawLine(brush: Brush, start: Offset, end: Offset, strokeWidth: Float = Stroke.HairlineWidth, cap: StrokeCap = Stroke.DefaultCap, pathEffect: NativePathEffect? = null, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a line between the given points using the given paint. The line is stroked. Unit drawLine(color: Color, start: Offset, end: Offset, strokeWidth: Float = Stroke.HairlineWidth, cap: StrokeCap = Stroke.DefaultCap, pathEffect: NativePathEffect? = null, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a line between the given points using the given paint. The line is stroked. Unit drawOval(brush: Brush, topLeft: Offset = Offset.Zero, size: Size = this.size.offsetSize(topLeft), @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws an oval with the given offset and size. If no offset from the top left is provided, it is drawn starting from the origin of the current translation. If no size is provided, the size of the current environment is used. Unit drawOval(color: Color, topLeft: Offset = Offset.Zero, size: Size = this.size.offsetSize(topLeft), @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws an oval with the given offset and size. If no offset from the top left is provided, it is drawn starting from the origin of the current translation. If no size is provided, the size of the current environment is used. Unit drawPath(path: Path, color: Color, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws the given Path with the given Color. Whether this shape is filled or stroked (or both) is controlled by DrawStyle. If the path is filled, then subpaths within it are implicitly closed (see Path.close). Unit drawPath(path: Path, brush: Brush, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws the given Path with the given Color. Whether this shape is filled or stroked (or both) is controlled by DrawStyle. If the path is filled, then subpaths within it are implicitly closed (see Path.close). Unit drawPoints(points: List<Offset>, pointMode: PointMode, color: Color, strokeWidth: Float = Stroke.HairlineWidth, cap: StrokeCap = StrokeCap.Butt, pathEffect: NativePathEffect? = null, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a sequence of points according to the given PointMode. The points argument is interpreted as offsets from the origin. Unit drawPoints(points: List<Offset>, pointMode: PointMode, brush: Brush, strokeWidth: Float = Stroke.HairlineWidth, cap: StrokeCap = StrokeCap.Butt, pathEffect: NativePathEffect? = null, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a sequence of points according to the given PointMode. The points argument is interpreted as offsets from the origin. Unit drawRect(brush: Brush, topLeft: Offset = Offset.Zero, size: Size = this.size.offsetSize(topLeft), @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a rectangle with the given offset and size. If no offset from the top left is provided, it is drawn starting from the origin of the current translation. If no size is provided, the size of the current environment is used. Unit drawRect(color: Color, topLeft: Offset = Offset.Zero, size: Size = this.size.offsetSize(topLeft), @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a rectangle with the given offset and size. If no offset from the top left is provided, it is drawn starting from the origin of the current translation. If no size is provided, the size of the current environment is used. Unit drawRoundRect(brush: Brush, topLeft: Offset = Offset.Zero, size: Size = this.size.offsetSize(topLeft), radius: Radius = Radius.Zero, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a rounded rectangle with the provided size, offset and radii for the x and y axis respectively. This rectangle is drawn with the provided Brush parameter and is filled or stroked based on the given DrawStyle Unit drawRoundRect(color: Color, topLeft: Offset = Offset.Zero, size: Size = this.size.offsetSize(topLeft), radius: Radius = Radius.Zero, style: DrawStyle = Fill, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, colorFilter: ColorFilter? = null, blendMode: BlendMode = DefaultBlendMode) Draws a rounded rectangle with the given Paint. Whether the rectangle is filled or stroked (or both) is controlled by Paint.style.
From class Density Dp toDp() Convert Sp to Dp. Dp toDp() Convert an Int pixel value to Dp. Dp toDp() Convert a Float pixel value to a Dp Int toIntPx() Convert Dp to Int by rounding Int toIntPx() Convert Sp to Int by rounding Float toPx() Convert Dp to pixels. Pixels are used to paint to Canvas. Float toPx() Convert Sp to pixels. Pixels are used to paint to Canvas. Rect toRect() Convert a Bounds to a Rect. TextUnit toSp() Convert Dp to Sp. Sp is used for font size, etc. TextUnit toSp() Convert an Int pixel value to Sp. TextUnit toSp() Convert a Float pixel value to a Sp

Inherited extension functions
From androidx.compose.foundation.layout Constraints Density.Constraints(dpConstraints: DpConstraints) Creates the Constraints corresponding to the current DpConstraints. DpConstraints Density.DpConstraints(constraints: Constraints) Creates the DpConstraints corresponding to the current Constraints.
From androidx.compose.ui.graphics.drawscope Unit DrawScope.clipPath(path: Path, clipOp: ClipOp = ClipOp.Intersect, block: DrawScope.() -> Unit) Reduces the clip region to the intersection of the current clip and the given path. Unit DrawScope.clipRect(left: Float = 0.0f, top: Float = 0.0f, right: Float = size.width, bottom: Float = size.height, clipOp: ClipOp = ClipOp.Intersect, block: DrawScope.() -> Unit) Reduces the clip region to the intersection of the current clip and the given rectangle indicated by the given left, top, right and bottom bounds. Unit DrawScope.drawCanvas(block: (Canvas, Size) -> Unit) Provides access to draw directly with the underlying Canvas along with the current size of the DrawScope. Unit DrawScope.drawIntoCanvas(block: (Canvas) -> Unit) Provides access to draw directly with the underlying Canvas. Unit DrawScope.inset(left: Float, top: Float, right: Float, bottom: Float, block: DrawScope.() -> Unit) Simultaneously translate the DrawScope coordinate space by left and top as well as modify the dimensions of the current painting area. Unit DrawScope.inset(inset: Float, block: DrawScope.() -> Unit) Convenience method modifies the DrawScope bounds to inset both left, top, right and bottom bounds by inset. Unit DrawScope.inset(horizontal: Float = 0.0f, vertical: Float = 0.0f, block: DrawScope.() -> Unit) Convenience method modifies the DrawScope bounds to inset both left and right bounds by horizontal as well as the top and bottom by vertical. Unit DrawScope.rotate(degrees: Float, pivotX: Float = center.x, pivotY: Float = center.y, block: DrawScope.() -> Unit) Add a rotation (in degrees clockwise) to the current transform at the given pivot point. Unit DrawScope.rotate(degrees: Float, pivot: Offset = center, block: DrawScope.() -> Unit) Add a rotation (in degrees clockwise) to the current transform at the given pivot point. Unit DrawScope.rotateRad(radians: Float, pivotX: Float = center.x, pivotY: Float = center.y, block: DrawScope.() -> Unit) Add a rotation (in radians clockwise) to the current transform at the given pivot point. Unit DrawScope.scale(scaleX: Float, scaleY: Float = scaleX, pivotX: Float = center.x, pivotY: Float = center.y, block: DrawScope.() -> Unit) Add an axis-aligned scale to the current transform, scaling by the first argument in the horizontal direction and the second in the vertical direction at the given pivot coordinate. Unit DrawScope.scale(scaleX: Float, scaleY: Float, pivot: Offset = center, block: DrawScope.() -> Unit) Add an axis-aligned scale to the current transform, scaling by the first argument in the horizontal direction and the second in the vertical direction at the given pivot coordinate. Unit DrawScope.scale(scale: Float, pivot: Offset = center, block: DrawScope.() -> Unit) Add an axis-aligned scale to the current transform, scaling both the horizontal direction and the vertical direction at the given pivot coordinate. Unit DrawScope.translate(left: Float = 0.0f, top: Float = 0.0f, block: DrawScope.() -> Unit) Translate the coordinate space by the given delta in pixels in both the x and y coordinates respectively Unit DrawScope.withTransform(transformBlock: DrawTransform.() -> Unit, drawBlock: DrawScope.() -> Unit) Perform 1 or more transformations and execute drawing commands with the specified transformations applied.
From androidx.compose.ui.graphics Unit DrawScope.drawOutline(outline: Outline, color: Color, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DrawScope.DefaultBlendMode) Draws the Outline on a DrawScope. Unit DrawScope.drawOutline(outline: Outline, brush: Brush, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DrawScope.DefaultBlendMode) Draws the Outline on a DrawScope.

Inherited properties
From class DrawScope Offset center Center of the current bounds of the drawing environment LayoutDirection layoutDirection The layout direction of the layout being drawn in. Size size Provides the dimensions of the current drawing environment
From class Density Float density The logical density of the display. This is a scaling factor for the Dp unit. Float fontScale Current user preference for the scaling factor for fonts.

Public constructors

<init>

ContentDrawScope()

Receiver scope for drawing content into a layout, where the content can be drawn between other canvas operations. If drawContent is not called, the contents of the layout will not be drawn.

See Also

• DrawModifier

Public methods

drawContent

abstract fun drawContent(): Unit

Causes child drawing operations to run during the onPaint lambda.