Portal Input Api¶

File Hierarchy¶

- Directory portal
  - Directory input
    - File input_events.h
    - File input_manager.cpp
    - File input_manager.h
    - File input_types.h
    - File key_data.h

Class Hierarchy¶

- Namespace portal
  - Enum CursorMode
  - Enum KeyModifierBits
  - Enum KeyState
  - Template Struct FlagTraits< KeyModifierBits >
  - Struct KeyData
  - Struct KeyPressedEvent
  - Struct KeyReleasedEvent
  - Struct KeyRepeatEvent
  - Struct MouseMovedEvent
  - Struct MouseScrolledEvent
  - Struct ReportAnalogAxisEvent
  - Struct ReportKeyActionEvent
  - Struct SetMouseCursorEvent
  - Class InputManager
  - Enum Axis
  - Enum Key

Full API¶

Namespaces¶

Namespace portal
- Classes
- Enums
- Typedefs
- Variables

Classes and Structs¶

Template Struct FlagTraits< KeyModifierBits >
- Struct Documentation
  - portal::FlagTraits< KeyModifierBits >
    - is_bitmask
    - all_flags

Struct KeyData
- Struct Documentation
  - portal::KeyData

Struct KeyPressedEvent
- Struct Documentation
  - portal::KeyPressedEvent
    - key
    - modifiers

Struct KeyReleasedEvent
- Struct Documentation
  - portal::KeyReleasedEvent
    - key

Struct KeyRepeatEvent
- Struct Documentation
  - portal::KeyRepeatEvent
    - key
    - active_modifiers

Struct MouseMovedEvent
- Struct Documentation
  - portal::MouseMovedEvent
    - position

Struct MouseScrolledEvent
- Struct Documentation
  - portal::MouseScrolledEvent
    - offset

Struct ReportAnalogAxisEvent
- Struct Documentation
  - portal::ReportAnalogAxisEvent
    - axis
    - value

Struct ReportKeyActionEvent
- Struct Documentation
  - portal::ReportKeyActionEvent

Struct SetMouseCursorEvent
- Struct Documentation
  - portal::SetMouseCursorEvent
    - mode

Class InputManager
- Inheritance Relationships
  - Base Type
- Class Documentation
  - portal::InputManager

Enums¶

Enum Axis
- Enum Documentation
  - Axis
    - Mouse
    - MouseScroll

Enum CursorMode
- Enum Documentation
  - CursorMode

Enum Key
- Enum Documentation
  - Key
    - Invalid
    - MouseButton0
    - MouseButton1
    - MouseButton2
    - MouseButton3
    - MouseButton4
    - MouseButton5
    - LeftMouseButton
    - RightMouseButton
    - MiddleMouseButton
    - A
    - B
    - C
    - D
    - E
    - F
    - G
    - H
    - I
    - J
    - K
    - L
    - M
    - N
    - O
    - P
    - Q
    - R
    - S
    - T
    - U
    - V
    - W
    - X
    - Y
    - Z
    - Zero
    - One
    - Two
    - Three
    - Four
    - Five
    - Six
    - Seven
    - Eight
    - Nine
    - NumpadZero
    - NumpadOne
    - NumpadTwo
    - NumpadThree
    - NumpadFour
    - NumpadFive
    - NumpadSix
    - NumpadSeven
    - NumpadEight
    - NumpadNine
    - Multiply
    - Add
    - Subtract
    - Decimal
    - Divide
    - LeftShift
    - RightShift
    - LeftControl
    - RightControl
    - LeftAlt
    - RightAlt
    - LeftSystem
    - RightSystem
    - BackSpace
    - Tab
    - Enter
    - Pause
    - CapsLock
    - Escape
    - SpaceBar
    - PageUp
    - PageDown
    - End
    - Home
    - Insert
    - Delete
    - NumLock
    - ScrollLock
    - Left
    - Right
    - Up
    - Down
    - F1
    - F2
    - F3
    - F4
    - F5
    - F6
    - F7
    - F8
    - F9
    - F10
    - F11
    - F12
    - Semicolon
    - Equals
    - Comma
    - Underscore
    - Hyphen
    - Period
    - Slash
    - Tilde
    - LeftBracket
    - RightBracket
    - Backslash
    - Apostrophe
    - Ampersand
    - Asterix
    - Caret
    - Colon
    - Dollar
    - Exclamation
    - LeftParantheses
    - RightParantheses
    - Quote
    - Max

Enum KeyModifierBits
- Enum Documentation
  - KeyModifierBits
    - None
    - Shift
    - Ctrl
    - Alt
    - System
    - CapsLock
    - NumLock

Enum KeyState
- Enum Documentation
  - KeyState

Variables¶

Variable portal::logger
- Variable Documentation
  - logger

Typedefs¶

Typedef portal::KeyModifierFlag
- Typedef Documentation
  - KeyModifierFlag