meshtext 0.3.2

Generate vertex-vertex meshes from text.
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::error::MeshTextError;

/// A single character from a font.
pub trait Glyph<T> {
    /// Generates a mesh for a single character.
    ///
    /// Arguments:
    ///
    /// * `glyph`: The character that will be transformed into a mesh.
    /// * `flat`: Wether the mesh is flat or has an extent of `1` unit in the z-axis.
    /// * `transform`: The optional homogenous 4x4 transformation matrix that will be
    ///   applied to each vertex of the mesh.
    ///
    /// Returns:
    ///
    /// The mesh for the given glyph.
    ///
    /// # Example
    ///
    /// ```rust
    /// use meshtext::{MeshGenerator, MeshText, Glyph};
    ///
    /// let font_data = include_bytes!("../../../assets/font/FiraMono-Regular.ttf");
    /// let mut generator = MeshGenerator::new(font_data);
    /// let result: MeshText = generator
    ///     .generate_glyph('A', true, None)
    ///     .expect("Failed to generate mesh.");
    /// ```
    fn generate_glyph(
        &mut self,
        glyph: char,
        flat: bool,
        transform: Option<&[f32; 16]>,
    ) -> Result<T, Box<dyn MeshTextError>>;

    /// Generates a two-dimensional mesh for a single character.
    ///
    /// Arguments:
    ///
    /// * `glyph`: The character that will be transformed into a mesh.
    /// * `transform`: The optional homogenous 3x3 transformation matrix that will be
    ///   applied to each vertex of the mesh.
    ///
    /// Returns:
    ///
    /// The mesh for the given glyph.
    ///
    /// # Example
    ///
    /// ```rust
    /// use meshtext::{MeshGenerator, MeshText, Glyph};
    ///
    /// let font_data = include_bytes!("../../../assets/font/FiraMono-Regular.ttf");
    /// let mut generator = MeshGenerator::new(font_data);
    /// let result: MeshText = generator
    ///     .generate_glyph_2d('A', None)
    ///     .expect("Failed to generate mesh.");
    /// ```
    fn generate_glyph_2d(
        &mut self,
        glyph: char,
        transform: Option<&[f32; 9]>,
    ) -> Result<T, Box<dyn MeshTextError>>;
}