This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
Properties
VREyeParameters.offset
Read only- Represents the offset from the center point between the user's eyes to the center of the eye, measured in meters.
VREyeParameters.fieldOfView
Read only- Describes the 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
Specification | Status | Comment |
---|---|---|
WebVR 1.1 The definition of 'VREyeParameters' in that specification. |
Editor's Draft | Initial definition |
Browser compatibility
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | Yes1 2 | Yes | 553 584 | No | ? | ? |
fieldOfView | Yes1 2 | Yes | 553 584 | No | ? | ? |
maximumFieldOfView | No | No | 553 584 | No | ? | ? |
minimumFieldOfView | No | No | 553 584 | No | ? | ? |
offset | Yes1 2 | Yes | 553 584 | No | ? | ? |
recommendedFieldOfView | No | No | No | No | ? | ? |
renderHeight | Yes1 2 | Yes | 553 584 | No | ? | ? |
renderRect | No | No | No | No | ? | ? |
renderWidth | Yes1 2 | Yes | 553 584 | No | ? | ? |
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|---|---|---|---|---|---|---|
Basic support | No | Yes5 | ? | ? | No | ? | ? |
fieldOfView | No | Yes5 | ? | ? | No | ? | ? |
maximumFieldOfView | No | No | No | ? | No | ? | ? |
minimumFieldOfView | No | No | No | ? | No | ? | ? |
offset | No | Yes5 | ? | ? | No | ? | ? |
recommendedFieldOfView | No | No | No | ? | No | ? | ? |
renderHeight | No | Yes5 | ? | ? | No | ? | ? |
renderRect | No | No | No | ? | No | ? | ? |
renderWidth | No | Yes5 | ? | ? | No | ? | ? |
1. Only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays()
is invoked).
2. This feature is behind the WebVR
preference. To change preferences in Chrome, visit chrome://flags.
3. Windows support was enabled in Firefox 55.
4. macOS support was enabled in Firefox 58.
5. Currently supported only by Google Daydream.
See also
- WebVR API homepage
- MozVr.com — demos, downloads, and other resources from the Mozilla VR team.