Skip to main content

TimerControlContext Struct

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

Declaration​

struct helios::engine::runtime::timing::types::TimerControlContext { ... }

Public Member Attributes Index​

const TimerIdtimerId

The id of the timer to control. More...

const TimerStatetimerState

The target state for the timer. More...

const boolresetElapsed = false

Indicates whether the timer's elapsed seconds should be reset to 0 before applying the new state. More...

Description​

Context describing a requested timer state transition.

Carries the target TimerState and the TimerId of the timer to be controlled.

See Also

TimerControlCommand

See Also

TimerManager

Definition at line 26 of file TimerControlContext.ixx.

Public Member Attributes​

resetElapsed​

const bool helios::engine::runtime::timing::types::TimerControlContext::resetElapsed = false

Indicates whether the timer's elapsed seconds should be reset to 0 before applying the new state.

Definition at line 42 of file TimerControlContext.ixx.

42 const bool resetElapsed = false;

timerId​

const TimerId helios::engine::runtime::timing::types::TimerControlContext::timerId

The id of the timer to control.

Definition at line 31 of file TimerControlContext.ixx.

31 const TimerId timerId;

Referenced by helios::engine::runtime::timing::systems::TimerUpdateSystem< TCommandBuffer >::update.

timerState​

const TimerState helios::engine::runtime::timing::types::TimerControlContext::timerState

The target state for the timer.

Definition at line 36 of file TimerControlContext.ixx.

36 const TimerState timerState;

The documentation for this struct was generated from the following file:

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.