PointerInputChange

fun consume(): Unit

Consume change event, claiming all the corresponding change info to the caller. This is usually needed when, button, when being clicked, consumed the "up" event so no other parents of this button could consume this "up" again.

"Consumption" is just an indication of the claim and each pointer input handler implementation must manually check this flag to respect it.

fun copy(
    id: PointerId = this.id,
    currentTime: Long = this.uptimeMillis,
    currentPosition: Offset = this.position,
    currentPressed: Boolean = this.pressed,
    previousTime: Long = this.previousUptimeMillis,
    previousPosition: Offset = this.previousPosition,
    previousPressed: Boolean = this.previousPressed,
    type: PointerType = this.type,
    scrollDelta: Offset = this.scrollDelta
): PointerInputChange

Make a shallow copy of the PointerInputChange

NOTE: Due to the need of the inner contract of the PointerInputChange, this method performs a shallow copy of the PointerInputChange. Any consume call between any of the copies will consume any other copy automatically. Therefore, copy with the new isConsumed is not possible. Consider creating a new PointerInputChange

fun copy(
    id: PointerId = this.id,
    currentTime: Long = this.uptimeMillis,
    currentPosition: Offset = this.position,
    currentPressed: Boolean = this.pressed,
    pressure: Float = this.pressure,
    previousTime: Long = this.previousUptimeMillis,
    previousPosition: Offset = this.previousPosition,
    previousPressed: Boolean = this.previousPressed,
    type: PointerType = this.type,
    scrollDelta: Offset = this.scrollDelta
): PointerInputChange

Make a shallow copy of the PointerInputChange

NOTE: Due to the need of the inner contract of the PointerInputChange, this method performs a shallow copy of the PointerInputChange. Any consume call between any of the copies will consume any other copy automatically. Therefore, copy with the new isConsumed is not possible. Consider creating a new PointerInputChange.

@ExperimentalComposeUiApi
fun copy(
    id: PointerId = this.id,
    currentTime: Long = this.uptimeMillis,
    currentPosition: Offset = this.position,
    currentPressed: Boolean = this.pressed,
    previousTime: Long = this.previousUptimeMillis,
    previousPosition: Offset = this.previousPosition,
    previousPressed: Boolean = this.previousPressed,
    type: PointerType = this.type,
    historical: List<HistoricalChange>,
    scrollDelta: Offset = this.scrollDelta
): PointerInputChange

Make a shallow copy of the PointerInputChange

NOTE: Due to the need of the inner contract of the PointerInputChange, this method performs a shallow copy of the PointerInputChange. Any consume call between any of the copies will consume any other copy automatically. Therefore, copy with the new isConsumed is not possible. Consider creating a new PointerInputChange.

fun copy(
    id: PointerId = this.id,
    currentTime: Long = this.uptimeMillis,
    currentPosition: Offset = this.position,
    currentPressed: Boolean = this.pressed,
    pressure: Float = this.pressure,
    previousTime: Long = this.previousUptimeMillis,
    previousPosition: Offset = this.previousPosition,
    previousPressed: Boolean = this.previousPressed,
    type: PointerType = this.type,
    historical: List<HistoricalChange> = this.historical,
    scrollDelta: Offset = this.scrollDelta
): PointerInputChange

Make a shallow copy of the PointerInputChange

NOTE: Due to the need of the inner contract of the PointerInputChange, this method performs a shallow copy of the PointerInputChange. Any consume call between any of the copies will consume any other copy automatically. Therefore, copy with the new isConsumed is not possible. Consider creating a new PointerInputChange.

fun copy(
    id: PointerId = this.id,
    currentTime: Long = this.uptimeMillis,
    currentPosition: Offset = this.position,
    currentPressed: Boolean = this.pressed,
    pressure: Float = this.pressure,
    previousTime: Long = this.previousUptimeMillis,
    previousPosition: Offset = this.previousPosition,
    previousPressed: Boolean = this.previousPressed,
    type: PointerType = this.type,
    historical: List<HistoricalChange> = this.historical,
    scrollDelta: Offset = this.scrollDelta,
    scaleFactor: Float = this.scaleFactor,
    panOffset: Offset = this.panOffset
): PointerInputChange

Make a shallow copy of the PointerInputChange

NOTE: Due to the need of the inner contract of the PointerInputChange, this method performs a shallow copy of the PointerInputChange. Any consume call between any of the copies will consume any other copy automatically. Therefore, copy with the new isConsumed is not possible. Consider creating a new PointerInputChange.

