VRLayerInit.source

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The source property of the VRLayerInit interface (dictionary) defines the canvas whose contents will be presented by the VRDisplay.

Syntax

var myVRLayerInit = { };
myVRLayerInit.source = myCanvas;

Value

An HTMLCanvasElement or OffscreenCanvas object.

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 'source' in that specification.	Editor's Draft	Initial definition

Feature	Chrome	Edge	Firefox (Gecko)	Internet Explorer	Opera	Safari (WebKit)
Basic support	No support^[1]	(Yes)	55 (55)^[2]	No support	No support	No support

Feature	Android	Edge	Firefox Mobile (Gecko)	IE Phone	Opera Mobile	Safari Mobile	Chrome for Android	Samsung Internet for GearVR
Basic support	No support	No support	55.0 (55)	No support	No support	No support	(Yes)^[3]	(Yes)

[1] API Available on all platforms behind a flag, but currently only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays() is invoked).

[2] Currently only Windows support is enabled by default. Mac support is available in Firefox Nightly.

[3] Currently supported only by Google Daydream.

Syntax

Value

Examples

Specifications

Browser compatibility

See also

Document Tags and Contributors