This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.
DeprecatedThis 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.
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.1The definition of 'offset' in that specification. | Draft | Initial definition |
Browser compatibility
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
No support No |
Edge
No support 15 — 79 |
Firefox Full support 55 Full support 55 Notes' Windows support was enabled in Firefox 55. Full support 64 Notes' macOS support was enabled in Firefox 64. |
IE
No support No |
Opera
? |
Safari
No support No |
WebView Android
No support No |
Chrome Android No support 56 — 80 No support 56 — 80 Notes' Only works in an experimental version of Chrome. (Other builds won't return any devices when |
Firefox Android
Full support 55 |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android Full support 6.0 Full support 6.0 Notes' Google Cardboard supported in Samsung Internet 7.0. |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
- Deprecated. Not for use in new websites.'
- Deprecated. Not for use in new websites.
- See implementation notes.'
- See implementation notes.
- User must explicitly enable this feature.'
- User must explicitly enable this feature.
See also
- WebVR API homepage.
- MozVr.com — demos, downloads, and other resources from the Mozilla VR team.
VREyeParameters.offset by Mozilla Contributors is licensed under CC-BY-SA 2.5.