XRInputSourceEvent: XRInputSourceEvent() 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 XRInputSourceEvent() constructor creates and returns a new XRInputSourceEvent object describing an event (state change) which has occurred on a WebXR user input device represented by an XRInputSource.

Syntax

js
new XRInputSourceEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to select, selectend, selectstart, squeeze, squeezeend, squeezestart.

options

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

frame

An XRFrame object representing the event frame during which the event took place. This event is not associated with the animation process, and has no viewer information contained within it.

inputSource

An XRInputSource object representing the input device from which the event is being sent.

Return value

A new XRInputSourceEvent object representing the event described by the given type and eventInitDict.

Examples

This example creates a new select event and sends it to the XRSession.

js
let event = new XRInputSourceEvent("select", {
  frame: eventFrame,
  inputSource: source,
});
if (event) {
  xrSession.dispatchEvent(event);
}

Specifications

Specification
WebXR Device API
# dom-xrinputsourceevent-xrinputsourceevent

Browser compatibility