Struct ImageFontPlugin 

pub struct ImageFontPlugin;

A Bevy plugin for rendering image-based fonts.

This plugin enables support for fonts stored as single images (e.g., PNG), where each glyph is represented by a section of the image. It handles:

• Loading ImageFont assets, which describe the glyph layout.
• Registering the ImageFont and ImageFontText types for use in your app.
• Marking updated fonts as dirty, ensuring proper re-rendering.

Features

The plugin conditionally includes additional functionality based on enabled features:

• rendered: Enables support for rendering image fonts.
• atlas_sprites: Enables support for more advanced atlas-based sprite functionality.

Usage

To use this plugin, add it to your Bevy app:

use bevy::prelude::*;
use bevy_image_font::ImageFontPlugin;

App::new()
    .add_plugins(DefaultPlugins)
    .add_plugins(ImageFontPlugin)
    .run();

Ensure that ImageFont assets are properly loaded and configured using the asset system, and consider the relevant examples in the documentation for advanced use cases.

Trait Implementations

impl Debug for ImageFontPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ImageFontPlugin

fn default() -> ImageFontPlugin

Returns the “default value” for a type.

impl Plugin for ImageFontPlugin

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.