The VREyeParameters interface of the WebVR API represents all the information required to correctly render a scene for a given eye, including field of view information.
This interface is accessible through the VRDisplay.getEyeParameters() method.
The values in this interface should not be used to compute view or projection matrices. In order to ensure the widest possible hardware compatibility use the matrices provided by VRFrameData .
Properties
VREyeParameters.offset Read only
Represents the o ffset from the center point between the user's eyes to the center of the eye, measured in meters.
VREyeParameters.fieldOfView Read only
Describes t he current field of view for the eye, which can vary as the user adjusts their interpupillary distance (IPD).
VREyeParameters.renderWidth Read only
Describes the recommended render target width of each eye viewport, in pixels.
VREyeParameters.renderHeight Read only
Describes the recommended render target height of each eye viewport, in pixels.
Examples
navigator.getVRDisplays().then(function(displays) {
// If a display is available, use it to present the scene
vrDisplay = displays[0];
console.log('Display found');
// Starting the presentation when the button is clicked:
// It can only be called in response to a user gesture
btn.addEventListener('click', function() {
vrDisplay.requestPresent([{ source: canvas }]).then(function() {
console.log('Presenting to WebVR display');
// Set the canvas size to the size of the vrDisplay viewport
var leftEye = vrDisplay.getEyeParameters('left');
var rightEye = vrDisplay.getEyeParameters('right');
canvas.width = Math.max(leftEye.renderWidth, rightEye.renderWidth) * 2;
canvas.height = Math.max(leftEye.renderHeight, rightEye.renderHeight);
drawVRScene();
});
});
});
Specifications
Browser compatibility
1. Only works in an experimental version of Chrome . (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
2. Daydream View supported in Chrome 56.
3. Google Cardboard supported in Chrome 57.
4. From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
5. Windows support was enabled in Firefox 55.
6. macOS support was enabled in Firefox 58.
Desktop Mobile Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet Basic support
No support
No
Full support
Yes
Full support
55
Full support
55Notes Windows support was enabled in Firefox 55.
Full support
58Notes macOS support was enabled in Firefox 58.
No support
No
?
?
No support
No
Full support
56
Full support
56Notes Only works in an experimental version of Chrome . (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)Notes Daydream View supported in Chrome 56.Notes Google Cardboard supported in Chrome 57.Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
?
?
?
?
?
fieldOfView
No support
No
Full support
15
Full support
55
Full support
55Notes Windows support was enabled in Firefox 55.
Full support
58Notes macOS support was enabled in Firefox 58.
No support
No
?
?
No support
No
Full support
56
Full support
56Notes Only works in an experimental version of Chrome . (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)Notes Daydream View supported in Chrome 56.Notes Google Cardboard supported in Chrome 57.Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
?
?
?
?
?
maximumFieldOfView Experimental Deprecated Non-standard
No support
No
No support
No
Full support
55
Full support
55Notes Windows support was enabled in Firefox 55.
Full support
58Notes macOS support was enabled in Firefox 58.
No support
No
?
?
No support
No
No support
No
No support
No
?
?
?
?
minimumFieldOfView Experimental Deprecated Non-standard
No support
No
No support
No
Full support
55
Full support
55Notes Windows support was enabled in Firefox 55.
Full support
58Notes macOS support was enabled in Firefox 58.
No support
No
?
?
No support
No
No support
No
No support
No
?
?
?
?
offset
No support
No
Full support
15
Full support
55
Full support
55Notes Windows support was enabled in Firefox 55.
Full support
58Notes macOS support was enabled in Firefox 58.
No support
No
?
?
No support
No
Full support
56
Full support
56Notes Only works in an experimental version of Chrome . (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)Notes Daydream View supported in Chrome 56.Notes Google Cardboard supported in Chrome 57.Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
?
?
?
?
?
recommendedFieldOfView Experimental Deprecated Non-standard
No support
No
No support
No
No support
No
No support
No
?
?
No support
No
No support
No
No support
No
?
?
?
?
renderHeight
No support
No
Full support
15
Full support
55
Full support
55Notes Windows support was enabled in Firefox 55.
Full support
58Notes macOS support was enabled in Firefox 58.
No support
No
?
?
No support
No
Full support
56
Full support
56Notes Only works in an experimental version of Chrome . (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)Notes Daydream View supported in Chrome 56.Notes Google Cardboard supported in Chrome 57.Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
?
?
?
?
?
renderRect Experimental Deprecated Non-standard
No support
No
No support
No
No support
No
No support
No
?
?
No support
No
No support
No
No support
No
?
?
?
?
renderWidth
No support
No
Full support
15
Full support
55
Full support
55Notes Windows support was enabled in Firefox 55.
Full support
58Notes macOS support was enabled in Firefox 58.
No support
No
?
?
No support
No
Full support
56
Full support
56Notes Only works in an experimental version of Chrome . (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)Notes Daydream View supported in Chrome 56.Notes Google Cardboard supported in Chrome 57.Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
?
?
?
?
?
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. Non-standard. Expect poor cross-browser support. Non-standard. Expect poor cross-browser support. 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
Document Tags and Contributors
Last updated by:
jpmedley ,
Mar 23, 2018, 9:35:06 AM