CacheDrawScope

Kotlin |Java

class CacheDrawScope : Density

kotlin.Any
↳	androidx.compose.ui.draw.CacheDrawScope

Handle to a drawing environment that enables caching of content based on the resolved size. Consumers define parameters and refer to them in the captured draw callback provided in onDrawBehind or onDrawWithContent.

onDrawBehind will draw behind the layout's drawing contents however, onDrawWithContent will provide the ability to draw before or after the layout's contents

Summary

Public methods
DrawResult	`onDrawBehind(block: DrawScope.() -> Unit)` Issue drawing commands to be executed before the layout content is drawn
DrawResult	`onDrawWithContent(block: ContentDrawScope.() -> Unit)` Issue drawing commands before or after the layout's drawing contents

Inherited functions

From class Density

`Int`	`roundToPx()` Convert Dp to Int by rounding
`Int`	`roundToPx()` Convert Sp to Int by rounding
`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
`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 DpRect 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

Properties
Float	`density` The logical density of the display.
Float	`fontScale` Current user preference for the scaling factor for fonts.
LayoutDirection	`layoutDirection` Provides the LayoutDirection.
Size	`size` Provides the dimensions of the current drawing environment

Public methods

onDrawBehind

fun onDrawBehind(block: DrawScope.() -> Unit): DrawResult

Issue drawing commands to be executed before the layout content is drawn

onDrawWithContent

fun onDrawWithContent(block: ContentDrawScope.() -> Unit): DrawResult

Issue drawing commands before or after the layout's drawing contents

Properties

density

val density: Float

The logical density of the display. This is a scaling factor for the Dp unit.

fontScale

val fontScale: Float

Current user preference for the scaling factor for fonts.

layoutDirection

val layoutDirection: LayoutDirection

Provides the LayoutDirection.

size

val size: Size

Provides the dimensions of the current drawing environment