Skip to main content

TextRasterRequest

Struct TextRasterRequest 

Source
pub struct TextRasterRequest {
Show 14 fields pub text: String, pub font_size: f32, pub max_width: f32, pub line_height: f32, pub align: TextAlign, pub fill: TextFill, pub emoji_policy: EmojiPolicy, pub content_version: u64, pub strokes: Vec<TextStroke>, pub background: Option<TextBackground>, pub split_background: bool, 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. The em box (0.8 above the baseline, 0.2 below) is centered in lines taller than an em.

§align: TextAlign

Per-line horizontal alignment.

§fill: TextFill

Glyph paint. Color glyphs keep their own colors except for text-color parts, which use TextFill::foreground, whose alpha is also their 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.

§strokes: Vec<TextStroke>

Outlines, innermost first, each drawn behind the previous. At most 4, reaching at most 64 pixels together.

§background: Option<TextBackground>

A box behind each line, drawn behind the strokes.

§split_background: bool

Draws the background into TextRasterResult::background instead of under the glyphs, so a caller can draw something (a shadow) between them.

§font_family: Option<String>

Preferred family, matched against any font_family_names entry after NFC and lowercasing; the fallback stack fills missing glyphs. An unknown family keeps the fallback order and is listed by TextRasterizer::unmatched_families.

§letter_spacing: f32

Space after each grapheme cluster, like CSS letter-spacing, in [-0.5, 1] font sizes. Not applied after a line’s last cluster or within cursive scripts. Non-zero values disable optional ligatures.

§font_weight: u16

Weight in [1, 1000], matched per CSS Fonts 4 and applied to a variable face’s wght axis. Faces are never synthetically emboldened.

Implementations§

Source§

impl TextRasterRequest

Source

pub fn decoration_margin(&self) -> u32

Whole pixels the strokes or background reach past the layout box. The texture margin (TextTexture::layout_x) adds room for ink overflow to this.

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.