VRPose.orientation

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The orientation read-only property of the VRPose interface returns the orientation of the sensor at the current VRPose.timestamp, as a quarternion value.

Note: This property was part of the old WebVR API. It has been superseded by the WebXR Device API.

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 or the yaw of the sensor at the point that VRDisplay.resetPose() was last called.

Syntax

var myOrientation = VRPose.orientation;

Value

A Float32Array, or null if the VR sensor is not able to provide orientation data.

Examples

See VRDisplay.getFrameData() for example code.

Note: An orientation of { x: 0, y: 0, z: 0, w: 1 } is considered to be "forward".

Specifications

This property was part of the old WebVR API that has been superseded by the WebXR Device API. It is no longer on track to becoming a standard.

Until all browsers have implemented the new WebXR APIs, it is recommended to rely on frameworks, like A-Frame, Babylon.js, or Three.js, or a polyfill, to develop WebXR applications that will work across all browsers [1].

Browser compatibility

BCD tables only load in the browser

See also