AssetManager

Struct AssetManager 

Source
pub struct AssetManager { /* private fields */ }
Expand description

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§

Source§

impl AssetManager

Source

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

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

Source

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.

Source

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§

Source§

impl Debug for AssetManager

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AssetManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Resource for AssetManager

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.