XRRenderState.baseLayer

Draft
This page is not complete.

Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The read-only baseLayer property of the XRRenderState interface returns the XRWebGLLayer instance that is the source of bitmap images and a description of how the image is to be rendered in the device.

This property is read-only; however, you can indirectly change its value using  XRSession.updateRenderState.

Syntax

var xrWebGLLayer = xrRenderState.baseLayer;

Value

A XRWebGLLayer object which is used as the source of the world's contents when rendering each frame of the scene.

See the examples below to see how to use updateRenderState() to set the current XRWebGLLayer used for rendering the scene.

Examples

You can set the XRWebGLLayer used for rendering by calling updateRenderState(), like this:

let canvas = document.querySelector("canvas");
gl = canvas.getContext("webgl", { xrCompatible: true });
setNewWebGLLayer();

function setNewWebGLLayer(gl) {
  if (!gl) {
    /* WebGL not available */
    return;
  }

  xrSession.updateRenderState({
    baseLayer: new XRWebGLLayer(xrSession, gl);
  });
};

Here, the canvas obtained in the first line is the canvas into which WebGL is going to draw. That context is passed into new XRWebGLLayer() to create an XRWebGLLayer which uses the contents of the WebGL context gl as the source of the world's image during presentation.

Specifications

Specification Status Comment
WebXR Device API
The definition of 'XRRenderState.baseLayer' in that specification.
Working Draft Initial definition.

Browser compatibility

No compatibility data found. Please contribute data for "api.XRRenderState.baseLayer" (depth: 1) to the MDN compatibility data repository.