ludus::input¶
Ludus Wiki ยท API overview ยท Browse API
Namespace
Declared in modules/input/include/ludus/input/actions.h
Related declarations¶
- ludus::input::ActionState
- ludus::input::Binding
- ludus::input::BindingMap
- ludus::input::FocusBaseline
- ludus::input::InputCounters
- ludus::input::InputDebugTrace
- ludus::input::InputSystem
- ludus::input::KeyboardRecord
- ludus::input::KeyboardSnapshot
- ludus::input::StepEvent
- ludus::input::TraceEntry
Enumerations¶
ActionKind¶
enum class ActionKind : uint8
Related types: uint8
Button¶
Button
Axis1D¶
Axis1D
Declared in modules/input/include/ludus/input/actions.h
AxisDirection¶
enum class AxisDirection : uint8
Related types: uint8
Positive¶
Positive
Negative¶
Negative
Declared in modules/input/include/ludus/input/actions.h
BindingStatus¶
enum class BindingStatus : uint8
Related types: uint8
Ok¶
Ok
InvalidAction¶
InvalidAction
InvalidKey¶
InvalidKey
CapacityExceeded¶
CapacityExceeded
ConflictingType¶
ConflictingType
DuplicateBinding¶
DuplicateBinding
Declared in modules/input/include/ludus/input/actions.h
ActionStatus¶
enum class ActionStatus : uint8
Related types: uint8
Ok¶
Ok
InvalidAction¶
InvalidAction
Declared in modules/input/include/ludus/input/actions.h
TraceKind¶
enum class TraceKind : uint8
Related types: uint8
Transition¶
Transition
IgnoredTransition¶
IgnoredTransition
ResetBoundary¶
ResetBoundary
Overflow¶
Overflow
Declared in modules/input/include/ludus/input/input_debug.h
Key¶
enum class Key : uint16
Related types: uint16
Unknown¶
Unknown = 0
KeyA¶
KeyA
KeyB¶
KeyB
KeyC¶
KeyC
KeyD¶
KeyD
KeyE¶
KeyE
KeyF¶
KeyF
KeyG¶
KeyG
KeyH¶
KeyH
KeyI¶
KeyI
KeyJ¶
KeyJ
KeyK¶
KeyK
KeyL¶
KeyL
KeyM¶
KeyM
KeyN¶
KeyN
KeyO¶
KeyO
KeyP¶
KeyP
KeyQ¶
KeyQ
KeyR¶
KeyR
KeyS¶
KeyS
KeyT¶
KeyT
KeyU¶
KeyU
KeyV¶
KeyV
KeyW¶
KeyW
KeyX¶
KeyX
KeyY¶
KeyY
KeyZ¶
KeyZ
Digit0¶
Digit0
Digit1¶
Digit1
Digit2¶
Digit2
Digit3¶
Digit3
Digit4¶
Digit4
Digit5¶
Digit5
Digit6¶
Digit6
Digit7¶
Digit7
Digit8¶
Digit8
Digit9¶
Digit9
Minus¶
Minus
Equal¶
Equal
BracketLeft¶
BracketLeft
BracketRight¶
BracketRight
Backslash¶
Backslash
Semicolon¶
Semicolon
Quote¶
Quote
Backquote¶
Backquote
Comma¶
Comma
Period¶
Period
Slash¶
Slash
Space¶
Space
Enter¶
Enter
Tab¶
Tab
Backspace¶
Backspace
Escape¶
Escape
Insert¶
Insert
Delete¶
Delete
Home¶
Home
End¶
End
PageUp¶
PageUp
PageDown¶
PageDown
ArrowLeft¶
ArrowLeft
ArrowRight¶
ArrowRight
ArrowUp¶
ArrowUp
ArrowDown¶
ArrowDown
CapsLock¶
CapsLock
PrintScreen¶
PrintScreen
ScrollLock¶
ScrollLock
Pause¶
Pause
F1¶
F1
F2¶
F2
F3¶
F3
F4¶
F4
F5¶
F5
F6¶
F6
F7¶
F7
F8¶
F8
F9¶
F9
F10¶
F10
F11¶
F11
F12¶
F12
F13¶
F13
F14¶
F14
F15¶
F15
F16¶
F16
F17¶
F17
F18¶
F18
F19¶
F19
F20¶
F20
F21¶
F21
F22¶
F22
F23¶
F23
F24¶
F24
NumLock¶
NumLock
KeypadDivide¶
KeypadDivide
KeypadMultiply¶
KeypadMultiply
KeypadSubtract¶
KeypadSubtract
KeypadAdd¶
KeypadAdd
KeypadEnter¶
KeypadEnter
KeypadDecimal¶
KeypadDecimal
Keypad0¶
Keypad0
Keypad1¶
Keypad1
Keypad2¶
Keypad2
Keypad3¶
Keypad3
Keypad4¶
Keypad4
Keypad5¶
Keypad5
Keypad6¶
Keypad6
Keypad7¶
Keypad7
Keypad8¶
Keypad8
Keypad9¶
Keypad9
ShiftLeft¶
ShiftLeft
ShiftRight¶
ShiftRight
ControlLeft¶
ControlLeft
ControlRight¶
ControlRight
AltLeft¶
AltLeft
AltRight¶
AltRight
SuperLeft¶
SuperLeft
SuperRight¶
SuperRight
Menu¶
Menu
Count¶
Count
Declared in modules/input/include/ludus/input/key.h
AdmissionStatus¶
enum class AdmissionStatus : uint8
Related types: uint8
Accepted¶
Accepted
Ignored¶
Ignored
RejectedInvalid¶
RejectedInvalid
RecoveredWithLoss¶
RecoveredWithLoss
Declared in modules/input/include/ludus/input/keyboard.h
StepStatus¶
enum class StepStatus : uint8
Related types: uint8
Ok¶
Ok
InvalidStep¶
InvalidStep
SequenceExhausted¶
SequenceExhausted
Declared in modules/input/include/ludus/input/keyboard.h
RecordSource¶
enum class RecordSource : uint8
Related types: uint8
Native¶
Native
Synthetic¶
Synthetic
Replay¶
Replay
Declared in modules/input/include/ludus/input/keyboard_event.h
KeyTransition¶
enum class KeyTransition : uint8
Related types: uint8
Down¶
Down
Up¶
Up
Declared in modules/input/include/ludus/input/keyboard_event.h
ResetReason¶
enum class ResetReason : uint8
Related types: uint8
None¶
None = 0
FocusLost¶
FocusLost
FocusEntered¶
FocusEntered
WindowClosed¶
WindowClosed
CapabilityLost¶
CapabilityLost
SeatRemoved¶
SeatRemoved
BackendDisconnected¶
BackendDisconnected
Overflow¶
Overflow
MapReplaced¶
MapReplaced
ExplicitNeutral¶
ExplicitNeutral
ExplicitLive¶
ExplicitLive
Declared in modules/input/include/ludus/input/keyboard_event.h
Aliases¶
ActionId¶
using ludus::input::ActionId = uint16
Related types: uint16
Declared in modules/input/include/ludus/input/actions.h
float32¶
using ludus::foundation::core::float32 = float
Declared in modules/input/include/ludus/input/actions.h
uint16¶
using ludus::foundation::core::uint16 = std::uint16_t
Declared in modules/input/include/ludus/input/actions.h
uint8¶
using ludus::foundation::core::uint8 = std::uint8_t
Declared in modules/input/include/ludus/input/actions.h
uint32¶
using ludus::foundation::core::uint32 = std::uint32_t
Declared in modules/input/include/ludus/input/input_debug.h
uint64¶
using ludus::foundation::core::uint64 = std::uint64_t
Declared in modules/input/include/ludus/input/input_debug.h
uint8¶
using ludus::foundation::core::uint8 = std::uint8_t
Declared in modules/input/include/ludus/input/input_debug.h
usize¶
using ludus::foundation::core::usize = std::size_t
Declared in modules/input/include/ludus/input/input_debug.h
uint16¶
using ludus::foundation::core::uint16 = std::uint16_t
Declared in modules/input/include/ludus/input/key.h
usize¶
using ludus::foundation::core::usize = std::size_t
Declared in modules/input/include/ludus/input/key.h
uint32¶
using ludus::foundation::core::uint32 = std::uint32_t
Declared in modules/input/include/ludus/input/keyboard.h
uint64¶
using ludus::foundation::core::uint64 = std::uint64_t
Declared in modules/input/include/ludus/input/keyboard.h
uint8¶
using ludus::foundation::core::uint8 = std::uint8_t
Declared in modules/input/include/ludus/input/keyboard.h
usize¶
using ludus::foundation::core::usize = std::size_t
Declared in modules/input/include/ludus/input/keyboard.h
uint32¶
using ludus::foundation::core::uint32 = std::uint32_t
Declared in modules/input/include/ludus/input/keyboard_event.h
uint64¶
using ludus::foundation::core::uint64 = std::uint64_t
Declared in modules/input/include/ludus/input/keyboard_event.h
uint8¶
using ludus::foundation::core::uint8 = std::uint8_t
Declared in modules/input/include/ludus/input/keyboard_event.h
Constants and variables¶
TRACE_CAPACITY¶
constexpr usize ludus::input::TRACE_CAPACITY = 256
Related types: usize
Declared in modules/input/include/ludus/input/input_debug.h
KEY_COUNT¶
constexpr usize ludus::input::KEY_COUNT = static_cast<usize>(Key::Count)
Related types: usize
Declared in modules/input/include/ludus/input/key.h
PENDING_CAPACITY¶
constexpr usize ludus::input::PENDING_CAPACITY = 256
Related types: usize
Declared in modules/input/include/ludus/input/keyboard.h
ACTION_CAPACITY¶
constexpr usize ludus::input::ACTION_CAPACITY = 64
Related types: usize
Declared in modules/input/include/ludus/input/keyboard.h
BINDING_CAPACITY¶
constexpr usize ludus::input::BINDING_CAPACITY = 256
Related types: usize
Declared in modules/input/include/ludus/input/keyboard.h
Functions¶
IsValidKey¶
constexpr bool ludus::input::IsValidKey(Key key) noexcept
key is a real, in-range key that may index key storage. Related types: Key
Declared in modules/input/include/ludus/input/key.h
KeyIndex¶
constexpr usize ludus::input::KeyIndex(Key key) noexcept
Declared in modules/input/include/ludus/input/key.h
DebugLabel¶
const char * ludus::input::DebugLabel(Key key) noexcept
Related types: Key