SuperDex Physics C++ API
Loading...
Searching...
No Matches
superdex::PerformanceStats Struct Reference

Timing and profiling metrics from the last simulation step. More...

#include <mochi_structs.h>

Public Member Functions

bool operator== (PerformanceStats const &) const =default

Public Attributes

double postStepCallbacksDurationSec = 0.0
 Wall-clock time [s] spent executing user-defined post-step callbacks in the last call to Scene::Step.
double preStepCallbacksDurationSec = 0.0
 Wall-clock time [s] spent executing user-defined pre-step callbacks in the last call to Scene::Step.
double recordingStepDurationSec = 0.0
 Wall-clock time [s] spent on recording in the last call to Scene::Step.
double solveStepDurationSec = 0.0
 Wall-clock time [s] spent solving physics in the last call to Scene::Step.
double totalStepDurationSec = 0.0
 Total wall-clock time [s] spent in the last call to Scene::Step.

Detailed Description

Timing and profiling metrics from the last simulation step.

See also
Scene::GetPerformanceStats

Definition at line 497 of file mochi_structs.h.

Member Function Documentation

◆ operator==()

bool superdex::PerformanceStats::operator== ( PerformanceStats const & ) const
default

Member Data Documentation

◆ postStepCallbacksDurationSec

double superdex::PerformanceStats::postStepCallbacksDurationSec = 0.0

Wall-clock time [s] spent executing user-defined post-step callbacks in the last call to Scene::Step.

Definition at line 504 of file mochi_structs.h.

◆ preStepCallbacksDurationSec

double superdex::PerformanceStats::preStepCallbacksDurationSec = 0.0

Wall-clock time [s] spent executing user-defined pre-step callbacks in the last call to Scene::Step.

Definition at line 502 of file mochi_structs.h.

◆ recordingStepDurationSec

double superdex::PerformanceStats::recordingStepDurationSec = 0.0

Wall-clock time [s] spent on recording in the last call to Scene::Step.

Definition at line 506 of file mochi_structs.h.

◆ solveStepDurationSec

double superdex::PerformanceStats::solveStepDurationSec = 0.0

Wall-clock time [s] spent solving physics in the last call to Scene::Step.

Note
Does not include time spent in user-defined pre-step and post-step callbacks.

Definition at line 500 of file mochi_structs.h.

◆ totalStepDurationSec

double superdex::PerformanceStats::totalStepDurationSec = 0.0

Total wall-clock time [s] spent in the last call to Scene::Step.

Note
Includes time spent in user-defined pre-step and post-step callbacks.

Definition at line 498 of file mochi_structs.h.


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