VRPose: position property

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.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The position read-only property of the VRPose interface returns the position of the VRDisplay at the current timestamp as a 3D vector.

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

The coordinate system is as follows:

  • Positive X is to the user's right.
  • Positive Y is up.
  • Positive Z is behind the user.

Positions are measured in meters from an origin point — this point is either the position the sensor was first read at, or the position of the sensor at the point that VRDisplay.resetPose() was last called.

Note: By default, all positions are given as a sitting space position. Transforming this point with VRStageParameters.sittingToStandingTransform — when you are working with a room display for example — converts this to a standing space position.

Value

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

Note: User agents may provide emulated position values through techniques such as neck modeling; when doing so they should still report VRDisplayCapabilities.hasPosition as false.

Examples

See VRDisplay.getFrameData() for example code.

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