TheWebXR Device API'sXRInputSource 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.

Instance properties

gamepadRead only

AGamepad 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 isnull.

gripSpaceRead only

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

handRead only

AnXRHand object providing access to the underlying hand-tracking device.

handednessRead only

A string that indicates which hand the device represented by thisXRInputSource is being used in, if any. The value will beleft,right, ornone.

profilesRead only

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

targetRayModeRead only

A string indicating the methodology used to produce the target ray:gaze,tracked-pointer, orscreen.

targetRaySpaceRead only

AnXRSpace object defining the origin of the target ray and the direction in which it extends. This space is established using the method defined bytargetRayMode.

Instance methods

TheXRInputSource 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 atarget 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.

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 aprimary 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, asqueezestart event is sent to theXRSession. Once the action is completed and the user has released the trigger or the grip, asqueeze event is sent. This is followed by asqueezeend, 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 aprimary input source, and this button is aprimary 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, aselectstart event is sent to theXRSession. When the action has completed (such as when the user releases the button), aselect event is sent. Finally, once that is done—or if the user aborts the action—aselectend 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 thegripSpace property, which is anXRSpace 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.

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

Specifications

Browser compatibility

See also

• WebXR Device API
• Inputs and input sources
• XRInputSourceArray
• XRSpace