XRInputSourcesChangeEvent
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
XRInputSourcesChangeEvent
object. The specified type must beinputsourceschange
, which is the only event that uses this interface.
Instance properties
added
Read only-
An array of zero or more
XRInputSource
objects, each representing an input device which has been newly connected or enabled for use. removed
Read only-
An array of zero or more
XRInputSource
objects representing the input devices newly connected or enabled for use. session
Read only-
The
XRSession
to 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
XRSession
when 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.
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 # xrinputsourceschangeevent-interface |
Browser compatibility
BCD tables only load in the browser