Document: pointerLockElement property
The read-only pointerLockElement
property
of the Document
interface provides the
element set as the target for mouse events while the pointer is locked. It is
null
if lock is pending, pointer is unlocked, or the target is in another
document.
Value
An Element
or null
.
Examples
Determine if a canvas element is currently pointer locked.
js
if (document.pointerLockElement === canvasElement) {
console.log("The pointer lock status is now locked");
// Do something useful in response
} else {
console.log("The pointer lock status is now unlocked");
// Do something useful in response
}
Specifications
Specification |
---|
Pointer Lock 2.0 # dom-documentorshadowroot-pointerlockelement |
Browser compatibility
BCD tables only load in the browser