Density

Kotlin |Java

@Immutable interface Density

Known Direct Subclasses

AwaitPointerEventScope	Receiver scope for awaiting pointer events in a call to PointerInputScope.awaitPointerEventScope.
CacheDrawScope	Handle to a drawing environment that enables caching of content based on the resolved size.
DrawScope	Creates a scoped drawing environment with the provided Canvas.
IntrinsicMeasureScope	The receiver scope of a layout's intrinsic measurements lambdas.
PointerInputScope	Receiver scope for Modifier.pointerInput that permits handling pointer input.
PressGestureScope	Receiver scope for detectTapGestures's `onPress` lambda.

Known Indirect Subclasses

CanvasDrawScope	Implementation of DrawScope that issues drawing commands into the specified canvas and bounds via CanvasDrawScope.draw
ContentDrawScope	Receiver scope for drawing content into a layout, where the content can be drawn between other canvas operations.
MeasureScope	The receiver scope of a layout's measure lambda.
SubcomposeMeasureScope	The receiver scope of a SubcomposeLayout's measure lambda which adds ability to dynamically subcompose a content during the measuring on top of the features provided by MeasureScope.

A density of the screen. Used for the conversions between Dp, Px, Int and TextUnit.


val sizeInPx = with(AmbientDensity.current) { 16.dp.toPx() }

Summary

Public methods
open Dp	`TextUnit.toDp()` Convert Sp to Dp.
open Dp	`Int.toDp()` Convert an Int pixel value to Dp.
open Dp	`Float.toDp()` Convert a Float pixel value to a Dp
open Int	`Dp.toIntPx()` Convert Dp to Int by rounding
open Int	`TextUnit.toIntPx()` Convert Sp to Int by rounding
open Float	`Dp.toPx()` Convert Dp to pixels.
open Float	`TextUnit.toPx()` Convert Sp to pixels.
open Rect	`Bounds.toRect()` Convert a Bounds to a Rect.
open TextUnit	`Dp.toSp()` Convert Dp to Sp.
open TextUnit	`Int.toSp()` Convert an Int pixel value to Sp.
open TextUnit	`Float.toSp()` Convert a Float pixel value to a Sp

Properties
abstract Float	`density` The logical density of the display.
abstract Float	`fontScale` Current user preference for the scaling factor for fonts.

@Stable open fun TextUnit.toDp(): Dp

Convert Sp to Dp.

Exceptions
`IllegalStateException`	if TextUnit other than SP unit is specified.

@Stable open fun Int.toDp(): Dp

Convert an Int pixel value to Dp.

@Stable open fun Float.toDp(): Dp

Convert a Float pixel value to a Dp

@Stable open fun Dp.toIntPx(): Int

Convert Dp to Int by rounding

@Stable open fun TextUnit.toIntPx(): Int

Convert Sp to Int by rounding

@Stable open fun Dp.toPx(): Float

Convert Dp to pixels. Pixels are used to paint to Canvas.

@Stable open fun TextUnit.toPx(): Float

Convert Sp to pixels. Pixels are used to paint to Canvas.

Exceptions
`IllegalStateException`	if TextUnit other than SP unit is specified.

@Stable open fun Bounds.toRect(): Rect

Convert a Bounds to a Rect.

@Stable open fun Dp.toSp(): TextUnit

Convert Dp to Sp. Sp is used for font size, etc.

@Stable open fun Int.toSp(): TextUnit

Convert an Int pixel value to Sp.

@Stable open fun Float.toSp(): TextUnit

Convert a Float pixel value to a Sp

@Stable abstract val density: Float

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

@Stable abstract val fontScale: Float

Current user preference for the scaling factor for fonts.