Struct StatHud 

pub struct StatHud {
    pub fps_label: Option<AssetId>,
    pub vram_label: Option<AssetId>,
    pub ram_label: Option<AssetId>,
    pub ev_label: Option<AssetId>,
    pub edr_label: Option<AssetId>,
}

Requests the default on-screen stats HUD. Drives a set of TextLabel chips with live engine stats, refreshed on a fixed interval.

Each label field, when set, receives one chip: fps_label the averaged frame rate, vram_label the GPU-memory use, ram_label the host process memory (resident set size, against the memory budget when known), ev_label the auto-exposure value, and edr_label the HDR headroom multiplier. Chips whose stat is unavailable stay blank. The frame-rate and GPU-memory chips are shown or hidden from the in-game video settings (“Display performance stats”); the host-memory, exposure, and HDR chips show whenever their reading is available.

The chips are packed into a tight strip anchored at the top-left of the window, left to right in the order fps, vram, ram, ev, edr; a blank chip reserves no width, so hidden readouts leave no gap. Their on-screen position is fixed by the engine rather than the authored coordinates.

Developer-facing readouts (per-pass GPU timings, cursor position, live camera pose) live on the separate DebugHud, toggled with F1.

A world that declares a MainMenu receives a StatHud from the build when it declares none, since the menu’s performance-stats toggles drive the chips, and any label field left unset receives a chip at start. So the example below is only needed to restyle the chips or run a HUD without a menu. Declare an EngineDefaults with "hud": false to leave the chips unfilled.

Fields

fps_label: Option<AssetId>

TextLabel that receives the frame-rate chip text.

vram_label: Option<AssetId>

TextLabel that receives the GPU-memory chip text.

ram_label: Option<AssetId>

TextLabel that receives the host-memory (RSS) chip text.

ev_label: Option<AssetId>

TextLabel that receives the auto-exposure chip text.

edr_label: Option<AssetId>

TextLabel that receives the HDR-headroom chip text.

Trait Implementations

impl Authored for StatHud

const TYPE: &'static str = "StatHud"

The registered asset type, as it appears in a world line’s type.

impl Clone for StatHud

fn clone(&self) -> StatHud

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for StatHud

const NAME: &'static str = "StatHud"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<StatHud, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).

fn inject_name(&mut self, _id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.

impl ComponentSlot for StatHud

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.

fn slot(s: &ComponentStorage) -> &Column<StatHud>

Borrow this type’s column out of the storage.

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<StatHud>

Mutably borrow this type’s column out of the storage.

impl Debug for StatHud

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

Formats the value using the given formatter.

impl Default for StatHud

fn default() -> StatHud

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StatHud

where StatHud: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<StatHud, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl RuntimeComponent for StatHud

impl Serialize for StatHud

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.