XRInputSourceArray.entries()

The XRInputSourceArray interface's entries() method returns a JavaScript iterator which can then be used to iterate over the key/value pairs in the input source array. Each item in the array is an XRInputSource object.

Most frequently, you will use this in tandem with statements such as for...of.

Syntax

let inputSourceIterator = xrInputSourceArray.entries();

for (let entry of xrInputSourceArray.entries()) {
  /* ... */
}

Parameters

None.

Return value

An iterator which can be used to walk through the list of XRInputSource objects included in the input source array.

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 sources = xrSession.inputSources;

for (let input of sources.entries()) {
  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, gamepad inputs are dispatched 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

[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