W3cubDocs

/Web APIs

XRInputSourceEvent: inputSource property

The XRInputSourceEvent interface's read-only inputSource property specifies the 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 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 select event which looks specifically for events which happen on gaze input devices. The device type is identified by looking at the XRInputSource in inputSource and its targetRayMode property.

js

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

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
inputSource 79 79 No No 66 No No 79 No 57 No 11.2

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/XRInputSourceEvent/inputSource