VREyeParameters

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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 HMDVRDevice.getEyeParameters method.

Properties

VREyeParameters.minimumFieldOfView Read only
Describes the minimum supported field of view for the current eye.
VREyeParameters.maximumFieldOfView Read only
Describes the maximum supported field of view for the current eye.
VREyeParameters.recommendedFieldOfView Read only
Describes the recommended field of view for the current eye — ideally based on user calibration.
VREyeParameters.eyeTranslation Read only
Represents the offset from the center of the user's head to the eye, measured in meters.
VREyeParameters.currentFieldOfView Read only
Describes the current field of view for the eye, as specified using HMDVRDevice.setFieldOfView. It defaults to VREyeParameters.recommendedFieldOfView.
VREyeParameters.renderRect Read only
Specifies the viewport of a canvas into which visuals for the current eye should be rendered.

Examples

The following example is taken from the Mozilla VR Team's threejs-vr-boilerplate code — to be precise, the VREffect.js file. Early on in the code the HMDVRDevice.getEyeParameters method is used to access information about each eye — VREyeParameters.eyeTranslation and VREyeParameters.recommendedFieldOfView — which are used for rendering calulations later on.

if ( vrHMD.getEyeParameters !== undefined ) {

    var eyeParamsL = vrHMD.getEyeParameters( 'left' );
    var eyeParamsR = vrHMD.getEyeParameters( 'right' );

    eyeTranslationL = eyeParamsL.eyeTranslation;
    eyeTranslationR = eyeParamsR.eyeTranslation;
    eyeFOVL = eyeParamsL.recommendedFieldOfView;
    eyeFOVR = eyeParamsR.recommendedFieldOfView;

} else {

  ...

}

Specifications

Specification Status Comment
WebVR
The definition of 'VREyeParameters' in that specification.
Editor's Draft Initial definition

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes)[1] 39 (39)[2] No support No support No support
Feature Android Firefox Mobile (Gecko) Firefox OS (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support No support 39.0 (39)[2]
44.0 (44)[3]
No support No support No support No support No support
  • [1] The support in Chrome is currently experimental. To find information on Chrome's WebVR implementation status including supporting builds, check out Bringing VR to Chrome by Brandon Jones.
  • [2] The support for this feature is currently disabled by default in Firefox. To enable WebVR support in Firefox Nightly/Developer Edition, you can go to about:config and enable the dom.vr* prefs. A better option however is to install the WebVR Enabler Add-on, which does this for you and sets up other necessary parts of the environment.
  • [3] The dom.vr* prefs are enabled by default at this point, in Nightly/Aurora editions.

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, Sebastianz
 Last updated by: chrisdavidmills,