Struct Text

pub struct Text {
    pub content: String,
    pub position: Point,
    pub max_width: f32,
    pub color: Color,
    pub size: Pixels,
    pub line_height: LineHeight,
    pub font: Font,
    pub align_x: Alignment,
    pub align_y: Vertical,
    pub shaping: Shaping,
}

A bunch of text that can be drawn to a canvas

Fields

content: String

The contents of the text

position: Point

The position of the text relative to the alignment properties.

By default, this position will be relative to the top-left corner coordinate meaning that if the horizontal and vertical alignments are unchanged, this property will tell where the top-left corner of the text should be placed.

By changing the horizontal_alignment and vertical_alignment properties, you are are able to change what part of text is placed at this positions.

For example, when the horizontal_alignment and vertical_alignment are set to Center, the center of the text will be placed at the given position NOT the top-left coordinate.

max_width: f32

The maximum horizontal space available for this Text.

Text will break into new lines when the width is reached.

color: Color

The color of the text

size: Pixels

The size of the text

line_height: LineHeight

The line height of the text.

font: Font

The font of the text

align_x: Alignment

The horizontal alignment of the text

align_y: Vertical

The vertical alignment of the text

shaping: Shaping

The shaping strategy of the text.

Implementations

impl Text

pub fn draw_with(&self, f: impl FnMut(Path, Color))

Computes the Paths of the Text and draws them using the given closure.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl From<&str> for Text

fn from(content: &str) -> Text

Converts to this type from the input type.

impl From<String> for Text

fn from(content: String) -> Text

Converts to this type from the input type.