VRDisplay.getEyeParameters()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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

Syntax

var myEyeParameters = vrDisplayInstance.getEyeParameters(whichEye);

Parameters

whichEye
A DOMString 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

TBD.

Specifications

Specification Status Comment
WebVR
The definition of 'getEyeParameters()' in that specification.
Editor's Draft Initial definition

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes) (Yes) No support No support No support
Feature Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support No support (Yes) No support No support No support No support

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,