Skip to main content

LineLayoutCache

Struct LineLayoutCache 

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

A per-window cache of shaped and wrapped line layouts, retaining the previous frame so reused layouts survive a frame boundary.

Implementations§

Source§

impl LineLayoutCache

Source

pub fn new( platform_text_system: Arc<dyn PlatformTextSystem>, font_generation: Arc<Atomic<usize>>, ) -> LineLayoutCache

Creates an empty cache backed by platform_text_system.

Source

pub fn layout_index(&self) -> LineLayoutIndex

Saves the current cache position so it can be reused or truncated later.

Source

pub fn reuse_layouts(&self, range: Range<LineLayoutIndex>)

Re-inserts layouts from the previous frame created before range.

Source

pub fn truncate_layouts(&self, index: LineLayoutIndex)

Drops layouts created after index, keeping the cache consistent.

Source

pub fn finish_frame(&self)

Ages the current frame into the previous frame and clears the current one.

Source

pub fn layout_wrapped_line<Text>( &self, text: Text, font_size: Pixels, runs: &[FontRun], wrap_width: Option<Pixels>, max_lines: Option<usize>, ) -> Arc<WrappedLineLayout> ⓘ
where Text: AsRef<str>, SharedString: From<Text>,

Shapes and wraps text, reusing a cached layout when the inputs match.

Source

pub fn layout_line<Text>( &self, text: Text, font_size: Pixels, runs: &[FontRun], force_width: Option<Pixels>, ) -> Arc<LineLayout> ⓘ
where Text: AsRef<str>, SharedString: From<Text>,

Shapes a single line of text, reusing a cached layout when the inputs match.

Source

pub fn try_layout_line_by_hash( &self, text_hash: u64, text_len: usize, font_size: Pixels, runs: &[FontRun], force_width: Option<Pixels>, ) -> Option<Arc<LineLayout>>

Try to retrieve a previously-shaped line layout using a caller-provided content hash.

This is a non-allocating cache probe: it does not materialize any text. If the layout is not already cached in either the current frame or previous frame, returns None.

Contract (caller enforced):

  • Same text_hash implies identical text content (collision risk accepted by caller).
  • text_len should be the UTF-8 byte length of the text (helps reduce accidental collisions).
Source

pub fn layout_line_by_hash( &self, text_hash: u64, text_len: usize, font_size: Pixels, runs: &[FontRun], force_width: Option<Pixels>, materialize_text: impl FnOnce() -> SharedString, ) -> Arc<LineLayout> ⓘ

Layout a line of text using a caller-provided content hash as the cache key.

This enables cache hits without materializing a contiguous SharedString for text. If the cache misses, materialize_text is invoked to produce the SharedString for shaping.

Contract (caller enforced):

  • Same text_hash implies identical text content (collision risk accepted by caller).
  • text_len should be the UTF-8 byte length of the text (helps reduce accidental collisions).

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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