Skip to main content

TextSystem

Struct TextSystem 

Source
pub struct TextSystem { /* private fields */ }
Expand description

The shaping and rasterization state of one window. The font database it shapes against is not in here — that is the session’s (crate::session::Session), passed in as fs — because a font registered in one window has to shape in every window of the session. What is here is coupled to this window’s glyph atlas: the shaped-buffer cache stamps its positioned glyphs with the atlas stamp they were packed against, and the frame lists are what TextId indexes.

Implementations§

Source§

impl TextSystem

Source

pub fn new() -> Self

Source

pub fn budget(&self) -> usize

The byte budget the cache is evicted to; see Core::set_text_cache_budget.

Source

pub fn set_budget(&mut self, bytes: usize)

Sets the budget. Takes effect at the next frame’s start, where eviction runs; nothing is evicted here.

Source

pub fn bytes(&self) -> usize

The estimated bytes the cache holds (see ENTRY_BASE_BYTES).

Source

pub fn len(&self) -> usize

How many shaped texts the cache holds (a long line’s chunks each count; the line itself does not).

Source

pub fn long_lines(&self) -> usize

How many long lines are held.

Source

pub fn is_empty(&self) -> bool

Source

pub fn add( &mut self, content: &str, style: &TextStyle, res: &Resources, fs: &mut FontSystem, ) -> TextId

Registers a text for this frame, shaping (or reusing) its buffer.

Source

pub fn measure( &mut self, content: &str, style: &TextStyle, res: &Resources, fs: &mut FontSystem, max_w: Option<f32>, ) -> TextMetrics

Measures content in style without adding a node: its unwrapped size, or with max_w (logical px) its size once wrapped to that width. The answer is what layout would give a text node with the same content and style at the current scale, wrap / max_lines / ellipsis included.

Source

pub fn measure_rich( &mut self, spans: &[Span<'_>], base: &TextStyle, res: &Resources, fs: &mut FontSystem, max_w: Option<f32>, ) -> TextMetrics

measure for a rich-text paragraph.

Source

pub fn add_rich( &mut self, spans: &[Span<'_>], base: &TextStyle, res: &Resources, fs: &mut FontSystem, ) -> TextId

Registers a rich-text paragraph for this frame. Spans shape as one flow, so wrapping crosses style boundaries correctly; past the long-line threshold the flow is chunked like a plain line’s.

Trait Implementations§

Source§

impl Default for TextSystem

Source§

fn default() -> Self

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.