VRDisplay: getEyeParameters() method

{{APIRef("WebVR API")}}{{Deprecated_Header}}{{Non-standard_Header}}

The getEyeParameters() method of the {{domxref("VRDisplay")}} interface returns the {{domxref("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 {{domxref("VREyeParameters")}} object, or null if the VR is not able to present content (e.g., {{domxref("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

{{Compat}}

See also

• WebVR API