W3cubDocs

HMDVRDevice.getEyeParameters

Obsolete
This 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 technology
Check 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 {
  ...
}

Specifications

Specification	Status	Comment
Unknown The definition of 'getEyeParameters()' in that specification.	Unknown	Initial definition

Browser compatibilityUpdate compatibility data on GitHub

	Desktop
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari
Basic support	No	No	39 Disabled 39 Disabled 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.	No	No	No

	Mobile
	Android webview	Chrome for Android	Edge Mobile	Firefox for Android	Opera for Android	iOS Safari	Samsung Internet
Basic support	No	62 62 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.	No	44 44 The `dom.vr` prefs are enabled by default at this point, in Nightly/Aurora editions. 39 — 44 Disabled 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.	No	No	No

HMDVRDevice.getEyeParameters

Syntax

Parameters

Returns

Examples

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also