Skip to main content

FrameStats

Struct FrameStats 

Source
pub struct FrameStats {
Show 18 fields pub total_objects: u32, pub visible_objects: u32, pub culled_objects: u32, pub draw_calls: u32, pub instanced_batches: u32, pub triangles_submitted: u64, pub shadow_draw_calls: u32, pub cpu_prepare_ms: f32, pub gpu_frame_ms: Option<f32>, pub total_frame_ms: f32, pub render_scale: f32, pub missed_budget: bool, pub upload_bytes: u64, pub gpu_culling_active: bool, pub gpu_visible_instances: Option<u32>, pub shadows_skipped: bool, pub volume_quality_reduced: bool, pub effects_throttled: bool,
}
Expand description

Per-frame rendering statistics returned by crate::ViewportRenderer::prepare.

Fields§

§total_objects: u32

Total objects considered for rendering.

§visible_objects: u32

Objects that passed visibility and frustum tests.

§culled_objects: u32

Objects culled by frustum or visibility.

§draw_calls: u32

Number of draw calls issued in the main pass.

§instanced_batches: u32

Number of instanced batches (0 when using per-object path).

§triangles_submitted: u64

Total triangles submitted to the GPU.

§shadow_draw_calls: u32

Number of draw calls in the shadow pass.

§cpu_prepare_ms: f32

CPU time spent in prepare(), in milliseconds.

§gpu_frame_ms: Option<f32>

GPU scene-pass time in milliseconds, if timestamp queries are available.

Measured with TIMESTAMP_QUERY around the main scene render pass. None on backends that do not support TIMESTAMP_QUERY (e.g. WebGL).

Note: this value reflects the previous frame’s GPU cost due to async readback. The value lags by one frame and should not be used by the adaptation controller across mode transitions.

§total_frame_ms: f32

Wall-clock duration since the previous prepare() call, in milliseconds.

Approximates the full frame interval. Zero on the first frame.

§render_scale: f32

Current internal render scale (1.0 = native resolution).

Reflects the value tracked by the adaptation controller. Values below 1.0 cause the scene to render into a scaled intermediate texture that is bilinearly upscaled to the surface (requires allow_dynamic_resolution).

§missed_budget: bool

True if the last frame exceeded the target frame budget.

Requires target_fps to be set in the PerformancePolicy. Always false when no target is configured.

§upload_bytes: u64

Bytes of geometry data uploaded to the GPU since the previous prepare() call.

Counts full buffer reallocations triggered by crate::ViewportGpuResources::replace_mesh_data and initial uploads via upload_mesh_data / upload_mesh. Uniform buffer writes are not counted.

§gpu_culling_active: bool

True when GPU-driven culling is active this frame.

False when the device does not support INDIRECT_FIRST_INSTANCE or culling has been disabled via disable_gpu_driven_culling().

§gpu_visible_instances: Option<u32>

Number of instances that passed GPU culling and were submitted for drawing.

Populated only when gpu_culling_active is true. None on the first frame or when GPU culling is off. Lags by one frame due to async readback.

§shadows_skipped: bool

True when the shadow depth pass was skipped this frame.

Set when allow_shadow_reduction is true and the previous frame missed the target budget. Always false in RuntimeMode::Capture.

§volume_quality_reduced: bool

True when volume raymarch step size was doubled this frame.

Set when allow_volume_quality_reduction is true and the previous frame missed the target budget. Always false in RuntimeMode::Capture.

§effects_throttled: bool

True when SSAO, contact shadows, and bloom were skipped this frame.

Set when allow_effect_throttling is true and the previous frame missed the target budget. Always false in RuntimeMode::Capture.

Trait Implementations§

Source§

impl Clone for FrameStats

Source§

fn clone(&self) -> FrameStats

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 Debug for FrameStats

Source§

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

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

impl Default for FrameStats

Source§

fn default() -> FrameStats

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

impl Copy for FrameStats

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<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<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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> 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
Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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