Skip to content

textmode.js / Textmodifier / requestPointerLock

Method: requestPointerLock()

ts
requestPointerLock(): boolean;

Request browser pointer lock for the textmode canvas.

When pointer lock is active, mouse movement is reported as relative deltas via Textmodifier.movedX and Textmodifier.movedY, allowing infinite-look and first-person style controls.

Returns

boolean

true if the browser exposes pointer lock and the request was initiated, otherwise false.

Example