text-typeset 1.2.1

Turns rich text documents into GPU-ready glyph quads
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

use std::ops::Range;

use crate::shaping::run::ShapedRun;

pub struct LayoutLine {
    pub runs: Vec<PositionedRun>,
    /// Baseline y relative to block top (set by block layout).
    pub y: f32,
    pub ascent: f32,
    pub descent: f32,
    pub leading: f32,
    /// Total line height: ascent + descent + leading.
    pub line_height: f32,
    /// Actual content width (sum of run advances).
    pub width: f32,
    /// Character range in the block's text.
    pub char_range: Range<usize>,
}

impl LayoutLine {
    /// Find the x coordinate for a char offset within this line.
    ///
    /// Walks runs and glyphs, returning the x position of the first glyph
    /// whose cluster >= `offset`. Falls back to the end of the line.
    pub fn x_for_offset(&self, offset: usize) -> f32 {
        for (i, run) in self.runs.iter().enumerate() {
            let mut glyph_x = run.x;
            for glyph in &run.shaped_run.glyphs {
                if glyph.cluster as usize >= offset {
                    return glyph_x;
                }
                glyph_x += glyph.x_advance;
            }
            // Only return from this run if the offset doesn't belong to a later run
            let next_run_start = self
                .runs
                .get(i + 1)
                .and_then(|r| r.shaped_run.glyphs.first())
                .map(|g| g.cluster as usize);
            match next_run_start {
                Some(next_start) if offset >= next_start => continue,
                _ => return glyph_x,
            }
        }
        self.runs
            .last()
            .map(|r| r.x + r.shaped_run.advance_width)
            .unwrap_or(0.0)
    }
}

pub struct PositionedRun {
    pub shaped_run: ShapedRun,
    /// X offset from the left edge of the content area.
    pub x: f32,
    /// Decoration flags for this run.
    pub decorations: RunDecorations,
}

/// Text decoration flags and metadata carried from the source TextFormat.
#[derive(Clone, Debug, Default)]
pub struct RunDecorations {
    pub underline_style: crate::types::UnderlineStyle,
    pub overline: bool,
    pub strikeout: bool,
    pub is_link: bool,
    /// Text foreground color (RGBA). None means default (black).
    pub foreground_color: Option<[f32; 4]>,
    /// Underline color (RGBA). None means use foreground_color.
    pub underline_color: Option<[f32; 4]>,
    /// Text-level background highlight color (RGBA). None means transparent.
    pub background_color: Option<[f32; 4]>,
    /// Hyperlink destination URL.
    pub anchor_href: Option<String>,
    /// Tooltip text.
    pub tooltip: Option<String>,
    /// Vertical alignment (normal, superscript, subscript).
    pub vertical_alignment: crate::types::VerticalAlignment,
}