Experimental
This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The stageParameters
read-only property of the VRDisplay
interface returns a VRStageParameters
object containing room-scale parameters, if the VRDisplay
is capable of supporting room-scale experiences.
Syntax
var myStageParameters = vrDisplayInstance.stageParameters;
Value
VRStageParameters
object containing the VRDisplay
's room-scale parameters, or null
if the VRDisplay
is not capable of supporting room-scale experiences.
Examples
var info = document.querySelector('p');
var vrDisplay;
navigator.getVRDisplays().then(function(displays) {
vrDisplay = displays[0];
var stageParams = vrDisplay.stageParameters;
// stageParams is a VRStageParameters object
if(stageParams === null) {
info.textContent = 'Your VR Hardware does not support room-scale experiences.'
} else {
info.innerHTML = '<strong>Display stage parameters</strong>'
+ '<br>Sitting to standing transform: ' + stageParams.sittingToStandingTransform
+ '<br>Play area width (m): ' + stageParams.sizeX
+ '<br>Play area depth (m): ' + stageParams.sizeY
}
});
Specifications
Specification | Status | Comment |
---|---|---|
WebVR 1.1 The definition of 'stageParameters' 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.