This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.
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 areleft
andright
(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
navigator.getVRDisplays().then(function(displays) {
// If a display is available, use it to present the scene
vrDisplay = displays[0];
console.log('Display found');
// Starting the presentation when the button is clicked:
// It can only be called in response to a user gesture
btn.addEventListener('click', function() {
vrDisplay.requestPresent([{ source: canvas }]).then(function() {
console.log('Presenting to WebVR display');
// Set the canvas size to the size of the vrDisplay viewport
var leftEye = vrDisplay.getEyeParameters('left');
var rightEye = vrDisplay.getEyeParameters('right');
canvas.width = Math.max(leftEye.renderWidth, rightEye.renderWidth) * 2;
canvas.height = Math.max(leftEye.renderHeight, rightEye.renderHeight);
drawVRScene();
});
});
});
Specifications
Specification | Status | Comment |
WebVR 1.1The definition of 'getEyeParameters()' in that specification. | Draft | Initial definition |
Browser compatibility
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
No support No |
Edge
No support 15 — 79 |
Firefox Full support 55 Full support 55 Notes' Windows support was enabled in Firefox 55. Full support 64 Notes' macOS support was enabled in Firefox 64. |
IE
No support No |
Opera
? |
Safari
No support No |
WebView Android
No support No |
Chrome Android No support 56 — 80 No support 56 — 80 Notes' Only works in an experimental version of Chrome. (Other builds won't return any devices when |
Firefox Android
Full support 55 |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android Full support 6.0 Full support 6.0 Notes' Google Cardboard supported in Samsung Internet 7.0. |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
- Deprecated. Not for use in new websites.'
- Deprecated. Not for use in new websites.
- See implementation notes.'
- See implementation notes.
- User must explicitly enable this feature.'
- User must explicitly enable this feature.
See also
- WebVR API homepage
- MozVr.com — demos, downloads, and other resources from the Mozilla VR team.
VRDisplay.getEyeParameters() by Mozilla Contributors is licensed under CC-BY-SA 2.5.