Struct bevy_pixels::PixelsPlugin

pub struct PixelsPlugin {
    pub primary_window: Option<PixelsOptions>,
}

A [Plugin] that defines an integration between Bevy and the pixels crate. Should be added to app after [DefaultPlugins].

Fields

primary_window: Option<PixelsOptions>

Configuration for the primary window pixel buffer. This will automatically create a PixelsWrapper component (using the provided options) for the primary window entity.

Trait Implementations

impl Default for PixelsPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for PixelsPlugin

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 it’s setup? This can be useful for plugins that needs something asynchronous to happen before they can finish their setup, like renderer initialization. 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.