# androidx.compose.ui.input.pointer

Common/AllAndroid/JVM

## Interfaces

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/AwaitPointerEventScope` | Receiver scope for awaiting pointer events in a call to `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputScope#awaitPointerEventScope(kotlin.coroutines.SuspendFunction1)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerIcon` | Represents a pointer icon to use in `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/pointerHoverIcon.modifier#(androidx.compose.ui.Modifier).pointerHoverIcon(androidx.compose.ui.input.pointer.PointerIcon,kotlin.Boolean)` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/stylusHoverIcon.modifier#(androidx.compose.ui.Modifier).stylusHoverIcon(androidx.compose.ui.input.pointer.PointerIcon,kotlin.Boolean,androidx.compose.ui.node.DpTouchBoundsExpansion)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputEventHandler` |   | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputModifier` | A `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.Element` that can interact with pointer input. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputScope` | Receiver scope for `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/pointerInput.modifier#(androidx.compose.ui.Modifier).pointerInput(kotlin.coroutines.SuspendFunction1)` that permits `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputScope#awaitPointerEventScope(kotlin.coroutines.SuspendFunction1)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/SuspendingPointerInputModifierNode` | Extends `https://developer.android.com/reference/kotlin/androidx/compose/ui/node/PointerInputModifierNode` with a handler to execute asynchronously when an event occurs and a function to reset that handler (cancels the existing coroutine and essentially resets the handler's execution). | Cmn |

## Classes

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/ConsumedData` | **This class is deprecated.** Use PointerInputChange.isConsumed and PointerInputChange.consume() instead | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/HistoricalChange` | Data structure for "historical" pointer moves. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons` | Contains the state of pointer buttons (e.g. mouse and stylus buttons). | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEvent` | Describes a pointer input change event that has occurred at a particular point in time. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | Indicates the primary reason that the `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEvent` was sent. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerId` | An ID for a given pointer. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/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). | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputFilter` | A PointerInputFilter represents a single entity that receives `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange`s), interprets them, and consumes the aspects of the changes that it is react to such that other PointerInputFilters don't also react to them. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers` | Contains the state of modifier keys, such as Shift, Control, and Alt, as well as the state of the lock keys, such as Caps Lock and Num Lock. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerType` | The device type that produces a `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange`, such as a mouse or stylus. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/RequestDisallowInterceptTouchEvent` | Function that can be passed to `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/RequestDisallowInterceptTouchEvent#pointerInteropFilter()` and then later invoked which provides an analog to `https://developer.android.com/reference/android/view/ViewParent.html#requestDisallowInterceptTouchEvent(boolean)`. | android |

## Exceptions

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventTimeoutCancellationException` | An exception thrown from `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/AwaitPointerEventScope#withTimeout(kotlin.Long,kotlin.coroutines.SuspendFunction1)` when the execution time of the coroutine is too long. | Cmn android |

## Enums

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventPass` | The enumeration of passes where `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` traverses up and down the UI tree. | Cmn |

## Modifiers

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/motionEventSpy.modifier` | Calls `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.Modifier).motionEventSpy(kotlin.Function1)` with each `https://developer.android.com/reference/android/view/MotionEvent.html` that the layout area or any child `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/pointerInput.modifier#(androidx.compose.ui.Modifier).pointerInput(kotlin.coroutines.SuspendFunction1)` receives. | android |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/pointerHoverIcon.modifier` | Modifier that lets a developer define a pointer icon to display when the cursor is hovered over the element. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/pointerInput.modifier` | Create a modifier for processing pointer input within the region of the modified element. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/pointerInteropFilter.modifier` | A special PointerInputModifier that provides access to the underlying `https://developer.android.com/reference/android/view/MotionEvent.html`s originally dispatched to Compose. | android |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/stylusHoverIcon.modifier` | Modifier that lets a developer define a pointer icon to display when a stylus is hovered over the element. | Cmn |

