Struct zengine_asset::AssetManager

pub struct AssetManager { /* private fields */ }

A Resource that loads assets from the filesystem in the background

The asset manager keeps track of the load state of the assets it manages

The asset manager is a resource, so in order to get a mutable reference in a system you need a ResMut accessor, like this:

use zengine_asset::{AssetManager, Handle};
use zengine_ecs::system::{ResMut};
use zengine_macro::Asset;


fn my_system(mut asset_manager: ResMut<AssetManager>)
{
    let asset_handle: Handle<TestAsset> = asset_manager.load("image.png");
}

See the simple_sprite example for more information.

Implementations

impl AssetManager

pub fn new<T: AssetIo>(asset_io: T) -> Self

Creates a new asset manager with the provided asset I/O

pub fn load<T: Asset, P: Into<AssetPath>>(&mut self, file_path: P) -> Handle<T>

Asynchronous load an Asset at the provided relative path

The absolute path to the asset is "ROOT/ASSET_BASE_PATH/file_path" where ASSET_BASE_PATH is the path used during the AssetModule creation. Its extension is then extracted to search for an AssetLoader.

By default the ROOT is the directory of the Application.

The asset is loaded asynchronously, and will generally not be available by the time this calls returns. The engine will generate an AssetEvent::Loaded when the asset will be available.

The asset will always fail to load if the provided path doesn’t contain an extension.

pub fn register_loader<T: AssetLoader>(&mut self, loader: T)

Register a new asset loader to the manager

If loader has one or more supported extensions in conflict with loaders that came before it, it will replace them.

Trait Implementations

impl Debug for AssetManager

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

Formats the value using the given formatter.

impl Default for AssetManager

fn default() -> Self

Returns the “default value” for a type.

impl Resource for AssetManager