androidx.compose.ui.input.pointer

Kotlin |Java

Interfaces

AwaitPointerEventScope	Receiver scope for awaiting pointer events in a call to PointerInputScope.awaitPointerEventScope.
PointerInputModifier	A Modifier.Element that can interact with pointer input.
PointerInputScope	Receiver scope for Modifier.pointerInput that permits handling pointer input.

Classes

ConsumedData	Describes what aspects of a change has been consumed.
PointerEvent	Describes a pointer input change event that has occurred at a particular point in time.
PointerId	An ID for a given pointer.
PointerInputChange	Describes a change that has occurred for a particular pointer, as well as how much of the change has been consumed (meaning, used by a node in the UI).
PointerInputFilter	A PointerInputFilter represents a single entity that receives PointerInputChanges), interprets them, and consumes the aspects of the changes that it is react to such that other PointerInputFilters don't also react to them.
RequestDisallowInterceptTouchEvent	Function that can be passed to pointerInteropFilter and then later invoked which provides an analog to ViewParent.requestDisallowInterceptTouchEvent.

Enums

PointerEventPass	The enumeration of passes where PointerInputChange traverses up and down the UI tree.
PointerType	The device type that produces a PointerInputChange, such as a mouse or stylus.

Extension functions summary

For PointerInputChange
Boolean	`PointerInputChange.anyChangeConsumed()` True if any aspect of this PointerInputChange has been consumed.
Boolean	`PointerInputChange.changedToDown()` True if this PointerInputChange represents a pointer coming in contact with the screen and that change has not been consumed.
Boolean	`PointerInputChange.changedToDownIgnoreConsumed()` True if this PointerInputChange represents a pointer coming in contact with the screen, whether or not that change has been consumed.
Boolean	`PointerInputChange.changedToUp()` True if this PointerInputChange represents a pointer breaking contact with the screen and that change has not been consumed.
Boolean	`PointerInputChange.changedToUpIgnoreConsumed()` True if this PointerInputChange represents a pointer breaking contact with the screen, whether or not that change has been consumed.
Unit	`PointerInputChange.consumeAllChanges()` Consumes all changes associated with the PointerInputChange
Unit	`PointerInputChange.consumeDownChange()` Consume the up or down change of this PointerInputChange if there is an up or down change to consume.
Unit	`PointerInputChange.consumePositionChange()` Consume position change if there is any
Boolean	`PointerInputChange.isOutOfBounds(size: IntSize)` Returns `true` if the pointer has moved outside of the region of `(0, 0, size.width, size.height)` or `false` if the current pointer is up or it is inside the given bounds.
Offset	`PointerInputChange.positionChange()` The distance that the pointer has moved on the screen minus any distance that has been consumed.
Boolean	`PointerInputChange.positionChangeConsumed()` True if this PointerInputChange's movement has been consumed.
Offset	`PointerInputChange.positionChangeIgnoreConsumed()` The distance that the pointer has moved on the screen, ignoring the fact that it might have been consumed.
Boolean	`PointerInputChange.positionChanged()` True if this PointerInputChange represents a pointer moving on the screen and some of that movement has not been consumed.
Boolean	`PointerInputChange.positionChangedIgnoreConsumed()` True if this PointerInputChange represents a pointer moving on the screen ignoring how much of that movement may have been consumed.

For Modifier
Modifier	`Modifier.pointerInput(block: suspend PointerInputScope.() -> Unit)` Create a modifier for processing pointer input within the region of the modified element.
Modifier	`Modifier.pointerInput(key1: Any?, block: suspend PointerInputScope.() -> Unit)` Create a modifier for processing pointer input within the region of the modified element.
Modifier	`Modifier.pointerInput(key1: Any?, key2: Any?, block: suspend`