types Namespace

Definition

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

Classes Index

struct	TimerControlContext
	Context describing a requested timer state transition. More...
struct	TimerIdTag
	Tag type for TimerId. More...

Typedefs Index

using	TimerId = helios::ecs::types::StrongId< TimerIdTag >
	Strongly-typed identifier for timers. More...
using	TimerRevision = uint32_t
	Monotonically increasing revision counter for Timer updates. More...

Enumerations Index

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

Typedefs

TimerId

using helios::engine::runtime::timing::types::TimerId = typedef helios::ecs::types::StrongId<TimerIdTag>

Strongly-typed identifier for timers.

Used to uniquely identify timers.

See Also

helios::ecs::types::StrongId

Definition at line 30 of file TimerId.ixx.

30 using TimerId = helios::ecs::types::StrongId<TimerIdTag>;

TimerRevision

using helios::engine::runtime::timing::types::TimerRevision = typedef uint32_t

Monotonically increasing revision counter for Timer updates.

Definition at line 17 of file TimerRevision.ixx.

17 using TimerRevision = uint32_t;

Enumerations

TimerState

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

strong

Represents the state of a Timer.

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

21 Undefined = 0,

22

26 Running = 1,

27

31 Paused = 2,

32

36 Finished = 3,

37

41 Cancelled = 4

42 };

---

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

• TimerId.ixx
• TimerRevision.ixx
• TimerState.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.