Skip to main content

RenderStats

Struct RenderStats 

Source
pub struct RenderStats {
    pub draw_calls: u32,
    pub objects: u32,
    pub skinned_visible: u32,
    pub skinned_pool_free: u32,
    pub gpu_frame_us: u32,
    pub vram_bytes: u64,
    pub transient_pool_bytes: u64,
    pub pass_times_us: [(&'static str, u32); 32],
    pub auto_exposure_ev: Option<f32>,
    pub max_edr: Option<f32>,
}
Expand description

Per-frame render-backend statistics.

Fields§

§draw_calls: u32

CPU-issued geometry draw calls this frame: the shadow, main, and composite + text passes. The optional screen-space-effect passes (SSR, SSAO, TAA, bloom) issue a fixed handful of fullscreen draws and are not counted here – gpu_frame_us still covers their GPU time.

§objects: u32

Renderable objects in the scene this frame: static draw objects, every instanced-cluster instance, and skinned meshes.

§skinned_visible: u32

Visible skinned objects this frame: the authored skinned meshes plus any live runtime-spawned instances, excluding the hidden pre-reserved instance-pool slots. Unlike objects (which counts the whole pre-reserved pool and so stays flat across skinned spawn/despawn), this tracks the live count, so a spawn bumps it and a despawn drops it.

§skinned_pool_free: u32

Free slots remaining in the pre-reserved skinned instance pool across all templates. Drains by one when a skinned instance spawns and refills when one despawns, so a probe can watch the free-list recycle directly.

§gpu_frame_us: u32

GPU execution time of the most recently completed frame, in microseconds. Reported one or more frames late: the GPU timestamps are only known once that frame’s command buffer completion handler fires.

§vram_bytes: u64

Bytes of GPU memory currently allocated by the render device. On unified-memory hardware (Apple Silicon) this is the device’s share of system memory rather than dedicated VRAM.

§transient_pool_bytes: u64

Bytes the render graph’s transient pool holds: the aliased footprint of the slots backing the graph-owned transients. Part of vram_bytes, which is a device-wide total; carried separately so the shared memory ledger can attribute it rather than leaving it in the unaccounted remainder.

§pass_times_us: [(&'static str, u32); 32]

Per-pass GPU microseconds for the most recently completed frame. Filled by the active backend only when its GPU supports timestamp sampling; otherwise every slot stays at the default ("", 0). Slot order is backend-defined and stable for the process lifetime.

§auto_exposure_ev: Option<f32>

Current adapted exposure value (EV) from the auto-exposure EMA. None when the world did not opt in to auto-exposure (or the active backend has not yet wired the readout). The StatHud overlay reads this to render the on-screen EV chip; downstream consumers can map it to an exposure multiplier via 2^ev.

§max_edr: Option<f32>

Active display’s reported maximum extended-range colour-component multiplier when the renderer is on the HDR path. Some(2.0) on a typical HDR400 panel, Some(8.0+) on HDR1000-class panels; None on SDR (because the world disabled HDR, the platform fell back, or the active backend has not wired the readout). The StatHud overlay reads this to render the on-screen EDR chip; the value is also the linear scaling factor between SDR reference white and the panel’s peak brightness, so a colour-grading consumer can interpret it directly.

Trait Implementations§

Source§

impl Clone for RenderStats

Source§

fn clone(&self) -> RenderStats

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 RenderStats

Source§

impl Debug for RenderStats

Source§

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

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

impl Default for RenderStats

Source§

fn default() -> RenderStats

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

impl PartialEq for RenderStats

Source§

fn eq(&self, other: &RenderStats) -> 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 RenderStats

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<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more