Struct AssetServer 

pub struct AssetServer { /* private fields */ }

Asset server struct

Implementations

impl AssetServer

pub fn new() -> Self

Create a new instance of AssetServer

pub fn with_root(root: impl Into<PathBuf>) -> Self

Create an AssetServer that can load assets from the filesystem

Examples found in repository

examples/assets.rs (line 31)

fn main() {
    let mut asset_server = AssetServer::with_root("assets");
    asset_server.register_loader::<Texture>(Box::new(TextureLoader));
    asset_server.register_loader::<Audio>(Box::new(AudioLoader));
    asset_server.load::<Texture>("example.png").unwrap();
    asset_server.load::<Audio>("music.ogg").unwrap();
    println!("{asset_server:#?}");

    let audio = asset_server.get_named::<Audio>("music").unwrap();
    println!("{:?}", audio.read().0);
    audio.write().0 = 1.0;
    println!("{:?}", audio.read().0);
}

pub fn register_asset_type<A: Asset>(&mut self)

Register an asset type without registering a loader

Useful for internal/generated assets

pub fn register_loader<A: Asset>(&mut self, loader: Box<dyn ErasedAssetLoader>)

Register an asset loader

Examples found in repository

examples/assets.rs (line 32)

fn main() {
    let mut asset_server = AssetServer::with_root("assets");
    asset_server.register_loader::<Texture>(Box::new(TextureLoader));
    asset_server.register_loader::<Audio>(Box::new(AudioLoader));
    asset_server.load::<Texture>("example.png").unwrap();
    asset_server.load::<Audio>("music.ogg").unwrap();
    println!("{asset_server:#?}");

    let audio = asset_server.get_named::<Audio>("music").unwrap();
    println!("{:?}", audio.read().0);
    audio.write().0 = 1.0;
    println!("{:?}", audio.read().0);
}

pub fn load_reader<A: Asset>( &mut self, name: &str, reader: &mut dyn Read, ) -> ResourceResult<Handle<A>>

Load asset into cache from a reader

Warning

Assets loaded with this function won’t be hot-reloadable

pub fn insert<A: Asset>(&mut self, asset: A) -> ResourceResult<Handle<A>>

Insert an internal/generated asset into the cache

pub fn insert_named<A: Asset>( &mut self, name: impl Into<String>, asset: A, ) -> ResourceResult<Handle<A>>

Insert an internal/generated asset with a name alias

pub fn load<A: Asset>( &mut self, path: impl Into<PathBuf>, ) -> ResourceResult<Handle<A>>

Load asset into cache from file

The extension will be stripped and the asset inserted under that name. For example, music.ogg is inserted as music

Examples found in repository

examples/assets.rs (line 34)

fn main() {
    let mut asset_server = AssetServer::with_root("assets");
    asset_server.register_loader::<Texture>(Box::new(TextureLoader));
    asset_server.register_loader::<Audio>(Box::new(AudioLoader));
    asset_server.load::<Texture>("example.png").unwrap();
    asset_server.load::<Audio>("music.ogg").unwrap();
    println!("{asset_server:#?}");

    let audio = asset_server.get_named::<Audio>("music").unwrap();
    println!("{:?}", audio.read().0);
    audio.write().0 = 1.0;
    println!("{:?}", audio.read().0);
}

pub fn get<A: Asset>(&self, id: AssetId<A>) -> Option<Handle<A>>

Get asset handle from server by ID

pub fn get_named<A: Asset>(&self, name: &str) -> Option<Handle<A>>

Get asset handle from server by name

Examples found in repository

examples/assets.rs (line 38)

fn main() {
    let mut asset_server = AssetServer::with_root("assets");
    asset_server.register_loader::<Texture>(Box::new(TextureLoader));
    asset_server.register_loader::<Audio>(Box::new(AudioLoader));
    asset_server.load::<Texture>("example.png").unwrap();
    asset_server.load::<Audio>("music.ogg").unwrap();
    println!("{asset_server:#?}");

    let audio = asset_server.get_named::<Audio>("music").unwrap();
    println!("{:?}", audio.read().0);
    audio.write().0 = 1.0;
    println!("{:?}", audio.read().0);
}

pub fn id_named<A: Asset>(&self, name: &str) -> Option<AssetId<A>>

Get asset ID from name

pub fn reload<A: Asset>(&mut self, id: AssetId<A>) -> ResourceResult<()>

Hot-reload an asset by ID

pub fn reload_named<A: Asset>(&mut self, name: &str) -> ResourceResult<()>

Hot-reload an asset by name

Trait Implementations

impl Debug for AssetServer

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

Formats the value using the given formatter.

impl Default for AssetServer

fn default() -> AssetServer

Returns the “default value” for a type.