Web/API/VRLayerInit/source

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

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.1The definition of 'source' in that specification.	Draft	Initial definition

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`source` Experimental'Deprecated'	Chrome No support No	Edge No support ≤18 — 79	Firefox Full support 55 Notes' Full support 55 Notes' Notes' Windows support was enabled in Firefox 55. Full support 64 Notes' Notes' macOS support was enabled in Firefox 64.	IE No support No	Opera ?	Safari No support No	WebView Android No support No	Chrome Android No support 56 — 80 Notes' Disabled' No support 56 — 80 Notes' Disabled' Notes' Only works in an experimental version of Chrome. (Other builds won't return any devices when `Navigator.getVRDisplays()` is invoked.) Notes' Daydream View supported in Chrome 56. Notes' Google Cardboard supported in Chrome 57. Disabled' From version 56 until version 80 (exclusive): this feature is behind the `WebVR` preference. To change preferences in Chrome, visit chrome://flags.	Firefox Android Full support 55	Opera Android ?	Safari iOS ?	Samsung Internet Android Full support 6.0 Notes' Full support 6.0 Notes' Notes' Google Cardboard supported in Samsung Internet 7.0.

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.
Deprecated. Not for use in new websites.': Deprecated. Not for use in new websites.
See implementation notes.': See implementation notes.
User must explicitly enable this feature.': User must explicitly enable this feature.