## Top-level functions summary

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerIcon` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#PointerIcon(android.view.PointerIcon)(pointerIcon: https://developer.android.com/reference/android/view/PointerIcon.html)` Creates `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#PointerIcon(android.view.PointerIcon)` from `https://developer.android.com/reference/android/view/PointerIcon.html` | android |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerIcon` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#PointerIcon(kotlin.Int)(pointerIconType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#PointerIcon(kotlin.Int)` from pointer icon type (see `https://developer.android.com/reference/android/view/PointerIcon.html#getSystemIcon(android.content.Context, int)` | android |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/SuspendingPointerInputModifierNode` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#SuspendingPointerInputModifierNode(androidx.compose.ui.input.pointer.PointerInputEventHandler)( pointerInputEventHandler: https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputEventHandler )` Supports suspending pointer event handling. | Cmn |

## Extension functions summary

|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.[anyChangeConsumed](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).anyChangeConsumed())()` **This function is deprecated.** Partial consumption has been deprecated. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).changedToDown()()` True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer coming in contact with the screen and that change has not been consumed. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).changedToDownIgnoreConsumed()()` True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer coming in contact with the screen, whether or not that change has been consumed. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).changedToUp()()` True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer breaking contact with the screen and that change has not been consumed. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).changedToUpIgnoreConsumed()()` True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer breaking contact with the screen, whether or not that change has been consumed. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.[consumeAllChanges](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).consumeAllChanges())()` **This function is deprecated.** Use consume() instead | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.[consumeDownChange](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).consumeDownChange())()` **This function is deprecated.** Partial consumption has been deprecated. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.[consumePositionChange](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).consumePositionChange())()` **This function is deprecated.** Partial consumption has been deprecated. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).indexOfFirstPressed()()` Returns the index of first button pressed as used in `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPressed(kotlin.Int)` or `-1` if no button is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).indexOfLastPressed()()` Returns the index of last button pressed as used in `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPressed(kotlin.Int)` or `-1` if no button is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.[isOutOfBounds](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).isOutOfBounds(androidx.compose.ui.unit.IntSize))(size: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/IntSize)` **This function is deprecated.** Use isOutOfBounds() that supports minimum touch target | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).isOutOfBounds(androidx.compose.ui.unit.IntSize,androidx.compose.ui.geometry.Size)( size: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/IntSize, extendedTouchPadding: https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Size )` Returns `true` if the pointer has moved outside of the pointer region. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPressed(kotlin.Int)(buttonIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns `true` when the button at `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPressed(kotlin.Int)` is pressed and `false` when it isn't pressed. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).positionChange()()` The distance that the pointer has moved on the screen minus any distance that has been consumed. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.[positionChangeConsumed](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).positionChangeConsumed())()` **This function is deprecated.** Partial consumption has been deprecated. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).positionChangeIgnoreConsumed()()` The distance that the pointer has moved on the screen, ignoring the fact that it might have been consumed. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).positionChanged()()` True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer moving on the screen and some of that movement has not been consumed. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).positionChangedIgnoreConsumed()()` True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer moving on the screen ignoring how much of that movement may have been consumed. | Cmn |

## Extension properties summary

|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).areAnyPressed()` Returns `true` if any button is pressed or `false` if all buttons are released. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isAltGraphPressed()` `true` when the AltGraph key is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isAltPressed()` `true` when the Alt key is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isBackPressed()` `true` when the back button (mouse back button) is pressed or `false` when it isn't pressed or there is no mouse button assigned to "back." | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isCapsLockOn()` `true` when the keyboard's Caps Lock is on. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isCtrlPressed()` `true` when the Control key is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isForwardPressed()` `true` when the forward button (mouse forward button) is pressed or `false` when it isn't pressed or there is no button assigned to "forward." | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isFunctionPressed()` `true` when the Function key is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isMetaPressed()` `true` when the Meta key is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isNumLockOn()` `true` when the keyboard's Num Lock is on. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPrimaryPressed()` `true` when the primary button (left mouse button) is pressed or `false` when it isn't pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isScrollLockOn()` `true` when the keyboard's Scroll Lock is on. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isSecondaryPressed()` `true` when the secondary button (right mouse button) is pressed or `false` when it isn't pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isShiftPressed()` `true` when the Shift key is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerKeyboardModifiers.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerKeyboardModifiers).isSymPressed()` `true` when the Sym key is pressed. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerButtons.https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isTertiaryPressed()` `true` when the tertiary button (middle mouse button) is pressed or `false` when it isn't pressed. | Cmn android |

## Top-level functions

### PointerIcon

android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerIcon.android.kt+function:PointerIcon)

```
fun PointerIcon(pointerIcon: PointerIcon): PointerIcon
```

Creates `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#PointerIcon(android.view.PointerIcon)` from `https://developer.android.com/reference/android/view/PointerIcon.html`

### PointerIcon

android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerIcon.android.kt+function:PointerIcon)

```
fun PointerIcon(pointerIconType: Int): PointerIcon
```

Creates `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#PointerIcon(kotlin.Int)` from pointer icon type (see `https://developer.android.com/reference/android/view/PointerIcon.html#getSystemIcon(android.content.Context, int)`

### SuspendingPointerInputModifierNode

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/SuspendingPointerInputFilter.kt+function:SuspendingPointerInputModifierNode) Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.8.0)

```
fun SuspendingPointerInputModifierNode(
    pointerInputEventHandler: PointerInputEventHandler
): SuspendingPointerInputModifierNode
```

