VRLayerInit
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 thecompatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
TheVRLayerInit dictionary of theWebVR API represents a content layer (anHTMLCanvasElement orOffscreenCanvas) that you want to present in a VR display.
Note:This dictionary was part of the oldWebVR API. It has been superseded by theWebXR Device API.
You can retrieveVRLayerInit objects usingVRDisplay.getLayers(), and present them using theVRDisplay.requestPresent() method.
Instance properties
VRLayerInit.leftBoundsDeprecatedDefines the left texture bounds of the canvas whose contents will be presented by the
VRDisplay.VRLayerInit.rightBoundsDeprecatedDefines the right texture bounds of the canvas whose contents will be presented by the
VRDisplay.VRLayerInit.sourceDeprecatedDefines the canvas whose contents will be presented by the
VRDisplaywhenVRDisplay.submitFrame()is called.
Examples
// currently returns an empty arraylet layers = vrDisplay.getLayers();if (navigator.getVRDisplays) { console.log("WebVR 1.1 supported"); // Then get the displays attached to the computer navigator.getVRDisplays().then((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", () => { vrDisplay.requestPresent([{ source: canvas }]).then(() => { console.log("Presenting to WebVR display"); // Here it returns an array of VRLayerInit objects layers = vrDisplay.getLayers(); // … }); }); } });}VRLayerInit objects look something like this:
const init = { leftBounds: [ /* … */ ], rightBounds: [ /* … */ ], source: canvasReference,};Note:ThecanvasReference refers to the<canvas> element itself, not the WebGL context associated with the canvas. The other two members are arrays
Specifications
This dictionary was part of the oldWebVR API that has been superseded by theWebXR Device API. It is no longer on track to becoming a standard.
Until all browsers have implemented the newWebXR APIs, it is recommended to rely on frameworks, likeA-Frame,Babylon.js, orThree.js, or apolyfill, to develop WebXR applications that will work across all browsers. ReadMeta's Porting from WebVR to WebXR guide for more information.