Skip to main content

BitmapFont

Struct BitmapFont 

Source
pub struct BitmapFont {
    pub width: u8,
    pub height: u8,
    pub advance: u8,
    pub line_height: u8,
    pub first_char: u8,
    pub bytes_per_row: u8,
    pub glyphs: &'static [u8],
}
Expand description

Flexible monospaced or packed raw bitmap font definition.

Unlike PackedFont (which is fixed to 3x5 5-row bitpacks), BitmapFont supports arbitrary glyph dimensions (e.g., 8x8, 8x16, 12x16, 16x24), configurable advance/line-height, and multi-byte row bit-masks.

Fields§

§width: u8

Bounding box width in pixels.

§height: u8

Bounding box height in pixels.

§advance: u8

Character horizontal advance in pixels.

§line_height: u8

Vertical line height in pixels.

§first_char: u8

The ASCII character code of the first glyph in the buffer (usually 32 / space).

§bytes_per_row: u8

Number of bytes per row for each glyph (e.g. 1 byte for width <= 8, 2 bytes for width <= 16).

§glyphs: &'static [u8]

Contiguous byte slice containing glyph bitmaps stored row by row (MSB left-to-right).

Implementations§

Source§

impl BitmapFont

Source

pub const fn new_8x8( first_char: u8, advance: u8, line_height: u8, glyphs: &'static [u8], ) -> Self

Creates a new BitmapFont for standard 8x8 glyphs (1 byte per row, 8 rows per glyph).

Source

pub const fn new_8x16( first_char: u8, advance: u8, line_height: u8, glyphs: &'static [u8], ) -> Self

Creates a new BitmapFont for standard 8x16 glyphs (1 byte per row, 16 rows per glyph).

Source

pub fn glyph_bytes(&self, ch: char) -> Option<&'static [u8]>

Get the raw byte slice for a character’s row data.

Source

pub fn draw_glyph_to<F>(&self, ch: char, emit: F)
where F: FnMut(GlyphOp),

Renders a glyph by emitting GlyphOp commands to a single closure callback.

Trait Implementations§

Source§

impl Clone for BitmapFont

Source§

fn clone(&self) -> BitmapFont

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for BitmapFont

Source§

impl Debug for BitmapFont

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for BitmapFont

Source§

impl Font for BitmapFont

Source§

fn advance(&self) -> u32

Character horizontal advance in pixels.
Source§

fn line_height(&self) -> u32

Vertical line height in pixels.
Source§

fn draw_glyph(&self, ch: char, draw_pixel: &mut dyn FnMut(i32, i32))

Render a single glyph by calling draw_pixel(dx, dy) for each active pixel in the glyph, where (dx, dy) are relative coordinates within the glyph bounding box.
Source§

impl From<&'static BitmapFont> for FontId

Source§

fn from(font: &'static BitmapFont) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for BitmapFont

Source§

fn eq(&self, other: &BitmapFont) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BitmapFont

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.