VRStageParameters

Experimental

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 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 compatibility

BCD tables only load in the browser