Skip to main content

TextShaper

Struct TextShaper 

Source
pub struct TextShaper {
    pub measurer: TextMeasurer,
    pub atlas: GlyphAtlas,
}
Expand description

Combines the measurer and the atlas into a text shaper.

The shaper is the single place where text is turned into positioned glyphs, so the Canvas2D backend and the GPU backends lay text out identically — the same label lands on the same pixel no matter which backend is in use.

Fields§

§measurer: TextMeasurer

The measurer used to size the text.

§atlas: GlyphAtlas

The atlas the glyphs are rasterised into.

Implementations§

Source§

impl TextShaper

Inherent implementation of TextShaper.

Source

pub fn new(measurer: TextMeasurer, atlas: GlyphAtlas) -> Self

Creates a shaper with the given measurer and atlas.

§Arguments
  • TextMeasurer - A TextMeasurer parameter.
  • GlyphAtlas - A GlyphAtlas parameter.
Source

pub fn measurer(&self) -> &TextMeasurer

Returns the measurer.

§Returns
  • &TextMeasurer - A TextMeasurer value.
Source

pub fn atlas(&self) -> &GlyphAtlas

Returns the atlas.

§Returns
  • &GlyphAtlas - A GlyphAtlas value.
Source

pub fn atlas_mut(&mut self) -> &mut GlyphAtlas

Returns the atlas as mutable, so a backend can upload it.

§Returns
  • &mut GlyphAtlas - A mut GlyphAtlas value.
Source

pub fn shape( &mut self, text: &str, style: &TextStyle, x: f64, y: f64, ) -> TextRun

Shapes a run of text.

x and y are the anchor of the text; the alignment and the vertical alignment of the style decide which part of the text lands on the anchor.

A text that carries rich-text markup — {name|content} — is split into its runs, and each run is shaped with the style that the name refers to.

§Arguments
  • &str - Shared reference to a str.
  • &TextStyle - Shared reference to a TextStyle.
  • f64 - A 64-bit float (f64).
§Returns
  • TextRun - A TextRun value.
Source§

impl TextShaper

Source

pub fn get_measurer(&self) -> &TextMeasurer

Source

pub fn get_mut_measurer(&mut self) -> &mut TextMeasurer

Source

pub fn set_measurer(&mut self, val: TextMeasurer) -> &mut Self

Source

pub fn get_atlas(&self) -> &GlyphAtlas

Source

pub fn get_mut_atlas(&mut self) -> &mut GlyphAtlas

Source

pub fn set_atlas(&mut self, val: GlyphAtlas) -> &mut Self

Trait Implementations§

Source§

impl Clone for TextShaper

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 TextShaper

Source§

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

Formats the value using the given formatter. Read more

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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more