Class InputInformation

Descriptor used for initializing the Input module.

Constructors

  • Parameters

    • OptionalisKBRawInputEnabled: boolean
    • OptionalisMouseRawInputEnabled: boolean
    • OptionalisRawInputEmulated: boolean

    Returns InputInformation

Properties

_isKBRawInputEnabled: boolean
_isMouseRawInputEnabled: boolean
_isRawInputEmulated: boolean

Accessors

  • get isKBRawInputEnabled(): boolean
  • If true, raw keyboard events will be read from a specialized input sub-system (e.g. GameInput). If false you are expected to call Input::_notify* methods manually to provide such events.

    Disabling this is useful if some other library has acquired exclusive access to such events and they're not available, or if such events require too high OS permissions.

    Returns boolean

  • set isKBRawInputEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isMouseRawInputEnabled(): boolean
  • If true, raw mouse events will be read from a specialized input sub-system (e.g. GameInput). If false you are expected to call Input::_notify* methods manually to provide such events.

    Disabling this is useful if some other library has acquired exclusive access to such events and they're not available, or if such events require too high OS permissions.

    Returns boolean

  • set isMouseRawInputEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isRawInputEmulated(): boolean
  • If true the raw input events for mouse and keyboard will be emulated through normal OS input. This can be helpful on OS such as macOS which requires additional input permissions for actual raw input. This does not affect gamepads.

    Returns boolean

    Currently this is supported only on macOS.

  • set isRawInputEmulated(value): void
  • Parameters

    • value: boolean

    Returns void

Methods