Struct ShapedText 

pub struct ShapedText {
    pub text: SharedString,
    /* private fields */
}

Shaped text that may contain hard breaks and soft-wrapped lines.

WindowTextSystem::shape_text returns one visual line for each wrapped or hard-broken line. Paint it with ShapedText::paint, and paint backgrounds first with ShapedText::paint_background. It derefs to ShapedTextLayout, so the same result supplies measurements such as ShapedTextLayout::size and ShapedTextLayout::line_count.

Examples

window.update(|_view, window, _cx| {
    let text = "Hello\nworld";
    let run = TextRun {
        len: text.len(),
        font: font("Lilex"),
        color: hsla(0., 0., 0., 1.),
        ..Default::default()
    };
    let shaped = window
        .text_system()
        .shape_text(text, px(16.), &[run], None, None)
        .unwrap();
    assert_eq!(shaped.len(), text.len());
});

Fields

text: SharedString

The text that was shaped.

Implementations

impl ShapedText

pub fn len(&self) -> usize

Returns the length of the text in UTF-8 bytes.

pub fn paint( &self, origin: Point<Pixels>, line_height: Pixels, align: TextAlign, bounds: Option<Bounds<Pixels>>, window: &mut Window, cx: &mut App, ) -> Result<()>

Paints the glyphs and decorations of every visual line.

origin is the top-left corner of the first line. Each following line starts line_height below the previous one. bounds supplies the width used for alignment; when it is None, the layout’s wrap width is used. See ShapedLine::paint for how the arguments place the text.

Errors

Returns an error only if the window’s paint layer fails. A glyph that fails to paint is logged and skipped.

pub fn paint_background( &self, origin: Point<Pixels>, line_height: Pixels, align: TextAlign, bounds: Option<Bounds<Pixels>>, window: &mut Window, cx: &mut App, ) -> Result<()>

Paints the background colors of every visual line before the foreground. The arguments have the same meaning as ShapedText::paint.

Trait Implementations

impl Debug for ShapedText

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

Formats the value using the given formatter.

impl Deref for ShapedText

type Target = Arc<ShapedTextLayout>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ShapedText

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.