VRDisplay.getEyeParameters()

Deprecated

This 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 getEyeParameters() method of the VRDisplay interface returns the VREyeParameters object containing the eye parameters for the specified eye.

Syntax

var myEyeParameters = vrDisplayInstance.getEyeParameters(whichEye);

Parameters

whichEye
A DOMString representing the eye you want to return the eye parameters for. Available values are left and right (defined in the VREye enum).

Return value

A VREyeParameters object, or null if the VR is not able to present content (e.g. VRDisplayCapabilities.canPresent returns false).

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 'getEyeParameters()' in that specification.
Draft Initial definition

Browser compatibility

BCD tables only load in the browser

See also