a3d::SimulationConfig Struct Reference

Initial simulation scheduling parameters supplied to a Runner. More...

#include <a3d/SimulationConfig.h>

Public Attributes
double	timeStep {1.0 / 60.0}
	Initial duration, in seconds, of each simulation step. More...
std::uint32_t	maxCatchUpSteps {8}
	Initial maximum automatic simulation steps performed by one update. More...
double	timeScale {1.0}
	Initial multiplier applied to elapsed host time for automatic simulation stepping. More...

Detailed Description

Initial simulation scheduling parameters supplied to a Runner.

Runner copies this structure at construction. Values are validated when Runner::start() is called. Runtime-configurable values are exposed individually by Runner rather than by exposing the copied configuration.

See also

Runner

Definition at line 25 of file SimulationConfig.h.

Member Data Documentation

maxCatchUpSteps

std::uint32_t a3d::SimulationConfig::maxCatchUpSteps {8}

Initial maximum automatic simulation steps performed by one update.

The value must be at least one. Any whole accumulated steps remaining after this limit is reached are discarded while the fractional remainder is retained.

Definition at line 44 of file SimulationConfig.h.

timeScale

double a3d::SimulationConfig::timeScale {1.0}

Initial multiplier applied to elapsed host time for automatic simulation stepping.

The value must be positive. A value of 1.0 advances simulation at the host-time rate. Requested paused steps ignore this scale.

Definition at line 52 of file SimulationConfig.h.

timeStep

double a3d::SimulationConfig::timeStep {1.0 / 60.0}

Initial duration, in seconds, of each simulation step.

The value must be positive. It is used by both automatic catch-up steps and explicitly requested paused steps.

Definition at line 35 of file SimulationConfig.h.

---

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

• a3d/SimulationConfig.h