<!--
{
  "availability" : [
    "iOS: 14.0.0 -",
    "iPadOS: 14.0.0 -",
    "macCatalyst: 14.0.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "UIKit",
  "identifier" : "/documentation/UIKit/UIPointerLockState",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "UIKit"
    ],
    "preciseIdentifier" : "c:objc(cs)UIPointerLockState"
  },
  "title" : "UIPointerLockState"
}
-->

# UIPointerLockState

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

```
@MainActor class UIPointerLockState
```

## 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`](/documentation/UIKit/UIPointerLockState/isLocked)

A Boolean value that indicates whether the pointer is locked.

### Updating the Lock State

[`didChangeNotification`](/documentation/UIKit/UIPointerLockState/didChangeNotification)

A notification that posts when the value of the locked state for a scene changes.

[`sceneUserInfoKey`](/documentation/UIKit/UIPointerLockState/sceneUserInfoKey)

A key that reflects the new locked state.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)