XRSession: inputsourceschange event
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The inputsourceschange
event is sent to an XRSession
when the set of available WebXR input devices changes.
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
js
addEventListener("inputsourceschange", (event) => {});
oninputsourceschange = (event) => {};
Event type
An XRInputSourcesChangeEvent
. Inherits from Event
.
Event properties
In addition to the properties listed below, properties from the parent interface, Event
, are available.
added
Read only-
An array of zero or more
XRInputSource
objects, each representing an input device which has been recently connected or enabled. removed
Read only-
An array of zero or more
XRInputSource
objects representing the input devices recently disconnected or disabled. session
Read only-
The
XRSession
to which this input source change event is being directed.
Description
Trigger
Triggered when the set of available WebXR input devices changes.
Use cases
You can use this event to detect newly-available devices or when devices have become unavailable.
Examples
The following example shows how to set up an event handler which uses inputsourceschange
events to detect newly-available pointing devices and to load their models in preparation for displaying them in the next animation frame.
js
xrSession.addEventListener("inputsourceschange", onInputSourcesChange);
function onInputSourcesChange(event) {
for (const input of event.added) {
if (input.targetRayMode === "tracked-pointer") {
loadControllerMesh(input);
}
}
}
You can also add a handler for inputsourceschange
events by setting the oninputsourceschange
event handler:
js
xrSession.oninputsourceschange = onInputSourcesChange;
Specifications
Specification |
---|
WebXR Device API # eventdef-xrsession-inputsourceschange |
WebXR Device API # dom-xrsession-oninputsourceschange |
Browser compatibility
BCD tables only load in the browser