Struct ExtractInstancesPlugin

pub struct ExtractInstancesPlugin<EI>
where
    EI: ExtractInstance,
{ /* private fields */ }

This plugin extracts one or more components into the “render world” as extracted instances.

Therefore it sets up the ExtractSchedule step for the specified ExtractedInstances.

Implementations

impl<EI> ExtractInstancesPlugin<EI>

where EI: ExtractInstance,

pub fn new() -> Self

Creates a new ExtractInstancesPlugin that unconditionally extracts to the render world, whether the entity is visible or not.

pub fn extract_visible() -> Self

Creates a new ExtractInstancesPlugin that extracts to the render world if and only if the entity it’s attached to is visible.

Trait Implementations

impl<EI> Default for ExtractInstancesPlugin<EI>

where EI: ExtractInstance + Default,

fn default() -> ExtractInstancesPlugin<EI>

Returns the “default value” for a type.

impl<EI> Plugin for ExtractInstancesPlugin<EI>

where EI: ExtractInstance,

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.