RotaryScrollEvent

Class

Common
expect class RotaryScrollEvent

This event represents a rotary input event.

Properties

Common
val verticalScrollPixels: Float

The amount to scroll (in pixels) in response to a RotaryScrollEvent in a container that can scroll vertically.

Common
val horizontalScrollPixels: Float

The amount to scroll (in pixels) in response to a RotaryScrollEvent in a container that can scroll horizontally.

Common
val uptimeMillis: Long

The time in milliseconds at which this even occurred. The start (0) time is platform-dependent.

Android
actual class RotaryScrollEvent
internal constructor(
    /**
     * The amount to scroll (in pixels) in response to a [RotaryScrollEvent] in a container that can
     * scroll vertically.
     */
    actual val verticalScrollPixels: Float,

    /**
     * The amount to scroll (in pixels) in response to a [RotaryScrollEvent] in a container that can
     * scroll horizontally.
     */
    actual val horizontalScrollPixels: Float,

    /**
     * The time in milliseconds at which this even occurred. The start (`0`) time is
     * platform-dependent.
     */
    actual val uptimeMillis: Long,

    /** The id for the input device that this event came from */
    val inputDeviceId: Int,
)

This event represents a rotary input event.

Some Wear OS devices contain a physical rotating side button, or a rotating bezel. When the user turns the button or rotates the bezel, a RotaryScrollEvent is sent to the item in focus.