Struct RenderPlugin

pub struct RenderPlugin {
    pub render_creation: RenderCreation,
    pub synchronous_pipeline_compilation: bool,
}

Contains the default Bevy rendering backend based on wgpu.

Rendering is done in a SubApp, which exchanges data with the main app between main schedule iterations.

Rendering can be executed between iterations of the main schedule, or it can be executed in parallel with main schedule when PipelinedRenderingPlugin is enabled.

Fields

render_creation: RenderCreation

synchronous_pipeline_compilation: bool

If true, disables asynchronous pipeline compilation. This has no effect on macOS, Wasm, iOS, or without the multi_threaded feature.

Trait Implementations

impl Default for RenderPlugin

fn default() -> RenderPlugin

Returns the “default value” for a type.

impl Plugin for RenderPlugin

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

Initializes the renderer, sets up the RenderSet and creates the rendering sub-app.

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.