Struct ShapedText

pub struct ShapedText { /* private fields */ }

Output of text layout.

Implementations

impl ShapedText

pub fn new(font: &Font) -> ShapedText

New empty text.

pub fn glyphs(&self) -> impl Iterator<Item = (&Font, &[GlyphInstance])>

Glyphs by font.

The glyphs are in text order by segments and in visual order (LTR) within segments, so the RTL text “لما “ will have the space glyph first, then “’álif”, “miim”, “láam”.

All glyph points are set as offsets to the top-left of the text full text.

Note that multiple glyphs can map to the same char and multiple chars can map to the same glyph.

pub fn glyphs_slice( &self, range: impl RangeBounds<usize>, ) -> impl Iterator<Item = (&Font, &[GlyphInstance])>

Glyphs in a range by font.

Similar output to glyphs, but only glyphs in the range.

pub fn has_colored_glyphs(&self) -> bool

If the shaped text has any Emoji glyph associated with a font that has color palettes.

pub fn has_images(&self) -> bool

If the shaped text has any Emoji glyph associated with a pixel image.

pub fn colored_glyphs( &self, ) -> impl Iterator<Item = (&Font, ShapedColoredGlyphs<'_>)>

Glyphs by font and palette color.

pub fn colored_glyphs_slice( &self, range: impl RangeBounds<usize>, ) -> impl Iterator<Item = (&Font, ShapedColoredGlyphs<'_>)>

Glyphs in a range by font and palette color.

pub fn image_glyphs( &self, ) -> impl Iterator<Item = (&Font, ShapedImageGlyphs<'_>)>

Glyphs by font and associated image.

pub fn image_glyphs_slice( &self, range: impl RangeBounds<usize>, ) -> impl Iterator<Item = (&Font, ShapedImageGlyphs<'_>)>

Glyphs in a range by font and associated image.

pub fn size(&self) -> Size2D<Px, Px>

Bounding box size, the width is the longest line or the first or last line width + absolute offset, the height is the bottom-most point of the last line.

pub fn block_size(&self) -> Size2D<Px, Px>

Size of the text, if it is not inlined.

pub fn overflow_line(&self, max_height: Px) -> Option<ShapedLine<'_>>

Gets the first line that overflows the max_height. A line overflows when the line PxRect::max_y is greater than max_height.

pub fn mid_size(&self) -> Size2D<Px, Px>

Bounding box of the mid-lines, that is the lines except the first and last.

pub fn is_inlined(&self) -> bool

If the text first and last lines is defined externally by the inline layout.

When this is true the shaped text only defines aligns horizontally and only the mid-lines. The vertical offset is defined by the first line rectangle plus the mid_clear.

pub fn align(&self) -> Align

Last applied alignment.

If the text is inlined only the mid-lines are aligned, and only horizontally.

pub fn overflow_align(&self) -> Align

Last applied overflow alignment.

Only used in dimensions of the text that overflow align_size.

pub fn align_size(&self) -> Size2D<Px, Px>

Last applied alignment area.

The lines are aligned inside this size. If the text is inlined only the mid-lines are aligned and only horizontally.

pub fn direction(&self) -> LayoutDirection

Last applied alignment direction.

Note that the glyph and word directions is defined by the TextShapingArgs::lang and the computed direction is in ShapedSegment::direction.

pub fn mid_clear(&self) -> Px

Last applied extra spacing between the first and second lines to clear the full width of the second line in the parent inline layout.

pub fn reshape_lines( &mut self, constraints: PxConstraints2d, inline_constraints: Option<InlineConstraintsLayout>, align: Align, overflow_align: Align, line_height: Px, line_spacing: Px, direction: LayoutDirection, )

Reshape text lines.

Reshape text lines without re-wrapping, this is more efficient then fully reshaping every glyph, but may cause overflow if called with constraints incompatible with the ones used during the full text shaping.

The general process of shaping text is to generate a shaped-text without align during measure, and then reuse this shaped text every layout that does not invalidate any property that affects the text wrap.

pub fn clear_reshape(&mut self)

Restore text to initial shape.

pub fn line_height(&self) -> Px

Height of a single line.

pub fn line_spacing(&self) -> Px

Vertical spacing in between lines.

pub fn baseline(&self) -> Px

Vertical offset from the line bottom up that is the text baseline.

The line bottom is the line_height.

pub fn overline(&self) -> Px

Vertical offset from the line bottom up that is the overline placement.

pub fn strikethrough(&self) -> Px

Vertical offset from the line bottom up that is the strikethrough placement.

pub fn underline(&self) -> Px

Vertical offset from the line bottom up that is the font defined underline placement.

pub fn underline_descent(&self) -> Px

Vertical offset from the line bottom up that is the underline placement when the option for clearing all glyph descents is selected.

pub fn is_empty(&self) -> bool

No segments.

pub fn lines(&self) -> impl Iterator<Item = ShapedLine<'_>>

Iterate over ShapedLine selections split by LineBreak or wrap.

pub fn lines_len(&self) -> usize

Returns the number of text lines.

pub fn first_wrapped(&self) -> bool

If the first line starts in a new inline row because it could not fit in the leftover inline space.

pub fn line(&self, line_idx: usize) -> Option<ShapedLine<'_>>

Gets the line by index.

pub fn empty(&self) -> ShapedText

Create an empty ShapedText with the same metrics as self.

pub fn can_rewrap(&self, max_width: Px) -> bool

Check if any line can be better wrapped given the new wrap config.

Note that a new ShapedText must be generated to rewrap.

pub fn caret_origin( &self, caret: CaretIndex, full_text: &str, ) -> Point2D<Px, Px>

Gets the top-middle origin for a caret visual that marks the insert index in the string.

pub fn nearest_line(&self, y: Px) -> Option<ShapedLine<'_>>

Gets the line that contains the y offset or is nearest to it.

pub fn snap_caret_line(&self, caret: CaretIndex) -> CaretIndex

Changes the caret line if the current line cannot contain the current char byte index.

This retains the same line at ambiguous points at the end/start of wrapped lines.

pub fn overflow_info( &self, max_size: Size2D<Px, Px>, overflow_suffix_width: Px, ) -> Option<TextOverflowInfo>

Gets a full overflow analysis.

pub fn highlight_rects( &self, range: Range<CaretIndex>, full_txt: &str, ) -> impl Iterator<Item = Rect<Px, Px>>

Rectangles of the text selected by range.

pub fn clip_lines( &self, clip_range: Range<CaretIndex>, clip_out: bool, txt: &str, lines: impl Iterator<Item = (Point2D<Px, Px>, Px)>, ) -> Vec<(Point2D<Px, Px>, Px)>

Clip under/overline to a text clip_range area, if clip_out only lines outside the range are visible.

Trait Implementations

impl Clone for ShapedText

fn clone(&self) -> ShapedText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShapedText

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

Formats the value using the given formatter.

impl PartialEq for ShapedText

fn eq(&self, other: &ShapedText) -> 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 ShapedText