AmbientMode.Ambient

class AmbientMode.Ambient : AmbientMode

kotlin.Any
   ↳ androidx.wear.compose.foundation.AmbientMode
     ↳ androidx.wear.compose.foundation.AmbientMode.Ambient

Represents that device is in the ambient mode. In this mode, the app is typically updated at infrequent intervals (e.g., once per minute).

Summary

Public constructors
Ambient(
    isBurnInProtectionRequired: Boolean,
    isLowBitAmbientSupported: Boolean
)

Public functions
open operator Boolean
equals(other: Any?)
open Int

Public properties
Boolean

Indicates whether burn-in protection is active.
Boolean

Specifies whether this device has low-bit ambient mode.

Public constructors

Ambient

Added in 1.6.0
Ambient(
    isBurnInProtectionRequired: Boolean,
    isLowBitAmbientSupported: Boolean
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

isBurnInProtectionRequired

Added in 1.6.0
val isBurnInProtectionRequired: Boolean

Indicates whether burn-in protection is active. If isBurnInProtectionRequired is true, the system may periodically shift the display content to prevent pixel burn-in. To ensure that content isn't shifted off the screen, avoid placing content within 10 pixels of the edge of the screen and also avoid solid white areas to prevent pixel burn-in. Both of these requirements only apply in ambient mode, and only when this property is set to true.

isLowBitAmbientSupported

Added in 1.6.0
val isLowBitAmbientSupported: Boolean

Specifies whether this device has low-bit ambient mode. When this property is set to true, the screen supports fewer bits for each color in ambient mode. In this case, anti-aliasing should be disabled in ambient mode, as well as avoiding color gradients.