Class InputDeviceHandler

constructor

• new InputDeviceHandler(options?: InputDeviceHandlerOptions): InputDeviceHandler

  Parameters

  • options: InputDeviceHandlerOptions = {}

  Returns InputDeviceHandler

gamepadDeadZoneSettings

globalDeadZone

getLastPollResults

• getLastPollResults(): AllDevices

  This does not trigger a new poll of devices. Thus, the value retrieved here might be out of date. For example, if you previously paused polling, the returned value here would be from right before polling was paused.

  Returns AllDevices

pausePollingLoop

• pausePollingLoop(): void

  Stop the internal loop for polling input devices.

  Returns void

readAllDevices

• readAllDevices(
      deadZoneSettings?: Readonly<
          { [key: string]: Readonly<{ [inputName: string]: number }> },
      >,
      timestamp?: number,
      globalDeadZone?: number,
  ): AllDevices

  Updates the internal state of all current devices and triggers all relevant listeners.

  Use this if method if you're hooking up polling to your own system. For example, if you already have a render loop, call this method to update all inputs and read their values.

  If you just want to read the last values but already have InputDeviceHandler running its loop, instead call getLastPollResults.

  Parameters

  • deadZoneSettings: Readonly<{ [key: string]: Readonly<{ [inputName: string]: number }> }> = ...
  • timestamp: number = ...
  • globalDeadZone: number = ...

    DeadZone for all inputs.

  Returns AllDevices

startPollingLoop

• startPollingLoop(): void

  Start an internal loop which polls all devices on each animation frame.

  Returns void