pub struct AssetProcessor { /* private fields */ }
Expand description

A “background” asset processor that reads asset values from a source AssetSource (which corresponds to an AssetReader / AssetWriter pair), processes them in some way, and writes them to a destination AssetSource.

This will create .meta files (a human-editable serialized form of AssetMeta) in the source AssetSource for assets that that can be loaded and/or processed. This enables developers to configure how each asset should be loaded and/or processed.

AssetProcessor can be run in the background while a Bevy App is running. Changes to assets will be automatically detected and hot-reloaded.

Assets will only be re-processed if they have been changed. A hash of each asset source is stored in the metadata of the processed version of the asset, which is used to determine if the asset source has actually changed.

A ProcessorTransactionLog is produced, which uses “write-ahead logging” to make the AssetProcessor crash and failure resistant. If a failed/unfinished transaction from a previous run is detected, the affected asset(s) will be re-processed.

AssetProcessor can be cloned. It is backed by an Arc so clones will share state. Clones can be freely used in parallel.

Implementations§

source§

impl AssetProcessor

source

pub fn new(source: &mut AssetSourceBuilders) -> Self

Creates a new AssetProcessor instance.

source

pub fn server(&self) -> &AssetServer

The “internal” AssetServer used by the AssetProcessor. This is separate from the asset processor used by the main App. It has different processor-specific configuration and a different ID space.

source

pub async fn get_state(&self) -> ProcessorState

Retrieves the current ProcessorState

source

pub fn get_source<'a, 'b>( &'a self, id: impl Into<AssetSourceId<'b>> ) -> Result<&'a AssetSource, MissingAssetSourceError>

Retrieves the AssetSource for this processor

source

pub fn sources(&self) -> &AssetSources

source

pub fn start(_processor: Res<'_, Self>)

Starts the processor in a background thread.

source

pub fn process_assets(&self)

Processes all assets. This will:

  • For each “processed AssetSource:
  • Scan the ProcessorTransactionLog and recover from any failures detected
  • Scan the processed AssetReader to build the current view of already processed assets.
  • Scan the unprocessed AssetReader and remove any final processed assets that are invalid or no longer exist.
  • For each asset in the unprocessed AssetReader, kick off a new “process job”, which will process the asset (if the latest version of the asset has not been processed).
source

pub async fn listen_for_source_change_events(&self)

Listens for changes to assets in the source AssetSource and update state accordingly.

source

pub fn register_processor<P: Process>(&self, processor: P)

Register a new asset processor.

source

pub fn set_default_processor<P: Process>(&self, extension: &str)

Set the default processor for the given extension. Make sure P is registered with AssetProcessor::register_processor.

source

pub fn get_default_processor( &self, extension: &str ) -> Option<Arc<dyn ErasedProcessor>>

Returns the default processor for the given extension, if it exists.

source

pub fn get_processor( &self, processor_type_name: &str ) -> Option<Arc<dyn ErasedProcessor>>

Returns the processor with the given processor_type_name, if it exists.

Trait Implementations§

source§

impl Clone for AssetProcessor

source§

fn clone(&self) -> AssetProcessor

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Resource for AssetProcessor
where Self: Send + Sync + 'static,

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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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>,

§

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.
source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> Settings for T
where T: 'static + Send + Sync,