XRInputSourceArray.forEach()

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

The XRInputSourceArray method forEach() executes the specified callback once for each input source in the array, starting at index 0 and progressing until the end of the list.

Syntax

xrInputSourceArray.forEach(callback, thisArg);

Parameters

callback

A function to execute once for each entry in the array xrInputSourceArray. The callback accepts up to three parameters:

currentValue
A XRInputSource object which is the value of the item from within the xrInputSourceArray which is currently being processed.
currentIndex Optional
An integer value providing the index into the array at which the element given by currentValue is located. If you don't need to know the index number, you can omit this.
sourceList Optional
The XRInputSourceArray object which is being processed. If you don't need this information, you may omit this.
thisArg Optional
The value to be used for this while executing the callback. Note that if you use arrow function notation (=>) to provide the callback, you can omit thisArg, since all arrow functions lexically bind this.

Return value

Undefined.

Examples

This example snippet gets the list of inputs for a session and tries to handle each type of input device it supports using.

let inputSources = xrSession.inputSources;

inputSources.forEach((input) => {
  if (input.gamepad) {
    checkGamepad(input.gamepad);
  } else {
    if (input.targetRayMode === "tracked-pointer" &&
        input.handedness === player.handedness) {
      /* Handle main hand controller */
      handleMainHandInput(input);
    } else {
      /* Handle other inputs */
    }
  }
});

For each input in the llist, the callback dispatches gamepad inputs to a checkGamepad() with the input's Gamepad object, taken from its gamepad property, as an input

For other devices, we look for tracked-pointer devices in the player's main hand, dispatching those to a handleMainHandInput() method.

Specifications

Specification Status Comment
WebXR Device API
The definition of 'XRInputSourceArray' in that specification.
1
Working Draft XRInputSourceArray interface

[1] See Iterator-like methods in Information contained in a WebIDL file for information on how an iterable declaration in an interface definition causes entries(), forEach(), keys(), and values() methods to be exposed from objects that implement the interface.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
forEach()Chrome Full support 79Edge Full support 79Firefox No support NoIE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android Full support 79Firefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android Full support 11.2

Legend

Full support  
Full support
No support  
No support

See also