VREyeParameters

Instance 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.maximumFieldOfView Read only

Describes the maximum supported field of view for the current eye.

VREyeParameters.minimumFieldOfView Read only

Describes the minimum supported field of view for the current eye.

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((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", () => {
    vrDisplay.requestPresent([{ source: canvas }]).then(() => {
      console.log("Presenting to WebVR display");

      // Set the canvas size to the size of the vrDisplay viewport

      const leftEye = vrDisplay.getEyeParameters("left");
      const rightEye = vrDisplay.getEyeParameters("right");

      canvas.width = Math.max(leftEye.renderWidth, rightEye.renderWidth) * 2;
      canvas.height = Math.max(leftEye.renderHeight, rightEye.renderHeight);

      drawVRScene();
    });
  });
});

Specifications

This interface was part of the old WebVR API that has been superseded by the WebXR Device API. It is no longer on track to becoming a standard.

Until all browsers have implemented the new WebXR APIs, it is recommended to rely on frameworks, like A-Frame, Babylon.js, or Three.js, or a polyfill, to develop WebXR applications that will work across all browsers. Read Meta's Porting from WebVR to WebXR guide for more information.

Browser compatibility

See also

• WebVR API