Struct bevy_asset::LoadContext
source · pub struct LoadContext<'a> { /* private fields */ }
Expand description
An asynchronous context where an Asset
is processed.
The load context is created by the AssetServer
to process an asset source after loading its
contents into memory. It is then passed to the appropriate AssetLoader
based on the file
extension of the asset’s path.
An asset source can define one or more assets from a single source path. The main asset is set
using LoadContext::set_default_asset
and sub-assets are defined with
LoadContext::set_labeled_asset
.
Implementations§
source§impl<'a> LoadContext<'a>
impl<'a> LoadContext<'a>
sourcepub fn has_labeled_asset(&self, label: &str) -> bool
pub fn has_labeled_asset(&self, label: &str) -> bool
Returns true
if the load context contains an asset with the specified label.
sourcepub fn set_default_asset<T: Asset>(&mut self, asset: LoadedAsset<T>)
pub fn set_default_asset<T: Asset>(&mut self, asset: LoadedAsset<T>)
Sets the primary asset loaded from the asset source.
sourcepub fn set_labeled_asset<T: Asset>(
&mut self,
label: &str,
asset: LoadedAsset<T>
) -> Handle<T>
pub fn set_labeled_asset<T: Asset>( &mut self, label: &str, asset: LoadedAsset<T> ) -> Handle<T>
Sets a secondary asset loaded from the asset source.
sourcepub fn get_handle<I: Into<HandleId>, T: Asset>(&self, id: I) -> Handle<T>
pub fn get_handle<I: Into<HandleId>, T: Asset>(&self, id: I) -> Handle<T>
Gets a strong handle to an asset of type T
from its id.
sourcepub fn get_handle_untyped<I: Into<HandleId>>(&self, id: I) -> HandleUntyped
pub fn get_handle_untyped<I: Into<HandleId>>(&self, id: I) -> HandleUntyped
Gets an untyped strong handle for an asset with the provided id.
sourcepub async fn read_asset_bytes<P: AsRef<Path>>(
&self,
path: P
) -> Result<Vec<u8>, AssetIoError>
pub async fn read_asset_bytes<P: AsRef<Path>>( &self, path: P ) -> Result<Vec<u8>, AssetIoError>
Reads the contents of the file at the specified path through the AssetIo
associated
with this context.
sourcepub fn get_asset_metas(&self) -> Vec<AssetMeta>
pub fn get_asset_metas(&self) -> Vec<AssetMeta>
Generates metadata for the assets managed by this load context.
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for LoadContext<'a>
impl<'a> Send for LoadContext<'a>
impl<'a> Sync for LoadContext<'a>
impl<'a> Unpin for LoadContext<'a>
impl<'a> !UnwindSafe for LoadContext<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.