Skip to main content

RendererFrameMetrics

Struct RendererFrameMetrics 

Source
pub struct RendererFrameMetrics { /* private fields */ }
Expand description

CPU-side durations measured while preparing and submitting one renderer frame.

These values do not measure GPU execution or the monitor scanout timestamp. FIFO presentation back-pressure normally appears in surface_acquire because wgpu blocks frame acquisition when the presentation queue is full.

Implementations§

Source§

impl RendererFrameMetrics

Source

pub fn tessellation(self) -> Duration

Returns CPU time spent preparing visual work before GPU uploads.

For an ordinary streaming scene this is validation and tessellation. A heterogeneous FrameComposer frame also includes viewport and source validation, particle visibility selection, scalar LUT generation, and preparation of retained image/glyph draws.

Source

pub fn upload(self) -> Duration

Returns CPU time spent preparing and enqueueing non-camera per-frame GPU data.

Depending on the rendering path this includes transient vertex or instance writes, scalar LUT and pass-uniform uploads, and creation of the per-frame bindings needed by image, glyph, scalar, particle, or composition passes. The camera-only write remains separately available through Self::camera_uniform_upload. This is CPU preparation/enqueue time, not GPU execution time. An ordinary streaming frame can include pre-acquire transient buffer capacity creation here, so a skipped report may have a non-zero duration even though it performed no queue write and reports zero uploaded bytes.

Source

pub fn camera_uniform_upload(self) -> Duration

Returns CPU time spent updating the small per-frame camera uniform.

Source

pub fn surface_acquire(self) -> Duration

Returns CPU time spent acquiring the next presentation surface texture.

In FIFO modes this includes queue back-pressure and is the closest CPU-side approximation to VSync wait exposed by wgpu.

Source

pub fn encode_submit_present(self) -> Duration

Returns CPU time spent encoding, submitting, and dispatching present.

Present dispatch does not mean the monitor has already scanned out the frame; wgpu does not expose that timestamp here.

Source

pub fn total_cpu(self) -> Duration

Returns total CPU time inside the profiled render call.

Source

pub fn geometry_reused(self) -> bool

Returns whether this frame referenced retained visual geometry.

This includes prepared scenes and retained sprite/glyph batches. It is a broad workload-classification hint rather than a statement that the frame performed no uploads, and it can be true together with Self::geometry_streamed.

Source

pub fn geometry_streamed(self) -> bool

Returns whether this frame contained dynamically supplied visual work.

This includes dynamic meshes, particle visibility instances, and scalar field passes. It is a broad workload-classification hint rather than an allocation or upload guarantee, and it can be true together with Self::geometry_reused.

Source

pub fn tessellation_stats(self) -> TessellationStats

Returns command-level tessellation results for this frame.

Trait Implementations§

Source§

impl Clone for RendererFrameMetrics

Source§

fn clone(&self) -> RendererFrameMetrics

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for RendererFrameMetrics

Source§

impl Debug for RendererFrameMetrics

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for RendererFrameMetrics

Source§

fn default() -> RendererFrameMetrics

Returns the “default value” for a type. Read more
Source§

impl Eq for RendererFrameMetrics

Source§

impl PartialEq for RendererFrameMetrics

Source§

fn eq(&self, other: &RendererFrameMetrics) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RendererFrameMetrics

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,