AwaitPointerEventScope

Kotlin |Java

interface AwaitPointerEventScope : Density

androidx.compose.ui.input.pointer.AwaitPointerEventScope

Receiver scope for awaiting pointer events in a call to PointerInputScope.awaitPointerEventScope.

This is a restricted suspension scope. Code in this scope is always called undispatched and may only suspend for calls to awaitPointerEvent. These functions resume synchronously and the caller may mutate the result before the next await call to affect the next stage of the input processing pipeline.

Summary

Public methods
abstract suspend PointerEvent	`awaitPointerEvent(pass: PointerEventPass = PointerEventPass.Main)` Suspend until a PointerEvent is reported to the specified input pass.

Inherited functions

From class Density

`Int`	`roundToPx()` Convert Dp to Int by rounding
`Int`	`roundToPx()` Convert Sp to Int by rounding
`Dp`	`toDp()` Convert Sp to Dp.
`Dp`	`toDp()` Convert an Int pixel value to Dp.
`Dp`	`toDp()` Convert a Float pixel value to a Dp
`Float`	`toPx()` Convert Dp to pixels. Pixels are used to paint to Canvas.
`Float`	`toPx()` Convert Sp to pixels. Pixels are used to paint to Canvas.
`Rect`	`toRect()` Convert a DpRect to a Rect.
`TextUnit`	`toSp()` Convert Dp to Sp. Sp is used for font size, etc.
`TextUnit`	`toSp()` Convert an Int pixel value to Sp.
`TextUnit`	`toSp()` Convert a Float pixel value to a Sp

Extension functions

From androidx.compose.foundation.gestures

suspend PointerInputChange?	`AwaitPointerEventScope.awaitDragOrCancellation(pointerId: PointerId)` Reads pointer input events until a drag is detected or all pointers are up.
suspend PointerInputChange	`AwaitPointerEventScope.awaitFirstDown(requireUnconsumed: Boolean = true)` Reads events until the first down is received.
suspend PointerInputChange?	`AwaitPointerEventScope.awaitHorizontalDragOrCancellation(pointerId: PointerId)` Reads pointer input events until a horizontal drag is detected or all pointers are up.
suspend PointerInputChange?	`AwaitPointerEventScope.awaitHorizontalTouchSlopOrCancellation(pointerId: PointerId, onTouchSlopReached: (change: PointerInputChange, overSlop: Float) -> Unit)` Waits for horizontal drag motion to pass touch slop, using pointerId as the pointer to examine.
suspend PointerInputChange?	`AwaitPointerEventScope.awaitTouchSlopOrCancellation(pointerId: PointerId, onTouchSlopReached: (change: PointerInputChange, overSlop: Offset) -> Unit)` Waits for drag motion to pass touch slop, using pointerId as the pointer to examine.
suspend PointerInputChange?	`AwaitPointerEventScope.awaitVerticalDragOrCancellation(pointerId: PointerId)` Reads pointer input events until a vertical drag is detected or all pointers are up.
suspend PointerInputChange?	`AwaitPointerEventScope.awaitVerticalTouchSlopOrCancellation(`