XRCompositionLayer

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The XRCompositionLayer interface of the WebXR Device API is a base class that defines a set of common properties and behaviors for WebXR layer types. It is not constructable on its own.

Several layer types inherit from XRCompositionLayer:

XRCompositionLayer itself inherits from the general XRLayer class (which inherits from EventTarget).

EventTarget XRLayer XRCompositionLayer

Instance properties

XRCompositionLayer.blendTextureSourceAlpha

A boolean enabling the layer's texture alpha channel.

XRCompositionLayer.layout Read only

The layout type of the layer.

XRCompositionLayer.mipLevels Read only

The number of mip levels in the color and texture data for the layer.

XRCompositionLayer.needsRedraw Read only

A boolean signaling that the layer should be re-rendered in the next frame.

Instance methods

Inherits methods from its parent, EventTarget.

XRCompositionLayer.destroy()

Deletes the underlying layer attachments.

Specifications

Specification
WebXR Layers API Level 1
# xrcompositionlayertype

Browser compatibility

BCD tables only load in the browser

See also