Experimental
This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The VREyeParameters
interface of the WebVR API represents all the information required to correctly render a scene for a given eye, including field of view information.
This interface is accessible through the VRDisplay.getEyeParameters()
method.
The values in this interface should not be used to compute view or projection matrices. In order to ensure the widest possible hardware compatibility use the matrices provided by VRFrameData
.
Properties
VREyeParameters.offset
Read only- Represents the offset from the center point between the user's eyes to the center of the eye, measured in meters.
VREyeParameters.fieldOfView
Read only- Describes the current field of view for the eye, which can vary as the user adjusts their interpupillary distance (IPD).
VREyeParameters.renderWidth
Read only- Describes the recommended render target width of each eye viewport, in pixels.
VREyeParameters.renderHeight
Read only- Describes the recommended render target height of each eye viewport, in pixels.
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.1 The definition of 'VREyeParameters' in that specification. |
Draft | Initial definition |
Browser compatibility
BCD tables only load in the browser
See also
- WebVR API homepage
- https://mixedreality.mozilla.org/ — demos, downloads, and other resources from the Mozilla VR team.