Struct Font

Source
pub struct Font<'a> {
    pub header: Header,
    /* private fields */
}
Expand description

The structure for the font.

§Example

use psf_rs::Font;

let font = Font::load(include_bytes!("../test.psfu"));

font.display_glyph('A', |bit, x, y| {
   // Stuff
});

Fields§

§header: Header

The font header for this font.

Implementations§

Source§

impl<'a> Font<'a>

Source

pub fn display_glyph<T: TryInto<u32>>( &self, char: T, action: impl FnMut(u8, u8, u8), )

Displays a glyph. This will NOT trim the glyph, so you will still get the vertical padding.

§Arguments
  • char - Pretty self explanitory. A character or integer, that must represent a glyph on the ASCII table.
  • action - A closure that takes in 3 values, the bit (always 0 or 1), the x, and the y.
§Panics
  • If the character can’t be properly converted into a u32.
  • If the character can’t be described with 2 bytes or less in UTF-8.
Source

pub fn load(raw: &'a [u8]) -> Self

Loads a font.

§Arguments
  • raw - The raw bytes for the font file itself.
§Panics
  • If the file header is incomplete/corrupted in pretty much any way.
  • If the magic doesn’t match.
  • If the file size doesn’t is bigger than 0x4000 (16384) bytes.

Trait Implementations§

Source§

impl<'a> Debug for Font<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Font<'a>

§

impl<'a> RefUnwindSafe for Font<'a>

§

impl<'a> Send for Font<'a>

§

impl<'a> Sync for Font<'a>

§

impl<'a> Unpin for Font<'a>

§

impl<'a> UnwindSafe for Font<'a>

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> 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<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, 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.