XRReferenceSpaceEvent: XRReferenceSpaceEvent() constructor

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.

The XRReferenceSpaceEvent() constructor is used to create a new XRReferenceSpaceEvent object, which represents an event regarding the state of a WebXR reference space object, XRReferenceSpace.

Syntax

js
new XRReferenceSpaceEvent(type, options)

Parameters

type

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

options

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

referenceSpace

The XRReferenceSpace from which the event originates.

transform

An XRRigidTransform which maps the old coordinate system (from before the changes indicated by this event) to the new coordinate system.

Return value

A new XRReferenceSpaceEvent object, initialized as defined by the input parameters.

Examples

This simple snippet calls the constructor to create a new reference space event of type reset.

js
let refSpaceEvent = new XRReferenceSpaceEvent("reset", {
  referenceSpace: myRefSpace,
  transform: myTransform,
});

Specifications

Specification
WebXR Device API
# dom-xrreferencespaceevent-xrreferencespaceevent

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
XRReferenceSpaceEvent() constructor
Chrome – Full support
Chrome 79 (Release date: 2019-12-10)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – No support
Firefox
footnote No support
Opera – Full support
Opera 66 (Release date: 2020-01-07)
footnote Full support
Safari – No support
Safari
footnote No support
Chrome Android – Full support
Chrome Android 79 (Release date: 2019-12-17)
footnote Full support
Firefox for Android – No support
Firefox for Android
footnote No support
Opera Android – Full support
Opera Android 57 (Release date: 2020-03-30)
footnote Full support
Safari on iOS – No support
Safari on iOS
footnote No support
Samsung Internet – Full support
Samsung Internet 11.2 (Release date: 2020-03-22)
footnote Full support
WebView Android – No support
WebView Android
footnote No support
WebView on iOS – No support
WebView on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support