Skip to main content

TextTexturePipeline

Struct TextTexturePipeline 

Source
pub struct TextTexturePipeline {
    engine: FlexibleTextEngine,
    renderer: RefCell<FlexibleTextRenderer>,
    cache: RefCell<TextTextureCache>,
    format: TextureFormat,
}
Expand description

High-level pipeline: text → RenderTexture, with caching.

Owns its own FlexibleTextEngine + FlexibleTextRenderer + TextTextureCache. The engine + renderer share an Arc<Mutex<FontSystem>> (M-TEXT.3 contract).

The pipeline is opt-in — callers construct it explicitly. It is not held by crate::render::Renderer, so apps that never render flexible text don’t pay glyphon + cache costs.

Fields§

§engine: FlexibleTextEngine§renderer: RefCell<FlexibleTextRenderer>§cache: RefCell<TextTextureCache>§format: TextureFormat

Implementations§

Source§

impl TextTexturePipeline

Source

pub fn new(app: &Application, format: TextureFormat) -> Self

Build a pipeline with a system-fonts FlexibleTextEngine.

Source

pub fn from_font_paths<P: AsRef<Path>>( app: &Application, format: TextureFormat, paths: impl IntoIterator<Item = P>, ) -> Result<Self>

Build a pipeline with an engine seeded from explicit font files. See FlexibleTextEngine::from_font_paths.

§Errors

Returns io::Error if any font path can’t be opened or parsed.

Source

pub fn from_font_bytes( app: &Application, format: TextureFormat, bytes: impl IntoIterator<Item = Vec<u8>>, ) -> Self

Build a pipeline with an engine seeded from raw font bytes. See FlexibleTextEngine::from_font_bytes — designed for crates that ship their fonts via include_bytes! and want the same font set in native + wasm builds.

Source

pub fn format(&self) -> TextureFormat

Color format the pipeline writes into (matches what was passed to Self::new / Self::from_font_paths).

Source

pub fn stats(&self) -> (u64, u64)

(hits, misses) since construction. Useful in tests that verify the cache short-circuits on repeated lookups.

Source

pub fn cache_len(&self) -> usize

Number of currently-resident cache entries.

Source

pub fn clear_cache(&self)

Drop every cached entry.

Source

pub fn engine(&self) -> &FlexibleTextEngine

Borrow the engine for direct layout queries (metrics, etc.).

Source

pub fn render( &self, app: &Application, text: &WispText, width_px: u32, height_px: u32, ) -> Arc<RenderTexture>

Render text into a width_px × height_px RenderTexture, or return the cached version if text + dimensions match an earlier call.

The text is positioned with its top-left at the texture’s top-left (NDC (-1, +1)) and rendered with crate::color::Color WHITE as the default per-glyph color (the actual glyph color comes from crate::text::WispTextStyle::color).

Trait Implementations§

Source§

impl Debug for TextTexturePipeline

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

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

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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
§

impl<T> WasmNotSend for T
where T: Send,