VRStageParameters
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see thecompatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
TheVRStageParameters interface of theWebVR API represents the values describing the stage area for devices that support room-scale experiences.
Note:This interface was part of the oldWebVR API. It has been superseded by theWebXR Device API.
This interface is accessible through theVRDisplay.stageParameters property.
Instance properties
VRStageParameters.sittingToStandingTransformDeprecatedRead onlyNon-standardContains a matrix that transforms the sitting-space view matrices of
VRFrameDatato standing-space.VRStageParameters.sizeXDeprecatedRead onlyNon-standardReturns the width of the play-area bounds in meters.
VRStageParameters.sizeYDeprecatedRead onlyNon-standardReturns the depth of the play-area bounds in meters.
Examples
const info = document.querySelector("p");let vrDisplay;navigator.getVRDisplays().then((displays) => { vrDisplay = displays[0]; const stageParams = vrDisplay.stageParameters; // stageParams is a VRStageParameters object if (stageParams === null) { info.textContent = "Your VR Hardware does not support room-scale experiences."; } else { info.innerText = `Sitting to standing transform: ${stageParams.sittingToStandingTransform}Play area width (m): ${stageParams.sizeX}Play area depth (m): ${stageParams.sizeY}`; info.insertBefore( document.createElement("strong"), info.firstChild, ).textContent = "Display stage parameters"; }});Specifications
This interface was part of the oldWebVR API that has been superseded by theWebXR Device API. It is no longer on track to becoming a standard.
Until all browsers have implemented the newWebXR APIs, it is recommended to rely on frameworks, likeA-Frame,Babylon.js, orThree.js, or apolyfill, to develop WebXR applications that will work across all browsers. ReadMeta's Porting from WebVR to WebXR guide for more information.