W3cubDocs

/DOM

VRLayerInit.source

This is an experimental technology
Check 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.1
The definition of 'source' in that specification.
Draft Initial definition

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support No Yes 55
55
Windows support was enabled in Firefox 55.
63
macOS support was enabled in Firefox 63.
No ? ?
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support No 56
Disabled
56
Disabled
Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Daydream View supported in Chrome 56.
Google Cardboard supported in Chrome 57.
Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
? ? ? ? 6.0

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VRLayerInit/source