VRDisplay.getEyeParameters()

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

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

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 [1].

Browser compatibility

BCD tables only load in the browser

See also