Struct RenderAssetPlugin

pub struct RenderAssetPlugin<A: RenderAsset, AFTER: RenderAssetDependency + 'static = ()> { /* private fields */ }

This plugin extracts the changed assets from the “app world” into the “render world” and prepares them for the GPU. They can then be accessed from the RenderAssets resource.

Therefore it sets up the ExtractSchedule and RenderSet::PrepareAssets steps for the specified RenderAsset.

The AFTER generic parameter can be used to specify that A::prepare_asset should not be run until prepare_assets::<AFTER> has completed. This allows the prepare_asset function to depend on another prepared RenderAsset, for example Mesh::prepare_asset relies on RenderAssets::<GpuImage> for morph targets, so the plugin is created as RenderAssetPlugin::<GpuMesh, GpuImage>::default().

Trait Implementations

impl<A: RenderAsset, AFTER: RenderAssetDependency + 'static> Default for RenderAssetPlugin<A, AFTER>

fn default() -> Self

Returns the “default value” for a type.

impl<A: RenderAsset, AFTER: RenderAssetDependency + 'static> Plugin for RenderAssetPlugin<A, AFTER>

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.