Struct dotrix_core::assets::Assets

pub struct Assets { /* fields omitted */ }

Assets management service

Stored asset can be identified by its Id. The Id is being assigned to an asset, once the asset is stored.

File operations performed by the service are being executed in separate threads, so no execution blocking happens. Due to some resources may contain several assets, they may not be loaded at the same time. Also bigger assets may take longer time to be loaded.

There is a way to aquire asset Id immediately without awaiting using Assets::register method.

Implementations

impl Assets

pub fn new() -> Self

Creates new instance of Assets container

pub fn import(&mut self, path_str: &str) -> Id<Resource>

Imports an asset file by its path and returns Id of the Resource

pub fn register<T>(&mut self, name: &str) -> Id<T> where
    Self: AssetMapGetter<T>, 

Associates an asset name with Id and returns it

If name was already used, then no changes will be done and already associated Id will be returned.

As it was said, names of assets loaded with Assets::import method can be predictable in most cases. Using that prediction, developer can obtain an Id even before calling the Assets::import method.

use dotrix_core::{
    assets::Texture,
    ecs::Mut,
    services::Assets,
};

fn my_system(mut assets: Mut<Assets>) {
    // get the id
    let texture = assets.register::<Texture>("my_texture");
    // import the texture
    assets.import("/path/to/my_texture.png");
}

pub fn store_as<T>(&mut self, asset: T, name: &str) -> Id<T> where
    Self: AssetMapGetter<T>, 

Stores an asset under user defined name and returns Id of it

pub fn store<T>(&mut self, asset: T) -> Id<T> where
    Self: AssetMapGetter<T>, 

Stores an asset and returns Id of it

pub fn find<T>(&self, name: &str) -> Option<Id<T>> where
    Self: AssetMapGetter<T>, 

Searches for an asset by the name and return Id of it if the asset exists

pub fn get<T>(&self, handle: Id<T>) -> Option<&T> where
    Self: AssetMapGetter<T>, 

Searches an asset by its Id and returns it by a reference if the asset exists

pub fn get_mut<T>(&mut self, handle: Id<T>) -> Option<&mut T> where
    Self: AssetMapGetter<T>, 

Searches an asset by its Id and returns it by a mutual reference if the asset exists

pub fn remove<T>(&mut self, handle: Id<T>) -> Option<T> where
    Self: AssetMapGetter<T>, 

Removes an asset from the Service and returns it if the asset exists

pub fn iter<T>(&mut self) -> Iter<'_, Id<T>, T> where
    Self: AssetMapGetter<T>, 

Returns iterator over assets by its type

pub fn iter_mut<T>(&mut self) -> IterMut<'_, Id<T>, T> where
    Self: AssetMapGetter<T>, 

Returns mutable iterator over assets by its type

Trait Implementations

impl AssetMapGetter<Animation> for Assets

fn map(&self) -> &HashMap<Id<Animation>, Animation>

Returns HashMap reference for selected asset type

fn map_mut(&mut self) -> &mut HashMap<Id<Animation>, Animation>

Returns mutable HashMap reference for selected asset type

impl AssetMapGetter<Mesh> for Assets

fn map(&self) -> &HashMap<Id<Mesh>, Mesh>

Returns HashMap reference for selected asset type

fn map_mut(&mut self) -> &mut HashMap<Id<Mesh>, Mesh>

Returns mutable HashMap reference for selected asset type

impl AssetMapGetter<Resource> for Assets

fn map(&self) -> &HashMap<Id<Resource>, Resource>

Returns HashMap reference for selected asset type

fn map_mut(&mut self) -> &mut HashMap<Id<Resource>, Resource>

Returns mutable HashMap reference for selected asset type

impl AssetMapGetter<Shader> for Assets

fn map(&self) -> &HashMap<Id<Shader>, Shader>

Returns HashMap reference for selected asset type

fn map_mut(&mut self) -> &mut HashMap<Id<Shader>, Shader>

Returns mutable HashMap reference for selected asset type

impl AssetMapGetter<Skin> for Assets

fn map(&self) -> &HashMap<Id<Skin>, Skin>

Returns HashMap reference for selected asset type

fn map_mut(&mut self) -> &mut HashMap<Id<Skin>, Skin>

Returns mutable HashMap reference for selected asset type

impl AssetMapGetter<Texture> for Assets

fn map(&self) -> &HashMap<Id<Texture>, Texture>

Returns HashMap reference for selected asset type

fn map_mut(&mut self) -> &mut HashMap<Id<Texture>, Texture>

Returns mutable HashMap reference for selected asset type

impl Default for Assets

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Assets

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Assets

impl Sync for Assets