Supports suspending pointer event handling. This is used by `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/pointerInput.modifier#(androidx.compose.ui.Modifier).pointerInput(kotlin.coroutines.SuspendFunction1)`, so in most cases you should just use `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/pointerInput.modifier#(androidx.compose.ui.Modifier).pointerInput(kotlin.coroutines.SuspendFunction1)` for suspending pointer input. Creating a `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#SuspendingPointerInputModifierNode(androidx.compose.ui.input.pointer.PointerInputEventHandler)` should only be needed when you want to delegate to suspending pointer input as part of the implementation of a complex `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.Node`.

## Extension functions

### PointerInputChange.anyChangeConsumed

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:anyChangeConsumed) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.2.0)

```
fun PointerInputChange.[anyChangeConsumed](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).anyChangeConsumed())(): Boolean
```

> [!CAUTION]
> **This function is deprecated.**   
> Partial consumption has been deprecated. Use isConsumed instead, use this instead:
>
> ```kotlin
> isConsumed
> ```

True if any aspect of this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` has been consumed.

### PointerInputChange.changedToDown

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:changedToDown) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
fun PointerInputChange.changedToDown(): Boolean
```

True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer coming in contact with the screen and that change has not been consumed.

### PointerInputChange.changedToDownIgnoreConsumed

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:changedToDownIgnoreConsumed) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
fun PointerInputChange.changedToDownIgnoreConsumed(): Boolean
```

True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer coming in contact with the screen, whether or not that change has been consumed.

### PointerInputChange.changedToUp

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:changedToUp) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
fun PointerInputChange.changedToUp(): Boolean
```

True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer breaking contact with the screen and that change has not been consumed.

### PointerInputChange.changedToUpIgnoreConsumed

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:changedToUpIgnoreConsumed) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
fun PointerInputChange.changedToUpIgnoreConsumed(): Boolean
```

True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer breaking contact with the screen, whether or not that change has been consumed.

### PointerInputChange.consumeAllChanges

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:consumeAllChanges) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.2.0)

```
fun PointerInputChange.[consumeAllChanges](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).consumeAllChanges())(): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Use consume() instead, use this instead:
>
> ```kotlin
> consume()
> ```

Consumes all changes associated with the `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange`

### PointerInputChange.consumeDownChange

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:consumeDownChange) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.2.0)

```
fun PointerInputChange.[consumeDownChange](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).consumeDownChange())(): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Partial consumption has been deprecated. Use consume() instead, use this instead:
>
> ```kotlin
> if (pressed != previousPressed) consume()
> ```

Consume the up or down change of this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` if there is an up or down change to consume.

### PointerInputChange.consumePositionChange

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:consumePositionChange) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.2.0)

```
fun PointerInputChange.[consumePositionChange](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).consumePositionChange())(): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Partial consumption has been deprecated. Use consume() instead, use this instead:
>
> ```kotlin
> if (positionChange() != Offset.Zero) consume()
> ```

Consume position change if there is any

### PointerButtons.indexOfFirstPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+function:indexOfFirstPressed)

```
fun PointerButtons.indexOfFirstPressed(): Int
```

Returns the index of first button pressed as used in `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPressed(kotlin.Int)` or `-1` if no button is pressed.

### PointerButtons.indexOfLastPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+function:indexOfLastPressed)

```
fun PointerButtons.indexOfLastPressed(): Int
```

Returns the index of last button pressed as used in `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPressed(kotlin.Int)` or `-1` if no button is pressed.

### PointerInputChange.isOutOfBounds

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:isOutOfBounds) Added in [1.10.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.10.0) Deprecated in [1.10.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.10.0)

```
fun PointerInputChange.[isOutOfBounds](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).isOutOfBounds(androidx.compose.ui.unit.IntSize))(size: IntSize): Boolean
```

> [!CAUTION]
> **This function is deprecated.**   
> Use isOutOfBounds() that supports minimum touch target, use this instead:
>
> ```kotlin
> this.isOutOfBounds(size, extendedTouchPadding)
> ```

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.

### PointerInputChange.isOutOfBounds

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:isOutOfBounds) Added in [1.10.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.10.0)

```
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)`. Returns`false` if the current pointer is up or it is inside the pointer region.

### PointerButtons.isPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+function:isPressed)

```
fun PointerButtons.isPressed(buttonIndex: Int): Boolean
```

Returns `true` when the button at `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPressed(kotlin.Int)` is pressed and `false` when it isn't pressed. This method can handle buttons that haven't been assigned a designated purpose like `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isPrimaryPressed()` and `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerButtons).isSecondaryPressed()`.

### PointerInputChange.positionChange

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:positionChange) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
fun PointerInputChange.positionChange(): Offset
```

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