val historical: List<HistoricalChange>

Optional high-frequency pointer moves in between the last two dispatched events. Can be used for extra accuracy when input rate exceeds framerate.

val id: PointerId

The unique id of the pointer associated with this PointerInputChange.

val isConsumed: Boolean

Indicates whether the change was consumed or not. Note that the change must be consumed in full as there's no partial consumption system provided.

val panOffset: Offset

An Offset in pixel coordinates indicating an amount of panning. Also consider handling scrollDelta, which represents a similar action from mouse wheels.

val position: Offset

The Offset of the current pointer event, relative to the containing element (values can be negative or larger than the element bounds).

val pressed: Boolean

true if the pointer event is considered "pressed." For example, finger touching the screen or a mouse button is pressed pressed would be true.

val pressure: Float

The pressure of the of the pointer event

val previousPosition: Offset

The Offset of the previous pointer event, offset to the position and relative to the containing element.

val previousPressed: Boolean

true if the pointer event was considered "pressed." For example , if a finger was touching the screen or a mouse button was pressed, previousPressed would be true.

val previousUptimeMillis: Long

The uptimeMillis of the previous pointer event

val scaleFactor: Float

A multiplicative scale factor indicating the amount of scale to perform as part of this pointer input change. A value of 1f indicates no scale, a value less than 1f indicates a scale down, commonly causing a zoom out, and a value greater than 1f indicates a scale up, commonly causing a zoom in.

val scrollDelta: Offset

The change in scroll position along the horizontal and vertical axes. Note that this value is platform-dependent and is not normalized to pixel coordinates: - Desktop & Android: Measured in platform-specific mouse wheel tick units. - Web: Raw delta values directly from the browser's WheelEvent. - iOS: Native scroll gesture delta.

Also consider handling panOffset, which represents trackpad scroll gestures.

val type: PointerType

The device type that produced the event, such as mouse, or touch.

val uptimeMillis: Long

The time of the current pointer event, in milliseconds. The start (0) time is platform-dependent

fun PointerInputChange.anyChangeConsumed(): Boolean

True if any aspect of this PointerInputChange has been consumed.

fun PointerInputChange.changedToDown(): Boolean

True if this PointerInputChange represents a pointer coming in contact with the screen and that change has not been consumed.

fun PointerInputChange.changedToDownIgnoreConsumed(): Boolean

True if this PointerInputChange represents a pointer coming in contact with the screen, whether or not that change has been consumed.

fun PointerInputChange.changedToUp(): Boolean

True if this PointerInputChange represents a pointer breaking contact with the screen and that change has not been consumed.

fun PointerInputChange.changedToUpIgnoreConsumed(): Boolean

True if this PointerInputChange represents a pointer breaking contact with the screen, whether or not that change has been consumed.

fun PointerInputChange.consumeAllChanges(): Unit

Consumes all changes associated with the PointerInputChange

fun PointerInputChange.consumeDownChange(): Unit

Consume the up or down change of this PointerInputChange if there is an up or down change to consume.

fun PointerInputChange.consumePositionChange(): Unit

Consume position change if there is any

fun PointerInputChange.isOutOfBounds(size: IntSize): Boolean

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.

fun PointerInputChange.isOutOfBounds(
    size: IntSize,
    extendedTouchPadding: Size
): Boolean

Returns true if the pointer has moved outside of the pointer region. For Touch events, this is (-extendedTouchPadding.width, -extendedTouchPadding.height, size.width + extendedTouchPadding.width, size.height + extendedTouchPadding.height) and for other events, this is (0, 0, size.width, size.height). Returnsfalse if the current pointer is up or it is inside the pointer region.

fun PointerInputChange.positionChange(): Offset

The distance that the pointer has moved on the screen minus any distance that has been consumed.

fun PointerInputChange.positionChangeConsumed(): Boolean

True if this PointerInputChange's movement has been consumed.

fun PointerInputChange.positionChangeIgnoreConsumed(): Offset

The distance that the pointer has moved on the screen, ignoring the fact that it might have been consumed.

fun PointerInputChange.positionChanged(): Boolean

True if this PointerInputChange represents a pointer moving on the screen and some of that movement has not been consumed.

fun PointerInputChange.positionChangedIgnoreConsumed(): Boolean

True if this PointerInputChange represents a pointer moving on the screen ignoring how much of that movement may have been consumed.