Struct DiagnosticsRecorder 

pub struct DiagnosticsRecorder(/* private fields */);

Records diagnostics into QuerySet’s keeping track of the mapping between spans and indices to the corresponding entries in the QuerySet.

Implementations

impl DiagnosticsRecorder

pub fn new( adapter_info: &RenderAdapterInfo, device: &RenderDevice, queue: &RenderQueue, ) -> DiagnosticsRecorder

Creates the new DiagnosticsRecorder.

pub fn begin_frame(&mut self)

Begins recording diagnostics for a new frame.

pub fn resolve(&mut self, encoder: &mut CommandEncoder)

Copies data from QuerySet’s to a Buffer, after which it can be downloaded to CPU.

Should be called before DiagnosticsRecorder::finish_frame.

pub fn finish_frame( &mut self, device: &RenderDevice, callback: impl FnOnce(RenderDiagnostics) + Send + Sync + 'static, )

Finishes recording diagnostics for the current frame.

The specified callback will be invoked when diagnostics become available.

Should be called after DiagnosticsRecorder::resolve, and after all commands buffers have been queued.

Trait Implementations

impl Component for DiagnosticsRecorder

where DiagnosticsRecorder: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<DiagnosticsRecorder>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl FromWorld for DiagnosticsRecorder

fn from_world(world: &mut World) -> DiagnosticsRecorder

Creates Self using data from the given World.

impl RecordDiagnostics for DiagnosticsRecorder

fn record_f32<N>( &self, command_encoder: &mut CommandEncoder, buffer: &BufferSlice<'_>, name: N, )

where N: Into<Cow<'static, str>>,

Reads a f32 from the specified buffer and uploads it as a diagnostic.

fn record_u32<N>( &self, command_encoder: &mut CommandEncoder, buffer: &BufferSlice<'_>, name: N, )

where N: Into<Cow<'static, str>>,

Reads a u32 from the specified buffer and uploads it as a diagnostic.

fn time_span<E, N>( &self, encoder: &mut E, name: N, ) -> TimeSpanGuard<'_, Self, E>

where E: WriteTimestamp, N: Into<Cow<'static, str>>,

Begin a time span, which will record elapsed CPU and GPU time.

fn pass_span<P, N>(&self, pass: &mut P, name: N) -> PassSpanGuard<'_, Self, P>

where P: Pass, N: Into<Cow<'static, str>>,

Begin a pass span, which will record elapsed CPU and GPU time, as well as pipeline statistics on supported platforms.

impl Resource for DiagnosticsRecorder

where DiagnosticsRecorder: Send + Sync + 'static,