Skip to main content

TextRasterRequest

Struct TextRasterRequest 

Source
pub struct TextRasterRequest {
Show 13 fields pub text: String, pub font_size: f32, pub max_width: f32, pub line_height: f32, pub align: TextAlign, pub color: [u8; 4], pub emoji_policy: EmojiPolicy, pub content_version: u64, pub outline: Option<TextOutline>, pub background: Option<TextBackground>, pub font_family: Option<String>, pub letter_spacing: f32, pub font_weight: u16,
}
Expand description

One text layout request.

Fields§

§text: String

UTF-8 text shaped by the selected font fallback stack.

§font_size: f32

Logical font size in pixels.

§max_width: f32

Maximum layout width. Non-positive values disable wrapping.

§line_height: f32

Baseline-to-baseline distance in font sizes. Each line’s em box, 0.8 of a font size above its baseline and 0.2 below, is centred in its line when the line is taller than an em.

§align: TextAlign

Per-line horizontal alignment.

§color: [u8; 4]

Straight (not premultiplied), sRGB-encoded RGBA color. The output is premultiplied by glyph coverage and this alpha. A color glyph keeps its own colors, but for the parts its font draws in the text’s color, and takes this alpha as its opacity.

§emoji_policy: EmojiPolicy

Whether color glyphs are drawn in color, and which fonts emoji take.

§content_version: u64

Caller-managed version. Change it whenever content/style/font inputs change.

§outline: Option<TextOutline>

A band around the glyphs, drawn behind them.

§background: Option<TextBackground>

A box behind each line, drawn behind the outline.

§font_family: Option<String>

The family drawn first, as font_family reads it, matched without regard to ASCII case; the rest of the stack fills in what it lacks. None, or a family no font has, keeps the fallback order.

§letter_spacing: f32

Space added after each typographic character unit (grapheme cluster), in pixels, as CSS letter-spacing adds it: none after a line’s last, and none after a character of a cursive script (Arabic, say), whose joins it would break. Not zero, it turns optional ligatures off. In [-0.5, 1] font sizes.

§font_weight: u16

The weight, in [1, 1000], a family’s faces are matched by (CSS Fonts 4 weight matching), and a variable face’s wght is set to, clamped to its axis. No face is emboldened: a weight a family lacks draws its nearest face.

Implementations§

Source§

impl TextRasterRequest

Source

pub fn decoration_margin(&self) -> u32

Pixels the decorations reach past the layout box on every side when no ink does: the outline’s disc and the background’s padding, whole. The texture’s margin (TextTexture::layout_x) is this plus room for ink past the box.

Trait Implementations§

Source§

impl Clone for TextRasterRequest

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextRasterRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for TextRasterRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TextRasterRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.