firefly-rust 0.13.2

Rust SDK for making Firefly Zero games
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use crate::*;

/// A loaded font file.
///
/// Can be loaded as [`FileBuf`] from ROM with [`load_file_buf`]
/// and then cast using [`FileBuf::as_font`].
pub struct Font<'a> {
    pub(crate) raw: &'a [u8],
}

impl Font<'_> {
    /// Check if the font encoding is ASCII.
    #[must_use]
    pub fn is_ascii(&self) -> bool {
        self.raw[1] == 0
    }

    /// Calculate width (in pixels) of the given ASCII text.
    ///
    /// This function does not account for newlines.
    #[must_use]
    pub fn line_width_ascii(&self, t: &str) -> u32 {
        t.len() as u32 * u32::from(self.char_width())
    }

    /// Calculate width (in pixels) of the given UTF-8 text.
    ///
    /// This function does not account for newlines.
    #[must_use]
    pub fn line_width_utf8(&self, t: &str) -> u32 {
        t.chars().count() as u32 * u32::from(self.char_width())
    }

    /// The width (in pixels) of one glyph bounding box.
    #[must_use]
    pub fn char_width(&self) -> u8 {
        self.raw[2]
    }

    /// The height (in pixels) of one glyph (one line) bounding box.
    #[must_use]
    pub fn char_height(&self) -> u8 {
        self.raw[3]
    }

    /// Offset from the top of the glyph bounding box to the baseline.
    #[must_use]
    pub fn baseline(&self) -> u8 {
        self.raw[4]
    }
}

impl<'a> From<File<'a>> for Font<'a> {
    fn from(value: File<'a>) -> Self {
        Self { raw: value.raw }
    }
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a FileBuf> for Font<'a> {
    fn from(value: &'a FileBuf) -> Self {
        Self { raw: &value.raw }
    }
}