Struct HephaeRenderPlugin

pub struct HephaeRenderPlugin<T: Vertex>(/* private fields */);

The entry point of Hephae, generic over T.

Adds the core functionality of Hephae through the Vertex impl of T. Note that with this alone you can’t start drawing yet; refer to DrawerPlugin for more.

Implementations

impl<T: Vertex> HephaeRenderPlugin<T>

pub const fn new() -> Self

Constructs the plugin for use in App::add_plugins.

Trait Implementations

impl<T: Vertex> Default for HephaeRenderPlugin<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Vertex> Plugin for HephaeRenderPlugin<T>

where <T::RenderCommand as RenderCommand<T::Item>>::Param: ReadOnlySystemParam,

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

Configures the App to which this plugin is added.

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