XRInputSourceEvent: inputSource property

{{APIRef("WebXR Device API")}}{{SecureContext_Header}}

The {{domxref("XRInputSourceEvent")}} interface's read-only inputSource property specifies the {{domxref("XRInputSource")}} which generated the input event. This information lets you handle the event appropriately given the particulars of the user input device being manipulated.

Value

An {{domxref("XRInputSource")}} object identifying the source of the user input event. This event indicates an action the user has taken using a WebXR input controller, such as a hand controller, motion sensing device, or other input apparatus.

Examples

The snippet below shows a handler for the {{domxref("XRSession.select_event", "select")}} event which looks specifically for events which happen on gaze input devices. The device type is identified by looking at the {{domxref("XRInputSource")}} in inputSource and its {{domxref("XRInputSource.targetRayMode", "targetRayMode")}} property.

xrSession.onselect = (event) => {
  let source = event.inputSource;

  if (source.targetRayMode === "gaze") {
    /* handle selection using a gaze input */
  }
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}