Element.requestPointerLock()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The Element.requestPointerLock() method allows to asynchronously ask for the pointer to be locked on the given element.

To track the success or failure of the request, it is necessary to listen for the pointerlockchange and pointerlockerror events at the Document level.

Syntax

instanceOfElement.requestPointerLock();

Specifications

Specification Status Comment
Pointer Lock
The definition of 'Element' in that specification.
Candidate Recommendation Extend the Element interface

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) webkit (Yes) (Yes) moz ? ? ?
Unprefixed support (Yes) (Yes) 50 (50)      
Feature Android Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? (Yes) ? ? ? ?

See also

Document Tags and Contributors

 Contributors to this page: erikadoyle, wbamberg, fscholz, teoli, malrobot, kscarfone, Jeremie
 Last updated by: erikadoyle,