Struct vizia::vg::TextContext

pub struct TextContext(/* private fields */);
Expand description

TextContext provides functionality for text processing in femtovg. You can add fonts using the Self::add_font_file(), Self::add_font_mem() and Self::add_font_dir() functions. For each registered font a FontId is returned.

The FontId can be supplied to crate::Paint along with additional parameters such as the font size.

The paint is needed when using TextContext’s measurement functions such as Self::measure_text().

Note that the measurements are done entirely with the supplied sizes in the paint parameter. If you need measurements that take a crate::Canvas’s transform or dpi into account (see crate::Canvas::set_size()), you need to use the measurement functions on the canvas.

Implementations§

§

impl TextContext

pub fn add_font_dir<T>(&self, path: T) -> Result<Vec<FontId>, ErrorKind>
where T: AsRef<Path>,

Registers all .ttf files from a directory with this text context. If successful, the font ids of all registered fonts are returned.

pub fn add_font_file<T>(&self, path: T) -> Result<FontId, ErrorKind>
where T: AsRef<Path>,

Registers the .ttf file from the specified path with this text context. If successful, the font id is returned.

pub fn add_font_mem(&self, data: &[u8]) -> Result<FontId, ErrorKind>

Registers the in-memory representation of a TrueType font pointed to by the data parameter with this text context. If successful, the font id is returned.

pub fn add_shared_font_with_index<T>( &self, data: T, face_index: u32 ) -> Result<FontId, ErrorKind>
where T: AsRef<[u8]> + 'static,

Registers the in-memory representation of a TrueType font pointed to by the shared data parameter with this text context. If successful, the font id is returned. The face_index specifies the face index if the font data is a true type font collection. For plain true type fonts, use 0 as index.

pub fn measure_text<S>( &self, x: f32, y: f32, text: S, paint: &Paint ) -> Result<TextMetrics, ErrorKind>
where S: AsRef<str>,

Returns information on how the provided text will be drawn with the specified paint.

pub fn break_text<S>( &self, max_width: f32, text: S, paint: &Paint ) -> Result<usize, ErrorKind>
where S: AsRef<str>,

Returns the maximum index-th byte of text that will fit inside max_width.

The retuned index will always lie at the start and/or end of a UTF-8 code point sequence or at the start or end of the text

pub fn break_text_vec<S>( &self, max_width: f32, text: S, paint: &Paint ) -> Result<Vec<Range<usize>>, ErrorKind>
where S: AsRef<str>,

Returnes a list of ranges representing each line of text that will fit inside max_width

pub fn measure_font(&self, paint: &Paint) -> Result<FontMetrics, ErrorKind>

Returns font metrics for a particular Paint.

pub fn resize_shaping_run_cache(&self, capacity: NonZero<usize>)

Adjusts the capacity of the shaping run cache. This is a cache for measurements of whole strings.

pub fn resize_shaped_words_cache(&self, capacity: NonZero<usize>)

Adjusts the capacity of the shaped words cache. This is a cache for measurements of individual words. Words are separated by UAX#29 word boundaries.

Trait Implementations§

§

impl Clone for TextContext

§

fn clone(&self) -> TextContext

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Default for TextContext

§

fn default() -> TextContext

Returns the “default value” for a type. 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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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,

§

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>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more