Struct LayoutRun

pub struct LayoutRun<'a> {
    pub line_i: usize,
    pub text: &'a str,
    pub rtl: bool,
    pub glyphs: &'a [LayoutGlyph],
    pub decorations: &'a [DecorationSpan],
    pub line_y: f32,
    pub line_top: f32,
    pub line_height: f32,
    pub line_w: f32,
}

A line of visible text for rendering

Fields

line_i: usize

The index of the original text line

text: &'a str

The original text line

rtl: bool

True if the original paragraph direction is RTL

glyphs: &'a [LayoutGlyph]

The array of layout glyphs to draw

decorations: &'a [DecorationSpan]

Text decoration spans covering ranges of glyphs

line_y: f32

Y offset to baseline of line

line_top: f32

Y offset to top of line

line_height: f32

Y offset to next line

line_w: f32

Width of line

Implementations

impl LayoutRun<'_>

pub fn highlight( &self, cursor_start: Cursor, cursor_end: Cursor, ) -> impl Iterator<Item = (f32, f32)>

Return an iterator of (x_left, x_width) pixel spans for the highlighted areas between cursor_start and cursor_end within this run.

For pure LTR or pure RTL runs this yields at most one span. For mixed BiDi runs (where selected and unselected glyphs interleave visually) it yields multiple disjoint spans.

Returns an empty iterator if the cursor range does not intersect this run.

pub fn cursor_position(&self, cursor: &Cursor) -> Option<f32>

Returns the visual x position (in pixels) of cursor within this run, or None if the cursor does not belong to this run.

For RTL glyphs the cursor is placed at the right edge minus the offset; for LTR glyphs it is placed at the left edge plus the offset.

pub fn cursor_glyph(&self, cursor: &Cursor) -> Option<(usize, f32)>

Find which glyph in this run contains cursor, returning (glyph_index, pixel_offset_within_glyph), or None if the cursor is not on this run.

pub const fn cursor_from_glyph_left(&self, glyph: &LayoutGlyph) -> Cursor

Get the left-edge cursor position of a glyph, accounting for paragraph direction.

pub const fn cursor_from_glyph_right(&self, glyph: &LayoutGlyph) -> Cursor

Get the right-edge cursor position of a glyph, accounting for paragraph direction.

Trait Implementations

impl<'a> Debug for LayoutRun<'a>

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

Formats the value using the given formatter.