XRInputSource

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The WebXR Device API's XRInputSource interface describes a single source of control input which is part of the user's WebXR-compatible virtual or augmented reality system. The device is specific to the platform being used, but provides the direction in which it is being aimed and optionally may generate events if the user triggers performs actions using the device.

Properties

gamepad Read only

A Gamepad object describing the state of the buttons and axes on the XR input source, if it is a gamepad or comparable device. If the device isn't a gamepad-like device, this property's value is null.

gripSpaceRead only

An XRSpace whose origin tracks the pose which is used to render objects which should appear as if they're held in the hand indicated by handedness. The orientation of this space indicates the angle at which the hand is gripping the object. Read on in the main article on gripSpace for more details on how to use this space.

handRead only

An XRHand object providing access to the underlying hand-tracking device.

handednessRead only

A DOMString that indicates which hand the device represented by this XRInputSource is being used in, if any. The value will be left, right, or none.

profilesRead only

An array of DOMString objects, each specifying the name of an input profile describing the preferred visual representation and behavior of this input source.

targetRayModeRead only

A DOMString indicating the methodology used to produce the target ray: gaze, tracked-pointer, or screen.

targetRaySpaceRead only

An XRSpace object defining the origin of the target ray and the direciton in which it extends. This space is established using the method defined by targetRayMode.

Methods

The XRInputSource interface defines no methods.

Usage notes

Actions and the target ray

If the device provides an indication of the direction in which it is pointed, this is done using a target ray. This is a ray extending from the position of the device outward in the direction in which it is pointed.

A target ray emitted by a hand controller.

A screenshot showing a target ray being emitted by a hand controller

If the device includes a trigger or other squeezable input, such as a hand gesture device that recognizes when the user squeezes their fist, that action is called a primary squeeze action. A primary squeeze action should correspond to a gripping act in reality, such as taking hold of an object or pressing a trigger on a tool or weapon. When a squeeze action begins, such as by the user pressing the trigger or tightening their grip, a squeezestart event is sent to the XRSession. Once the action is completed and the user has released the trigger or the grip, a squeeze event is sent. This is followed by a squeezeend, which is also sent if the action is aborted rather than completed.

If the device has a button or other pressable input control, it is a primary input source, and this button is a primary action. A primary action may occur when the user presses a button, clicks on a touchpad or the top button of a thumb stick, or uses a hand gesture or spoken command that invokes the button-like action. When a primary action begins, a selectstart event is sent to the XRSession. When the action has completed (such as when the user releases the button), a select event is sent. Finally, once that is done—or if the user aborts the action—a selectend event is sent to the session object.

An action may be aborted either by the user in some device-specific fashion or if the input device is disconnected before the action is completed.

Local coordinate system

Each input source has its own local coordinate system, which is described by the gripSpace property, which is an XRSpace used to map the input's coordinate system into the world coordinate system. The grip space's coordinate system can then be used to render objects so they appear to be held in the user's hand.

A diagram showing the coordinate system defined by the gripSpace property

For more details on the input source's coordinate system, see the article that covers the gripSpace property in detail.

Specifications

Specification
WebXR Device API
# xrinputsource-interface

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
XRInputSource
79
79
No
No
No
No
No
79
No
No
No
11.2
gamepad
79
79
No
No
No
No
No
79
No
No
No
11.2
gripSpace
79
79
No
No
No
No
No
79
No
No
No
11.2
handedness
79
79
No
No
No
No
No
79
No
No
No
11.2
profiles
79
79
No
No
No
No
No
79
No
No
No
11.2
targetRayMode
79
79
No
No
No
No
No
79
No
No
No
11.2
targetRaySpace
79
79
No
No
No
No
No
79
No
No
No
11.2

See also

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