types Namespace

Core type definitions for the timing module. More...

Definition

namespace helios::engine::mechanics::timing::types { ... }

Classes Index

struct	GameTimerIdTag
	Tag type for GameTimerId. More...
struct	TimerControlContext
	Context describing a requested timer state transition. More...

Typedefs Index

using	GameTimerId = helios::core::data::StrongId< GameTimerIdTag, uint32_t >
	Strongly-typed identifier for gameTimers. More...
using	TimerRevision = uint32_t
	Monotonically increasing revision counter for GameTimer updates. More...

Enumerations Index

enum class	TimerState { ... }
	Represents the state of a GameTimer. More...

Description

Core type definitions for the timing module.

Contains state enums, revision counters, and context structs used across the timing subsystem.

Typedefs

GameTimerId

using helios::engine::mechanics::timing::types::GameTimerId = helios::core::data::StrongId<GameTimerIdTag, uint32_t>

Strongly-typed identifier for gameTimers.

Used to uniquely identify gameTimers.

See Also

helios::core::data::StrongId

Definition at line 30 of file GameTimerId.ixx.

30 using GameTimerId = helios::core::data::StrongId<GameTimerIdTag, uint32_t>;

TimerRevision

using helios::engine::mechanics::timing::types::TimerRevision = uint32_t

Monotonically increasing revision counter for GameTimer updates.

Definition at line 17 of file TimerRevision.ixx.

17 using TimerRevision = uint32_t;

Enumerations

TimerState

enum class helios::engine::mechanics::timing::types::TimerState

strong

Represents the state of a GameTimer.

Enumeration values

Undefined	Timer state is undefined (initial value) (= 0)
Running	Timer is actively accumulating time (= 1)
Paused	Timer is paused; elapsed time is preserved (= 2)
Finished	Timer is finished (= 3)
Cancelled	Timer was cancelled (= 4)

Definition at line 16 of file TimerState.ixx.

16 enum class TimerState {

17

18 /**

19 * @brief Timer state is undefined (initial value).

20 */

21 Undefined = 0,

22

23 /**

24 * @brief Timer is actively accumulating time.

25 */

26 Running = 1,

27

28 /**

29 * @brief Timer is paused; elapsed time is preserved.

30 */

31 Paused = 2,

32

33 /**

34 * @brief Timer is finished.

35 */

36 Finished = 3,

37

38 /**

39 * @brief Timer was cancelled.

40 */

41 Cancelled = 4

42 };

---

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

• GameTimerId.ixx
• TimerRevision.ixx
• TimerState.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.