CacheDrawScope

Added in 1.0.0

Cmn
```
class CacheDrawScope : Density
```

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 functions
`GraphicsLayer`	`obtainGraphicsLayer()` Returns a managed `GraphicsLayer` instance.	Cmn
`ShadowContext`	`obtainShadowContext()` Returns the `ShadowContext` used to create `InnerShadowPainter` and `DropShadowPainter` to render inner and drop shadows respectively	Cmn
`DrawResult`	`onDrawBehind(block: DrawScope.() -> Unit)` Issue drawing commands to be executed before the layout content is drawn	Cmn
`DrawResult`	`onDrawWithContent(block: ContentDrawScope.() -> Unit)` Issue drawing commands before or after the layout's drawing contents	Cmn
`Unit`	`GraphicsLayer.record( density: Density, layoutDirection: LayoutDirection, size: IntSize, block: ContentDrawScope.() -> Unit )` Record the drawing commands into the `GraphicsLayer` with the `Density`, `LayoutDirection` and `Size` are given from the provided `CacheDrawScope`	Cmn

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

Inherited functions

From androidx.compose.ui.unit.Density

`open Int`	`Dp.roundToPx()` Convert `Dp` to `Int` by rounding	Cmn
`open Int`	`TextUnit.roundToPx()` Convert Sp to `Int` by rounding	Cmn
`open Dp`	`Int.toDp()` Convert an `Int` pixel value to `Dp`.	Cmn
`open Dp`	`Float.toDp()` Convert a `Float` pixel value to a Dp	Cmn
`open DpSize`	`Size.toDpSize()` Convert a `Size` to a `DpSize`.	Cmn
`open Float`	`Dp.toPx()` Convert `Dp` to pixels.	Cmn
`open Float`	`TextUnit.toPx()` Convert Sp to pixels.	Cmn
`open Rect`	`DpRect.toRect()` Convert a `DpRect` to a `Rect`.	Cmn
`open Size`	`DpSize.toSize()` Convert a `DpSize` to a `Size`.	Cmn
`open TextUnit`	`Int.toSp()` Convert an `Int` pixel value to Sp.	Cmn
`open TextUnit`	`Float.toSp()` Convert a `Float` pixel value to a Sp	Cmn

From androidx.compose.ui.unit.FontScaling

`open Dp`	`TextUnit.toDp()` Convert Sp to `Dp`.	Cmn
`open TextUnit`	`Dp.toSp()` Convert `Dp` to Sp.	Cmn

Public functions

obtainGraphicsLayer

Cmn

Added in 1.7.0

fun obtainGraphicsLayer(): GraphicsLayer

Returns a managed GraphicsLayer instance. This GraphicsLayer maybe newly created or return a previously allocated instance. Consumers are not expected to release this instance as it is automatically recycled upon invalidation of the CacheDrawScope and released when the DrawCacheModifier is detached.

obtainShadowContext

Cmn

Added in 1.9.0

fun obtainShadowContext(): ShadowContext

Returns the ShadowContext used to create InnerShadowPainter and DropShadowPainter to render inner and drop shadows respectively

onDrawBehind

Cmn

Added in 1.0.0

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

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

onDrawWithContent

Cmn

Added in 1.0.0

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

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

record

Cmn

Artifact: androidx.compose.ui:ui

View Source

fun GraphicsLayer.record(
    density: Density = this@CacheDrawScope,
    layoutDirection: LayoutDirection = this@CacheDrawScope.layoutDirection,
    size: IntSize = this@CacheDrawScope.size.toIntSize(),
    block: ContentDrawScope.() -> Unit
): Unit

Record the drawing commands into the GraphicsLayer with the Density, LayoutDirection and Size are given from the provided CacheDrawScope

Public properties

density

Cmn

Added in 1.0.0

open val density: Float

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

fontScale

Cmn

Added in 1.0.0

open val fontScale: Float

Current user preference for the scaling factor for fonts.

layoutDirection

Cmn

Added in 1.0.0

val layoutDirection: LayoutDirection

Provides the LayoutDirection.

size

Cmn

Added in 1.0.0

val size: Size

Provides the dimensions of the current drawing environment