XRReferenceSpaceEvent()

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.

Currently, only the reset event is defined using this type.

Syntax

new XRReferenceSpaceEvent(type, eventInitDict)

Parameters

type

A DOMString indicating the event type which has occurred. Currently, this is always reset.

eventInitDict

An object to configure the event. The properties are:

  • 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 coordiante 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.

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

Specifications

Specification
WebXR Device API
# dom-xrreferencespaceevent-xrreferencespaceevent

Browser compatibility

BCD tables only load in the browser