Struct StreamingConfig 

pub struct StreamingConfig {
    pub texture_budget: u32,
    pub texture_cap: u32,
    pub mesh_budget: u32,
    pub mesh_cap: u32,
    pub texture_budget_mb: u32,
    pub mesh_budget_mb: u32,
}

Enables and tunes asset streaming.

When no StreamingConfig is declared, streaming is off and every texture and mesh is loaded up front. When one is present, textures and static mesh geometry load in gradually after startup: each frame the nearest not-yet- loaded items are brought in, up to a per-frame budget, prioritised by camera distance. Once more than the cap would be loaded at once, the farthest are dropped to make room.

Texture streaming covers the colour and normal-map textures (each capped independently via texture_budget / texture_cap). Mesh streaming covers static geometry; the skybox, rooms, and moving props always stay loaded.

Fields

texture_budget: u32

Maximum number of textures whose load is started per frame, applied independently to the colour and normal-map pools. A low value spreads the cost over more frames.

texture_cap: u32

Maximum number of textures kept loaded at once, applied independently to the colour and normal-map pools. When exceeded, the farthest-from-camera textures are dropped.

mesh_budget: u32

Maximum number of mesh regions whose load is started per frame. A low value spreads the cost over more frames.

mesh_cap: u32

Maximum number of meshes kept loaded at once. When exceeded, the farthest-from-camera meshes are dropped.

texture_budget_mb: u32

Resident-texture memory budget in mebibytes, spanning the colour and normal-map pools together. Once resident textures exceed it the farthest-from-camera ones are dropped, so nearer textures always win the space. 0 (the default) derives the budget from the GPU’s reported memory instead. texture_cap still applies as a hard item-count ceiling.

mesh_budget_mb: u32

Resident-mesh memory budget in mebibytes. Once resident meshes exceed it the farthest-from-camera ones are dropped. 0 (the default) derives the budget from the GPU’s reported memory instead. mesh_cap still applies as a hard item-count ceiling.

Implementations

impl StreamingConfig

pub fn budget(&self) -> usize

Per-frame texture load budget as a usize, floored at 1 so a stray 0 cannot wedge streaming permanently.

pub fn cap(&self) -> usize

Resident-texture cap as a usize, floored at 1.

pub fn mesh_budget(&self) -> usize

Per-frame mesh load budget as a usize, floored at 1.

pub fn mesh_cap(&self) -> usize

Resident-mesh cap as a usize, floored at 1.

Trait Implementations

impl Clone for StreamingConfig

fn clone(&self) -> StreamingConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for StreamingConfig

const NAME: &'static str = "StreamingConfig"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<StreamingConfig, 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 StreamingConfig

const DISCRIMINANT: u8

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

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

Borrow this type’s column out of the storage.

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

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

impl Debug for StreamingConfig

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

Formats the value using the given formatter.

impl Default for StreamingConfig

fn default() -> StreamingConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StreamingConfig

where StreamingConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StreamingConfig> for ComponentAsset

fn from(c: StreamingConfig) -> ComponentAsset

Converts to this type from the input type.

impl RuntimeComponent for StreamingConfig

impl Serialize for StreamingConfig

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.