Struct Diagnostics

pub struct Diagnostics<'w, 's> { /* private fields */ }

Record new DiagnosticMeasurement’s.

Implementations

impl<'w, 's> Diagnostics<'w, 's>

pub fn add_measurement<F>(&mut self, path: &DiagnosticPath, value: F)

where F: FnOnce() -> f64,

Add a measurement to an enabled Diagnostic. The measurement is passed as a function so that it will be evaluated only if the Diagnostic is enabled. This can be useful if the value is costly to calculate.

Trait Implementations

impl SystemParam for Diagnostics<'_, '_>

type State = FetchState

Used to store data which persists across invocations of a system.

type Item<'w, 's> = Diagnostics<'w, 's>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next apply_deferred.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's> ReadOnlySystemParam for Diagnostics<'w, 's>

where Res<'w, DiagnosticsStore>: ReadOnlySystemParam, Deferred<'s, DiagnosticsBuffer>: ReadOnlySystemParam,