Struct SortedRenderPhasePlugin

pub struct SortedRenderPhasePlugin<SPI, GFBD>(/* private fields */)
where
    SPI: SortedPhaseItem,
    GFBD: GetFullBatchData;

A convenient abstraction for adding all the systems necessary for a sorted render phase to the render app.

This is the version used when the pipeline supports GPU preprocessing: e.g. 3D PBR meshes.

Trait Implementations

impl<SPI, GFBD> Default for SortedRenderPhasePlugin<SPI, GFBD>

where SPI: SortedPhaseItem, GFBD: GetFullBatchData,

fn default() -> Self

Returns the “default value” for a type.

impl<SPI, GFBD> Plugin for SortedRenderPhasePlugin<SPI, GFBD>

where SPI: SortedPhaseItem + CachedRenderPipelinePhaseItem, GFBD: GetFullBatchData + Sync + Send + 'static,

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.