Struct pixel_game_lib::font::Font

pub struct Font { /* private fields */ }

Pixel font loaded from an image.

Implementations

impl Font

pub fn from_buffer_with_alpha<B>( buffer: B, alpha: u8, char_size: Extent2<u8> ) -> Self

where B: ToBlitBuffer,

Construct the font from a bitmap with an alpha channel.

pub fn from_buffer_with_mask_color<B>( buffer: B, mask_color: u32, char_size: Extent2<u8> ) -> Self

where B: ToBlitBuffer,

Construct the font from a bitmap where a single color is the alpha mask.

pub fn render(&self, text: &str, position: Vec2<f64>, canvas: &mut Canvas<'_>)

Render ASCII text on a pixel buffer.

Start from the top-left.

pub fn render_centered( &self, text: &str, position: Vec2<f64>, canvas: &mut Canvas<'_> )

Render ASCII text on a pixel buffer.

Center the text around the point. Currently does not support multi-line strings yet.

Examples found in repository

examples/font.rs (lines 41-49)

fn main() {
    // Window configuration with default pixel size and scaling
    let window_config = WindowConfig {
        ..Default::default()
    };

    // Load a font for the widgets
    let font = font();

    // Open the window and start the game-loop
    pixel_game_lib::window(
        // We don't use any state so we pass a zero-sized type
        (),
        window_config.clone(),
        // Update loop exposing input events we can handle, this is where you would handle the game logic
        |_state, input, _mouse, _dt| {
            // Exit when escape is pressed
            input.key_pressed(KeyCode::Escape)
        },
        // Render loop exposing the pixel buffer we can mutate
        move |_state, canvas, _dt| {
            // Draw the text at the center of the screen
            font.render_centered(
                "pixel-game-lib font example",
                Vec2::new(
                    window_config.buffer_size.w / 2,
                    window_config.buffer_size.h / 2,
                )
                .as_(),
                canvas,
            );
        },
    )
    .expect("Error opening window");
}

Trait Implementations

impl Compound for Font

fn load(cache: AnyCache<'_>, id: &SharedString) -> Result<Self, BoxedError>

Loads an asset from the cache.

const HOT_RELOADED: bool = true

If false, disable hot-reloading for assets of this type (true by default). If so, you may want to implement NotHotReloaded for this type to enable additional functions.

impl Debug for Font

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

Formats the value using the given formatter.