W3cubDocs

/Web APIs

XRLayerEvent: XRLayerEvent() constructor

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

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

Syntax

js

new XRLayerEvent(type, options)

Parameters

type

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

options

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

layer

The XRLayer to which the event is to be delivered.

Return value

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

Examples

Creating a new XRLayerEvent

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

js

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

quadLayer.dispatchEvent();

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
XRLayerEvent No No No No No No No No No No No No

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/XRLayerEvent/XRLayerEvent