MDN will be in maintenance mode on Friday September 22nd, starting at 10 AM Pacific / 5 PM UTC, for about 1 hour.

GamepadPose.orientation

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 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

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic Support No Notrue1 2 No No No
FeatureAndroidChrome for AndroidEdge mobileFirefox for AndroidIE mobileOpera AndroidiOS 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. From version true, this feature is behind the dom.gamepad-extensions.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

See also

Document Tags and Contributors

 Contributors to this page: fscholz, chrisdavidmills
 Last updated by: fscholz,