Struct OverlayPlugin

pub struct OverlayPlugin {
    pub fallback_color: Color,
    pub font_size: f32,
}

The text overlay plugin, you must add this plugin for the screen_print! macro to work.

You can manage some of the text properties by setting the fields of the plugin.

Fields

fallback_color: Color

The color to use when none are specified in screen_print!, by default it is yellow.

font_size: f32

The size of the message to display on screen, by default it is 13.0

Trait Implementations

impl Default for OverlayPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for OverlayPlugin

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.