Struct bevy::asset::AssetServer
[−]pub struct AssetServer { /* private fields */ }
Expand description
Loads assets from the filesystem on background threads
Implementations
impl AssetServer
impl AssetServer
pub fn new<T>(source_io: T, task_pool: TaskPool) -> AssetServer where
T: AssetIo,
pub fn with_boxed_io(
asset_io: Box<dyn AssetIo + 'static, Global>,
task_pool: TaskPool
) -> AssetServer
pub fn asset_io(&self) -> &(dyn AssetIo + 'static)
pub fn add_loader<T>(&self, loader: T) where
T: AssetLoader,
pub fn watch_for_changes(&self) -> Result<(), AssetServerError>
pub fn watch_for_changes(&self) -> Result<(), AssetServerError>
Enable watching of the filesystem for changes, if support is available, starting from after the point of calling this function.
pub fn get_handle<T, I>(&self, id: I) -> Handle<T> where
T: Asset,
I: Into<HandleId>,
pub fn get_handle_untyped<I>(&self, id: I) -> HandleUntyped where
I: Into<HandleId>,
pub fn get_handle_path<H>(&self, handle: H) -> Option<AssetPath<'_>> where
H: Into<HandleId>,
pub fn get_load_state<H>(&self, handle: H) -> LoadState where
H: Into<HandleId>,
pub fn get_group_load_state(
&self,
handles: impl IntoIterator<Item = HandleId>
) -> LoadState
pub fn load<'a, T, P>(&self, path: P) -> Handle<T> where
T: Asset,
P: Into<AssetPath<'a>>,
pub fn load<'a, T, P>(&self, path: P) -> Handle<T> where
T: Asset,
P: Into<AssetPath<'a>>,
Queue an Asset
at the provided relative path for asynchronous loading.
The absolute Path to the asset is "ROOT/ASSET_FOLDER_NAME/path"
.
By default the ROOT is the directory of the Application, but this can be overridden by
setting the "CARGO_MANIFEST_DIR"
environment variable
(see https://doc.rust-lang.org/cargo/reference/environment-variables.html)
to another directory. When the application is run through Cargo, then
"CARGO_MANIFEST_DIR"
is automatically set to the root folder of your crate (workspace).
The name of the asset folder is set inside the
AssetServerSettings
resource. The default name is
"assets"
.
The asset is loaded asynchronously, and will generally not be available by the time
this calls returns. Use AssetServer::get_load_state
to determine when the asset is
effectively loaded and available in the Assets
collection.
pub fn load_untyped<'a, P>(&self, path: P) -> HandleUntyped where
P: Into<AssetPath<'a>>,
pub fn load_folder<P>(
&self,
path: P
) -> Result<Vec<HandleUntyped, Global>, AssetServerError> where
P: AsRef<Path>,
pub fn free_unused_assets(&self)
pub fn mark_unused_assets(&self)
Trait Implementations
impl Clone for AssetServer
impl Clone for AssetServer
fn clone(&self) -> AssetServer
fn clone(&self) -> AssetServer
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for AssetServer
impl Send for AssetServer
impl Sync for AssetServer
impl Unpin for AssetServer
impl !UnwindSafe for AssetServer
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<F, A>impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<F, A>impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
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
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
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. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>ⓘNotable traits for Box<F, A>impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more