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 insecure contexts (HTTPS), in some or allsupporting browsers.
The WebXR Device API interfaceXRInputSourcesChangeEvent
is used to represent theinputsourceschange
event sent to anXRSession
when the set of available WebXR input controllers changes.
In this article
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 onlyAn array of zero or more
XRInputSource
objects, each representing an input device which has been newly connected or enabled for use.removed
Read onlyAn array of zero or more
XRInputSource
objects representing the input devices newly connected or enabled for use.session
Read onlyThe
XRSession
to which this input source change event is being directed.
Instance methods
WhileXRInputSourcesChangeEvent
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 usesinputsourceschange
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 forinputsourceschange
events by setting theoninputsourceschange
event handler:
xrSession.oninputsourceschange = onInputSourcesChange;
Specifications
Specification |
---|
WebXR Device API> # xrinputsourceschangeevent-interface> |
Browser compatibility
Loading…