This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The orientation
read-only property of the GamepadPose
interface returns the orientation of the Gamepad
, as a quarternion value.
The value is a Float32Array
, made up of the following values:
- pitch — rotation around the X axis.
- yaw — rotation around the Y axis.
- roll — rotation around the Z axis.
- w — the fourth dimension (usually 1).
The orientation yaw (rotation around the y axis) is relative to the initial yaw of the sensor when it was first read.
Syntax
var myGamepadOrientation = gamepadPoseInstance.orientation;
Value
A Float32Array
, or null
if the VR sensor is not able to provide orientation data.
Examples
TBD
Note: An orientation of { x: 0, y: 0, z: 0, w: 1 }
is considered to be "forward".
Specifications
Specification | Status | Comment |
---|---|---|
Gamepad Extensions The definition of 'orientation' in that specification. |
Editor's Draft | Initial definition |
Browser compatibility
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | No | No | Yes1 2 | No | No | No |
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|---|---|---|---|---|---|---|
Basic support | No | No | No | No | No | No | No |
1. The flag is enabled by default in Firefox Nightly and Beta, versions 55 and above.
2. This feature is behind the dom.gamepad-extensions.enabled
preference (needs to be set to true
). To change preferences in Firefox, visit about:config.