VRDisplay.getLayers()

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 the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The getLayers() method of the VRDisplay interface returns the layers currently being presented by the VRDisplay.

Syntax

var myLayers = vrDisplayInstance.getLayers();

Parameters

None.

Return value

If the VRDisplay is presenting, this method returns an array of the VRLayerInit objects currently being presented (this will currently be one, as VRDisplayCapabilities.maxLayers is currently always 1). If the VRDisplay is not presenting, this method returns an empty array.

Examples

// currently returns an empty array
var layers = vrDisplay.getLayers();

if(navigator.getVRDisplays) {
  console.log('WebVR 1.1 supported');
  // Then get the displays attached to the computer
  navigator.getVRDisplays().then(function(displays) {
    // If a display is available, use it to present the scene
    if(displays.length > 0) {
      vrDisplay = displays[0];
      console.log('Display found');
      // Starting the presentation when the button is clicked: It can only be called in response to a user gesture
      btn.addEventListener('click', function() {
        vrDisplay.requestPresent([{ source: canvas }]).then(function() {
          console.log('Presenting to WebVR display');

          // Here it returns an array of VRLayerInit objects
          var layers = vrDisplay.getLayers();

          ...
        });
      });
    }
  });
}

VRLayerInit objects look something like this:

{
  leftBounds : [ ... ],
  rightBounds: [ ... ],
  source: canvasReference
}

Note: The canvasReference refers to the <canvas> element itself, not the WebGL context associated with the canvas. The other two members are arrays

Specifications

Specification Status Comment
WebVR 1.1
The definition of 'getLayers()' in that specification.
Draft Initial definition

Browser compatibility

BCD tables only load in the browser

See also