Skip to content

Repository files navigation

jsPointerLock

NPM VersionNPM DownloadsLicense

W3C Pointer Lock Fallback

Specification

Pointer Lock API, W3C

Usage

I suggest you to use jspm as your package manager.

importPointerLockfrom"jspointerlock";constpointerLock=newPointerLock(document.body);pointerLock.on("change",(isLocked)=>{console.log(`pointer is ${isLocked ? 'locked' : 'not locked'}`);});pointerLock.element.addEventListener("click",()=>{pointerLock.requestPointerLock();});

Directly in a browser

Please checkout the index-dist.html file for direct usage in a browser.

API

Classes

  • PointerLock
    • Constructor(Element element) extends EventEmitter
    • Members
      • requestPointerLock() => Void
    • Static Members
      • exitPointerLock() => Void
    • Properties
      • element => Element
      • isLocked => Boolean
    • Static Properties
      • isSupported => Boolean
      • pointerLockElement => Element
    • Events
      • change => (BooleanisLocked, Evente)
      • error => (Errorerr, Evente)
      • unsupported => ()

License

MIT

Releases

Packages

Used by

Contributors

Languages