types Namespace

Definition

namespace helios::engine::input::types { ... }

Enumerations Index

enum class	GamepadInput { ... }
	Bitmask enum for gamepad input buttons. More...
enum	Gamepad { ... }
	Enumerates gamepad identifiers in bitmask-friendly values. More...
enum	Key { ... }
	Enumerates common keyboard keys. More...

Enumerations

Gamepad

enum helios::engine::input::types::Gamepad

Enumerates gamepad identifiers in bitmask-friendly values.

Enumeration values

ONE	(= 1)
TWO	(= 2)
THREE	(= 4)
FOUR	(= 8)
size_	Number of logical gamepad entries represented by this enum (= 4)

This enumeration provides identifiers for gamepads, commonly identified by the logical port they are mapped to. Values are chosen for convenient bitmask composition (ONE | TWO, ...).

Implementing APIs should map their platform-specific gamepad indices to these identifiers.

Definition at line 110 of file Gamepad.ixx.

110 enum Gamepad {

111 ONE = 1, // 1

112 TWO = 2, // 10

113 THREE = 4, // 100

114 FOUR = 8, // 1000

115

116

117

121 size_ = 4

122 };

GamepadInput

enum class helios::engine::input::types::GamepadInput

strong

Bitmask enum for gamepad input buttons.

Enumeration values

Start	Start button (= 1 << 0)
Select	Select/Back button (= 1 << 5)
A	A button (bottom face button) (= 1 << 1)
B	B button (right face button) (= 1 << 2)
X	X button (left face button) (= 1 << 3)
Y	Y button (top face button) (= 1 << 4)
LeftStick	Left stick button (L3) (= 1 << 6)
RightStick	Right stick button (R3) (= 1 << 7)
Up	D-pad up (= 1 << 8)
Down	D-pad down (= 1 << 9)
Left	D-pad left (= 1 << 10)
Right	D-pad right (= 1 << 11)
LeftBumper	Left bumper (L1) (= 1 << 12)
RightBumper	Right bumper (R1) (= 1 << 13)
LeftTrigger	Left trigger (L2) (= 1 << 14)
RightTrigger	Right trigger (R2) (= 1 << 15)

Each value represents a single button as a bit flag, allowing efficient combination and querying of multiple inputs.

Definition at line 17 of file Gamepad.ixx.

17 enum class GamepadInput {

18

22 Start = 1 << 0,

23

27 Select = 1 << 5,

28

32 A = 1 << 1,

33

37 B = 1 << 2,

38

42 X = 1 << 3,

43

47 Y = 1 << 4,

48

52 LeftStick = 1 << 6,

53

57 RightStick = 1 << 7,

58

62 Up = 1 << 8,

63

67 Down = 1 << 9,

68

72 Left = 1 << 10,

73

77 Right = 1 << 11,

78

82 LeftBumper = 1 << 12,

83

87 RightBumper = 1 << 13,

88

92 LeftTrigger = 1 << 14,

93

97 RightTrigger = 1 << 15

98 };

Key

enum helios::engine::input::types::Key

Enumerates common keyboard keys.

Enumeration values

ESC
TILDE
size_	Number of logical gamepad entries represented by this enum (= 4)

This enumeration provides identifiers for various keyboard keys. It's intended to be a platform-agnostic representation of physical keys.

Implementing APIs are advised to properly map their implementation against this enumeration.

Definition at line 20 of file Key.ixx.

20 enum Key {

21

22 ESC,

23

24 TILDE,

25

29 size_

30 };

---

The documentation for this namespace was generated from the following files:

• Gamepad.ixx
• Key.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.