XRLayerEvent

Limited availability

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

Want more browser support for this feature? Tell us why.

Learn more
See full compatibility

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 XRLayerEvent interface of the WebXR Device API is the event type for events related to a change of state of an XRLayer object. These events occur, for example, when the layer needs to be redrawn.

Event XRLayerEvent

Constructor

XRLayerEvent(): Creates and returns a new XRLayerEvent object.

Instance properties

In addition to properties inherited from its parent interface, Event, XRLayerEvent provides the following:

layer Read only: The XRLayer which generated the event.

Instance methods

While XRSessionEvent defines no methods, it inherits methods from its parent interface, Event.

Event types

The following events are represented using the XRLayerEvent interface, and are permitted values for its type parameter.

`redraw` event

The redraw event is tent to the layer 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. It is available on the following layer objects: