VREyeParameters.offset

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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 offset read-only property of the VREyeParameters interface represents the offset from the center point between the user's eyes to the center of the eye, measured in meters.

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

This value should represent half the user’s interpupillary distance (IPD), but may also represent the distance from the center point of the headset to the center point of the lens for the given eye.

Syntax

var myOffset = eyeParametersInstance.offset;

Value

A Float32Array representing a vector describing the offset from the center point between the users eyes to the center of the eye in meters.

Note: Values for the left eye will be negative; values for the right eye will be positive.

Examples

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