XRLayerEvent: XRLayerEvent() constructor

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.

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

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

The XRLayerEvent constructor creates and returns a new XRLayerEvent object. These events relate to a change of state of an XRLayer object.

Syntax

new XRLayerEvent(type, options)

A string with the name of the event. It is case-sensitive and browsers always set it to redraw.

An object that, in addition of the properties defined in Event(), can have the following properties:

A new XRLayer object representing an object of the specified type and configured as described by the eventInitDict parameter.

In this example, a new redraw event is created for an XRQuadLayer.

const redrawEvent = new XRLayerEvent("redraw", {
  layer: quadLayer,
});

quadLayer.dispatchEvent();

Specification
WebXR Layers API Level 1 # dom-xrlayerevent-xrlayerevent

Was this page helpful to you?

Yes No

This page was last modified on Feb 5, 2024 by MDN contributors.