XRInputSourcesChangeEvent
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 WebXR Device API interface XRInputSourcesChangeEvent is used to represent the inputsourceschange event sent to an XRSession when the set of available WebXR input controllers changes.
Constructor
XRInputSourcesChangeEvent()-
Creates and returns a new
XRInputSourcesChangeEventobject. The specified type must beinputsourceschange, which is the only event that uses this interface.
Instance properties
addedRead only-
An array of zero or more
XRInputSourceobjects, each representing an input device which has been newly connected or enabled for use. removedRead only-
An array of zero or more
XRInputSourceobjects representing the input devices newly connected or enabled for use. sessionRead only-
The
XRSessionto which this input source change event is being directed.
Instance methods
While XRInputSourcesChangeEvent defines no methods of its own, it inherits methods from its parent interface, Event.
Event types
inputsourceschange-
Delivered to the
XRSessionwhen the set of input devices available to it changes.
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 to display them in the next animation frame.
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:
xrSession.oninputsourceschange = onInputSourcesChange;
Specifications
| Specification |
|---|
| WebXR Device API> # xrinputsourceschangeevent-interface> |
Browser compatibility
Loading…