### PointerInputChange.positionChangeConsumed

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:positionChangeConsumed) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.2.0)

```
fun PointerInputChange.[positionChangeConsumed](https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/package-summary#(androidx.compose.ui.input.pointer.PointerInputChange).positionChangeConsumed())(): Boolean
```

> [!CAUTION]
> **This function is deprecated.**   
> Partial consumption has been deprecated. Use isConsumed instead, use this instead:
>
> ```kotlin
> isConsumed
> ```

True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange`'s movement has been consumed.

### PointerInputChange.positionChangeIgnoreConsumed

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:positionChangeIgnoreConsumed) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
fun PointerInputChange.positionChangeIgnoreConsumed(): Offset
```

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

### PointerInputChange.positionChanged

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:positionChanged) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
fun PointerInputChange.positionChanged(): Boolean
```

True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer moving on the screen and some of that movement has not been consumed.

### PointerInputChange.positionChangedIgnoreConsumed

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+function:positionChangedIgnoreConsumed) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
fun PointerInputChange.positionChangedIgnoreConsumed(): Boolean
```

True if this `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange` represents a pointer moving on the screen ignoring how much of that movement may have been consumed.

## Extension properties

### PointerButtons.areAnyPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:areAnyPressed)

```
val PointerButtons.areAnyPressed: Boolean
```

Returns `true` if any button is pressed or `false` if all buttons are released.

### PointerKeyboardModifiers.isAltGraphPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isAltGraphPressed)

```
val PointerKeyboardModifiers.isAltGraphPressed: Boolean
```

`true` when the AltGraph key is pressed.

### PointerKeyboardModifiers.isAltPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isAltPressed)

```
val PointerKeyboardModifiers.isAltPressed: Boolean
```

`true` when the Alt key is pressed. This is commonly associated with the Option key on some keyboards.

### PointerButtons.isBackPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isBackPressed)

```
val PointerButtons.isBackPressed: Boolean
```

`true` when the back button (mouse back button) is pressed or `false` when it isn't pressed or there is no mouse button assigned to "back."

### PointerKeyboardModifiers.isCapsLockOn

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isCapsLockOn)

```
val PointerKeyboardModifiers.isCapsLockOn: Boolean
```

`true` when the keyboard's Caps Lock is on.

### PointerKeyboardModifiers.isCtrlPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isCtrlPressed)

```
val PointerKeyboardModifiers.isCtrlPressed: Boolean
```

`true` when the Control key is pressed.

### PointerButtons.isForwardPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isForwardPressed)

```
val PointerButtons.isForwardPressed: Boolean
```

`true` when the forward button (mouse forward button) is pressed or `false` when it isn't pressed or there is no button assigned to "forward."

### PointerKeyboardModifiers.isFunctionPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isFunctionPressed)

```
val PointerKeyboardModifiers.isFunctionPressed: Boolean
```

`true` when the Function key is pressed.

### PointerKeyboardModifiers.isMetaPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isMetaPressed)

```
val PointerKeyboardModifiers.isMetaPressed: Boolean
```

`true` when the Meta key is pressed. This is commonly associated with the Windows or Command key on some keyboards.

### PointerKeyboardModifiers.isNumLockOn

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isNumLockOn)

```
val PointerKeyboardModifiers.isNumLockOn: Boolean
```

`true` when the keyboard's Num Lock is on.

### PointerButtons.isPrimaryPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isPrimaryPressed)

```
val PointerButtons.isPrimaryPressed: Boolean
```

`true` when the primary button (left mouse button) is pressed or `false` when it isn't pressed.

### PointerKeyboardModifiers.isScrollLockOn

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isScrollLockOn)

```
val PointerKeyboardModifiers.isScrollLockOn: Boolean
```

`true` when the keyboard's Scroll Lock is on.

### PointerButtons.isSecondaryPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isSecondaryPressed)

```
val PointerButtons.isSecondaryPressed: Boolean
```

`true` when the secondary button (right mouse button) is pressed or `false` when it isn't pressed.

### PointerKeyboardModifiers.isShiftPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isShiftPressed)

```
val PointerKeyboardModifiers.isShiftPressed: Boolean
```

`true` when the Shift key is pressed.

### PointerKeyboardModifiers.isSymPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isSymPressed)

```
val PointerKeyboardModifiers.isSymPressed: Boolean
```

`true` when the Sym key is pressed.

### PointerButtons.isTertiaryPressed

Cmn android Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.+symbol:isTertiaryPressed)

```
val PointerButtons.isTertiaryPressed: Boolean
```

`true` when the tertiary button (middle mouse button) is pressed or `false` when it isn't pressed.