Skip to main content

types Namespace

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

Definition​

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

Classes Index​

structTimerControlContext

Context describing a requested timer state transition. More...

Typedefs Index​

usingTimerRevision = uint32_t

Monotonically increasing revision counter for GameTimer updates. More...

Enumerations Index​

enum classTimerState { ... }

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​

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
UndefinedTimer state is undefined (initial value) (= 0)
StartedTimer is actively accumulating time (= 1)
PausedTimer is paused; elapsed time is preserved (= 2)
StoppedTimer is stopped (= 3)

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 Started = 1,
27
28 /**
29 * @brief Timer is paused; elapsed time is preserved.
30 */
31 Paused = 2,
32
33 /**
34 * @brief Timer is stopped.
35 */
36 Stopped = 3
37
38 };

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.