VRDisplay: getEyeParameters() method

Deprecated

Avoid using this feature in new projects. Development of the WebVR API halted in favor of WebXR. This feature may be a candidate for removal from web standards or browsers.

Consider using the following features instead: WebXR.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The getEyeParameters() method of the VRDisplay interface returns the VREyeParameters object containing the eye parameters for the specified eye.

Note: This method was part of the old WebVR API. It has been superseded by the WebXR Device API.

Syntax

js
getEyeParameters(whichEye)

Parameters

whichEye

A string 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

See VREyeParameters for example code.

Specifications

This method 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