pointerlockchange

The pointerlockchange event is fired when the pointer is locked/unlocked.

General info

Specification

Pointer Lock

Interface

Event

Bubbles

Yes

Cancelable

No

Target

Document

Default Action

None

Properties

Property	Type	Description
target Read only	EventTarget	The event target (the topmost target in the DOM tree).
type Read only	DOMString	The type of event.
bubbles Read only	Boolean	Whether the event normally bubbles or not
cancelable Read only	Boolean	Whether the event is cancellable or not?

Example

// Note that the API may be vendor-prefixed in some browsers
document.addEventListener("pointerlockchange", function( event ) {

    // The target of the event is always the document,
    // but it is possible to retrieve the locked element through the API
    document.pointerLockElement;

});

Related Events

• pointerlockerror

See also

• Using Pointer Lock API