This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The VRStageParameters
interface of the WebVR API represents the values describing the the stage area for devices that support room-scale experiences.
This interface is accessible through the VRDisplay.stageParameters
property.
Properties
VRStageParameters.sittingToStandingTransform
Read only- Contains a matrix that transforms the sitting-space view matrices of
VRFrameData
to standing-space. VRStageParameters.sizeX
Read only- Returns the width of the play-area bounds in meters.
VRStageParameters.sizeY
Read only- Returns the depth of the play-area bounds in meters.
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 'VRStageParameters' in that specification. |
Editor's Draft | Initial definition |
Browser compatibility
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | Yes1 2 | Yes | 553 584 | No | ? | ? |
sittingToStandingTransform | Yes1 2 | Yes | 553 584 | No | ? | ? |
sizeX | Yes1 2 | Yes | 553 584 | No | ? | ? |
sizeY | Yes1 2 | Yes | 553 584 | No | ? | ? |
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|---|---|---|---|---|---|---|
Basic support | No | Yes5 | ? | ? | No | ? | ? |
sittingToStandingTransform | No | Yes5 | ? | ? | No | ? | ? |
sizeX | No | Yes5 | ? | ? | No | ? | ? |
sizeY | No | Yes5 | ? | ? | No | ? | ? |
1. Only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays()
is invoked).
2. This feature is behind the WebVR
preference. To change preferences in Chrome, visit chrome://flags.
3. Windows support was enabled in Firefox 55.
4. macOS support was enabled in Firefox 58.
5. Currently supported only by Google Daydream.
See also
- WebVR API homepage
- MozVr.com — demos, downloads, and other resources from the Mozilla VR team.