Struct WordPositions

pub struct WordPositions {
    pub text_layout_options: ResolvedTextLayoutOptions,
    pub word_positions: Vec<LayoutPoint>,
    pub line_breaks: Vec<(WordIndex, LineLength)>,
    pub trailing: f32,
    pub number_of_words: usize,
    pub number_of_lines: usize,
    pub content_size: LayoutSize,
}

Stores the positions of the vertically laid out texts

Fields

text_layout_options: ResolvedTextLayoutOptions

Options like word spacing, character spacing, etc. that were used to layout these glyphs

word_positions: Vec<LayoutPoint>

Stores the positions of words.

line_breaks: Vec<(WordIndex, LineLength)>

Index of the word at which the line breaks + length of line (useful for text selection + horizontal centering)

trailing: f32

Horizontal width of the last line (in pixels), necessary for inline layout later on, so that the next text run can contine where the last text run left off.

Usually, the “trailing” of the current text block is the “leading” of the next text block, to make it seem like two text runs push into each other.

number_of_words: usize

How many words are in the text?

number_of_lines: usize

How many lines (NOTE: virtual lines, meaning line breaks in the layouted text) are there?

content_size: LayoutSize

Horizontal and vertical boundaries of the layouted words.

Note that the vertical extent can be larger than the last words’ position, because of trailing negative glyph advances.

Trait Implementations

impl Clone for WordPositions

fn clone(&self) -> WordPositions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WordPositions

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

Formats the value using the given formatter.

impl PartialEq for WordPositions

fn eq(&self, other: &WordPositions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WordPositions