XRCubeLayer: redraw event

Limited availability

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

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

The redraw event is sent to the XRCubeLayer object when the underlying resources of the layer are lost or when the XR Compositor can no longer reproject the layer. If this event is sent, authors should redraw the content of the layer in the next XR animation frame.

See also the XRCompositionLayer.needsRedraw property which is also available to XRCubeLayer objects through inheritance from XRCompositionLayer.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("redraw", (event) => {});

onredraw = (event) => {};

Event type

An XRLayerEvent. Inherits from Event.

Event properties

In addition to the properties listed below, properties from the parent interface, Event, are available.

layer Read only

The XRLayer which generated the event.

Examples

Using the redraw event

You can pass redraw to addEventListener():

js
cubeLayer.addEventListener("redraw", (event) => {
  // redraw the layer
});

Alternatively, you can use the onredraw event handler property to establish a handler for the redraw event:

js
cubeLayer.onredraw = (event) => {
  // redraw the layer
};

Specifications

Specification
WebXR Layers API Level 1
# dom-xrcubelayer-onredraw

Browser compatibility

BCD tables only load in the browser

See also