Struct Assets 

pub struct Assets<T: AssetSource> { /* private fields */ }

Holds every loaded asset of type T — both its CPU-side source and (once uploaded) its GPU-side processed form, together. Registering AssetPlugin::<Backend, T>::new() drains newly-inserted/dirty entries automatically each tick; insert/get/get_source are the everyday API.

Implementations

impl<T: AssetSource> Assets<T>

pub fn new() -> Self

pub fn insert(&mut self, name: &str, source: T) -> Handle<T>

Inserts source under name, queuing it for upload. Inserting under a name that already exists replaces that entry (and marks it dirty again) instead of creating a second one.

pub fn get(&self, handle: Handle<T>) -> Option<&T::Processed>

The GPU-side processed value, if it’s finished uploading.

pub fn get_source(&self, handle: Handle<T>) -> Option<&T>

The CPU-side source value — e.g. a Mesh’s vertices/indices, for building a collision mesh from the same data used to render it.

pub fn get_source_mut(&mut self, handle: Handle<T>) -> Option<&mut T>

pub fn is_ready(&self, handle: Handle<T>) -> bool

Whether this handle’s GPU-side upload has finished.

pub fn contains(&self, handle: Handle<T>) -> bool

Whether handle still refers to a live entry.

pub fn mark_dirty(&mut self, handle: Handle<T>)

Re-queues an entry for upload — e.g. after mutating it via get_source_mut.

pub fn get_by_name(&self, name: &str) -> Option<&T::Processed>

Same as get, looked up by the name it was inserted under.

pub fn get_source_by_name(&self, name: &str) -> Option<&T>

Same as get_source, looked up by name.

pub fn get_handle_by_name(&self, name: &str) -> Option<Handle<T>>

The Handle<T> an asset was inserted under, by name.

pub fn iter(&self) -> impl Iterator<Item = (Handle<T>, &T)>

Every currently-loaded asset of this type, source data included — e.g. to build a static collision world from every loaded Mesh, or a debug asset browser. Ready-or-not — pair with is_ready if you only want finished uploads.

pub fn remove(&mut self, handle: Handle<T>) -> Option<T>

pub fn remove_by_name(&mut self, name: &str) -> Option<T>

Trait Implementations

impl<T: AssetSource> Default for Assets<T>

fn default() -> Self

Returns the “default value” for a type.