Web/API/HMDVRDevice/getEyeParameters

ObsoleteThis feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The getEyeParameters() method of the HMDVRDevice interface returns current parameters for the eye specified as its argument ("left" or "right") — stored in a VREyeParameters object.

This includes field of view information, and more.

Syntax

var myLeftEye = HMDVRDevice.getEyeParameters('left');

Parameters

whichEye: A DOMString representing the eye you want to return information about. The value can be left or right.

Returns

A VREyeParameters object.

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 getEyeParameters() method is used to access information about each eye, which is then 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 {
  ...
}

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`getEyeParameters` Deprecated'Non-standard'	Chrome No support No	Edge No support No	Firefox Full support 39 Notes' Disabled' Full support 39 Notes' Disabled' Notes' 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 Disabled' From version 39: this feature is behind the `dom.vr` preference. To change preferences in Firefox, visit about:config.**	IE No support No	Opera No support No	Safari No support No	WebView Android No support No	Chrome Android Full support 62 Notes' Full support 62 Notes' Notes' 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.	Firefox Android Full support 44 Notes' Full support 44 Notes' Notes' *The `dom.vr` prefs are enabled by default at this point, in Nightly/Aurora editions. No support 39 — 44 Notes' Disabled'** Notes' 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. Disabled' From version 39 until version 44 (exclusive): this feature is behind the `dom.vr` preference. To change preferences in Firefox, visit about:config.**	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support 8.0

Legend

Full support: Full support
No support: No support
Non-standard. Expect poor cross-browser support.': Non-standard. Expect poor cross-browser support.
Deprecated. Not for use in new websites.': Deprecated. Not for use in new websites.
See implementation notes.': See implementation notes.
User must explicitly enable this feature.': User must explicitly enable this feature.