VREyeParameters.offset

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.

Deprecated
This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. 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.

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

var info = document.querySelector('p');
var list = document.querySelector('ul');
var vrDisplay;
if(navigator.getVRDisplays) {
    reportFieldOfView();
} else {
  info.textContent = 'WebVR API not supported by this browser.'
}
function reportFieldOfView() {
  navigator.getVRDisplays().then(function(displays) {
    vrDisplay = displays[0];
    var lEye = vrDisplay.getEyeParameters('left');
    var rEye = vrDisplay.getEyeParameters('right');
    // lEye and rEye are VREyeParameters objects
    var lFOV = lEye.fieldOfView;
    var rFOV = rEye.fieldOfView;
    // lFOV and rFOV are VRFieldOfView objects
    var listitem1 = document.createElement('li');
    var listitem2 = document.createElement('li');
    listitem1.innerHTML = '<strong>Left eye parameters</strong>'
                 + '<br>Offset: ' + lEye.offset
                 + '<br>Render width: ' + lEye.renderWidth
                 + '<br>Render height: ' + lEye.renderHeight
                 + '<br>Up degrees: ' + lFOV.upDegrees
                 + '<br>Right degrees: ' + lFOV.rightDegrees
                 + '<br>Down degrees: ' + lFOV.downDegrees
                 + '<br>Left degrees: ' + lFOV.leftDegrees
   listitem2.innerHTML = '<strong>Right eye parameters</strong>'
                + '<br>Offset: ' + rEye.offset
                + '<br>Render width: ' + rEye.renderWidth
                + '<br>Render height: ' + rEye.renderHeight
                + '<br>Up degrees: ' + rFOV.upDegrees
                + '<br>Right degrees: ' + rFOV.rightDegrees
                + '<br>Down degrees: ' + rFOV.downDegrees
                + '<br>Left degrees: ' + rFOV.leftDegrees
    list.appendChild(listitem1);
    list.appendChild(listitem2);
  });
}

Specifications

Specification	Status	Comment
WebVR 1.1 The definition of 'offset' in that specification.	Editor's Draft	Initial definition

Feature	Chrome	Edge	Firefox (Gecko)	Internet Explorer	Opera	Safari (WebKit)
Basic support	(Yes)^[1]	(Yes)	55 (55)^[2]	No support	No support	No support

Feature	Android	Edge	Firefox Mobile (Gecko)	IE Phone	Opera Mobile	Safari Mobile	Chrome for Android	Samsung Internet for GearVR
Basic support	No support	No support	55.0 (55)	No support	No support	No support	(Yes)^[3]	(Yes)

[1] API Available on all platforms behind a flag, but currently only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays() is invoked). Deprecated in Chrome 59.

[2] Currently only Windows support is enabled by default. Mac support is available in Firefox Nightly.

[3] Currently supported only by Google Daydream.

Syntax

Value

Examples

Specifications

Browser compatibility

See also

Document Tags and Contributors