Struct bevy_asset::AssetServer

pub struct AssetServer { /* fields omitted */ }

Loads assets from the filesystem on background threads

Implementations

impl AssetServer

pub fn new<T: AssetIo>(source_io: T, task_pool: TaskPool) -> Self

pub fn with_boxed_io(asset_io: Box<dyn AssetIo>, task_pool: TaskPool) -> Self

pub fn add_loader<T>(&self, loader: T) where
    T: AssetLoader, 

pub fn watch_for_changes(&self) -> Result<(), AssetServerError>

pub fn get_handle<T: Asset, I: Into<HandleId>>(&self, id: I) -> Handle<T>

pub fn get_handle_untyped<I: Into<HandleId>>(&self, id: I) -> HandleUntyped

pub fn get_handle_path<H: Into<HandleId>>(
    &self,
    handle: H
) -> Option<AssetPath<'_>>

pub fn get_load_state<H: Into<HandleId>>(&self, handle: H) -> LoadState

pub fn get_group_load_state(
    &self,
    handles: impl IntoIterator<Item = HandleId>
) -> LoadState

pub fn load<'a, T: Asset, P: Into<AssetPath<'a>>>(&self, path: P) -> Handle<T>

Queue an Asset at the provided relative path for asynchronous loading.

The absolute Path to the asset is "ROOT/ASSET_FOLDER_NAME/path".

By default the ROOT is the directory of the Application, but this can be overridden by setting the "CARGO_MANIFEST_DIR" environment variable (see https://doc.rust-lang.org/cargo/reference/environment-variables.html) to another directory. When the application is run through Cargo, then "CARGO_MANIFEST_DIR" is automatically set to the root folder of your crate (workspace).

The name of the asset folder is set inside the AssetServerSettings resource. The default name is "assets".

The asset is loaded asynchronously, and will generally not be available by the time this calls returns. Use AssetServer::get_load_state to determine when the asset is effectively loaded and available in the Assets collection.

pub fn load_untyped<'a, P: Into<AssetPath<'a>>>(&self, path: P) -> HandleUntyped

pub fn load_folder<P: AsRef<Path>>(
    &self,
    path: P
) -> Result<Vec<HandleUntyped>, AssetServerError>

pub fn free_unused_assets(&self)

pub fn mark_unused_assets(&self)

Trait Implementations

impl Clone for AssetServer

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.