W3cubDocs

/DOM

VREyeParameters

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.

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 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.
Draft Initial definition

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support No Yes 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
fieldOfView No 15 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
maximumFieldOfView No No 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
minimumFieldOfView No No 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
offset No 15 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
recommendedFieldOfView No No No No ? ?
renderHeight No 15 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
renderRect No No No No ? ?
renderWidth No 15 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
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.
? ? ? ? 6.0
fieldOfView No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
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.
? ? ? ? 6.0
maximumFieldOfView No No No ? ? ? No
minimumFieldOfView No No No ? ? ? No
offset No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
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.
? ? ? ? 6.0
recommendedFieldOfView No No No ? ? ? No
renderHeight No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
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.
? ? ? ? 6.0
renderRect No No No ? ? ? No
renderWidth No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
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.
? ? ? ? 6.0

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VREyeParameters