W3cubDocs

/DOM

VRStageParameters

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.
Draft Initial definition

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support No Yes 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
sittingToStandingTransform No Yes 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
sizeX No Yes 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
sizeY No Yes 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
Google Cardboard supported in Chrome 57.
Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
? ? ? ? 6.0
sittingToStandingTransform No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
Google Cardboard supported in Chrome 57.
Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
? ? ? ? 6.0
sizeX No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
Google Cardboard supported in Chrome 57.
Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
? ? ? ? 6.0
sizeY No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
Google Cardboard supported in Chrome 57.
Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
? ? ? ? 6.0

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VRStageParameters