Struct AssetProcessor

pub struct AssetProcessor { /* private fields */ }

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

impl AssetProcessor

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

Creates a new AssetProcessor instance.

pub fn data(&self) -> &Arc<AssetProcessorData>

Gets a reference to the Arc containing the AssetProcessorData.

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.

pub async fn get_state(&self) -> ProcessorState

Retrieves the current ProcessorState

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

Retrieves the AssetSource for this processor

pub fn sources(&self) -> &AssetSources

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

Starts the processor in a background thread.

pub async fn listen_for_source_change_events(&self)

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

pub async fn write_default_meta_file_for_path( &self, path: impl Into<AssetPath<'_>>, ) -> Result<(), WriteDefaultMetaError>

Writes the default meta file for the provided path.

This function generates the appropriate meta file to process path with the default processor. If there is no default processor, it falls back to the default loader.

Note if there is already a meta file for path, this function returns Err(WriteDefaultMetaError::MetaAlreadyExists).

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

Register a new asset processor.

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.

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

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

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

impl Clone for AssetProcessor

fn clone(&self) -> AssetProcessor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Resource for AssetProcessor

where Self: Send + Sync + 'static,