Struct TextOptions 

pub struct TextOptions {

    pub x: f32,
    pub y: f32,
    pub font_size: f32,
    pub color: Color,
    pub font_family: Option<String>,
    pub font_weight: FontWeight,
    pub font_style: FontStyle,
    pub highlight_color: Option<Color>,
    pub max_width: Option<f32>,
    pub max_height: Option<f32>,
    pub line_height: f32,
    pub wrap: TextWrap,
    pub align: Option<HorizontalAlignment>,
    pub valign: Option<VerticalAlignment>,
    pub min_width: Option<f32>,
    pub clip_rect: Option<[f32; 4]>,
    pub scale_factor: f32,
    pub ellipsis: bool,
}

Options for configuring text rendering. Use the builder-like methods for a fluent API.

Fields

x: f32

X coordinate of the text.

y: f32

font_size: f32

color: Color

font_family: Option<String>

font_weight: FontWeight

font_style: FontStyle

highlight_color: Option<Color>

max_width: Option<f32>

max_height: Option<f32>

line_height: f32

wrap: TextWrap

align: Option<HorizontalAlignment>

Horizontal alignment. If None, per-line settings are preserved.

valign: Option<VerticalAlignment>

Vertical alignment within the available space.

min_width: Option<f32>

clip_rect: Option<[f32; 4]>

scale_factor: f32

ellipsis: bool

Implementations

impl TextOptions

pub fn new() -> Self

pub fn min_width(self, w: f32) -> Self

pub fn at(self, x: f32, y: f32) -> Self

pub fn font_size(self, size: f32) -> Self

pub fn color(self, color: Color) -> Self

pub fn font_family(self, family: impl Into<String>) -> Self

pub fn font_weight(self, weight: FontWeight) -> Self

pub fn font_style(self, style: FontStyle) -> Self

pub fn highlight(self, color: Color) -> Self

pub fn max_width(self, width: f32) -> Self

pub fn max_height(self, height: f32) -> Self

Sets the maximum height for word wrapping and vertical alignment.

pub fn line_height(self, height: f32) -> Self

pub fn wrap(self, strategy: TextWrap) -> Self

pub fn align(self, alignment: HorizontalAlignment) -> Self

pub fn valign(self, alignment: VerticalAlignment) -> Self

pub fn clip_rect(self, x: f32, y: f32, w: f32, h: f32) -> Self

pub fn scale_factor(self, sf: f32) -> Self

pub fn ellipsis(self, enabled: bool) -> Self

pub fn apply(&self, font_system: &mut FontSystem, buffer: &mut Buffer)

pub fn as_attrs(&self) -> Attrs<'_>

Trait Implementations

impl Clone for TextOptions

fn clone(&self) -> TextOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextOptions

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

Formats the value using the given formatter.

impl Default for TextOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for TextOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextOptions