---
title: UIPointerLockState
framework: uikit
role: symbol
role_heading: Class
path: uikit/uipointerlockstate
---

# UIPointerLockState

An object that contains information about a scene’s pointer lock state.

## Declaration

```swift
@MainActor class UIPointerLockState
```

## Overview

Overview To prevent the pointer from triggering system gestures, for example, bringing up the dock, lock it to your application. Locking the pointer hides the pointer and locks it to just your full-screen application.

## Topics

### Checking the Lock State

- [isLocked](uikit/uipointerlockstate/islocked.md)

### Updating the Lock State

- [didChangeNotification](uikit/uipointerlockstate/didchangenotification.md)
- [sceneUserInfoKey](uikit/uipointerlockstate/sceneuserinfokey.md)

### Structures

- [UIPointerLockState.DidChangeMessage](uikit/uipointerlockstate/didchangemessage.md)

## Relationships

### Inherits From

- [NSObject](objectivec/nsobject-swift.class.md)

### Conforms To

- [CVarArg](swift/cvararg.md)
- [CustomDebugStringConvertible](swift/customdebugstringconvertible.md)
- [CustomStringConvertible](swift/customstringconvertible.md)
- [Equatable](swift/equatable.md)
- [Hashable](swift/hashable.md)
- [NSObjectProtocol](objectivec/nsobjectprotocol.md)
- [Sendable](swift/sendable.md)