Struct WinitPlugin

pub struct WinitPlugin<T = WakeUp>
where
    T: Event,
{
    pub run_on_any_thread: bool,
    /* private fields */
}

A Plugin that uses winit to create and manage windows, and receive window and input events.

This plugin will add systems and resources that sync with the winit backend and also replace the existing App runner with one that constructs an event loop to receive window and input events from the OS.

The T event type can be used to pass custom events to the winit’s loop, and handled as events in systems.

When using eg. MinimalPlugins you can add this using WinitPlugin::<WakeUp>::default(), where WakeUp is the default Event that bevy uses.

Fields

run_on_any_thread: bool

Allows the window (and the event loop) to be created on any thread instead of only the main thread.

See EventLoopBuilder::build for more information on this.

Supported platforms

Only works on Linux (X11/Wayland) and Windows. This field is ignored on other platforms.

Trait Implementations

impl<T> Default for WinitPlugin<T>

where T: Default + Event,

fn default() -> WinitPlugin<T>

Returns the “default value” for a type.

impl<T> Plugin for WinitPlugin<T>

where T: Event,

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

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 is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.