RemoteCreationDisplayInfo

class RemoteCreationDisplayInfo

Represents the virtual display metrics and configuration used as guide values for rendering a RemoteCompose document.

These values serve as a guide for the predicted characteristics of the remote display, but the actual characteristics may differ when the document is played back on a remote client.

Summary

Public properties
Density

The Compose Density of the virtual display.
RemoteDensityBehavior
Boolean

Whether the capture is happening in an inspection or preview environment (e.g. inside an IDE preview).
Size

The physical dimensions of the virtual display in pixels.

Extension properties
Dp

The height of the display in Dp units.
Dp

The width of the display in Dp units.

Public properties

density

Added in 1.0.0-alpha21
val density: Density

The Compose Density of the virtual display.

densityBehavior

Added in 1.0.0-alpha21
val densityBehavior: RemoteDensityBehavior

isInspectionMode

Added in 1.0.0-alpha21
val isInspectionMode: Boolean

Whether the capture is happening in an inspection or preview environment (e.g. inside an IDE preview). Defaults to false.

size

val size: Size

The physical dimensions of the virtual display in pixels.

Extension properties

RemoteCreationDisplayInfo.heightDp

val RemoteCreationDisplayInfo.heightDp: Dp

The height of the display in Dp units.

RemoteCreationDisplayInfo.widthDp

val RemoteCreationDisplayInfo.widthDp: Dp

The width of the display in Dp units.