Skip to main content

SharedText

Struct SharedText 

Source
pub struct SharedText(/* private fields */);
Expand description

The device-scoped half of text rendering, shareable across Runners (issue #94): the font system + shaping cache, the CPU-side glyph and MSDF atlases, and their GPU page textures with bind groups. Everything here is independent of the swapchain format and MSAA sample count, so one SharedText per wgpu::Device can back every window — a multi-window host that passes the same handle to each Runner (Runner::with_shared_text) pays glyph rasterization, shaping, warm-up, and atlas VRAM once per device instead of once per window.

Cloning is cheap (an Arc); the inner state is mutex-guarded and locked per record/flush call, so windows can be prepared from one thread in any order. Each attached Runner widens the atlases’ LRU protection window (see MsdfAtlas::set_lru_protection_window) so a page referenced by one window’s in-flight frame can’t be recycled by another’s prepare.

The default Runner constructors create a private SharedText per runner — single-window behavior is unchanged.

Implementations§

Source§

impl SharedText

Source

pub fn new(device: &Device) -> Self

A fresh shared text pool for device. Pass the same handle to every Runner created on that device. Do not share one SharedText across devices — the page textures belong to the device that created them.

Source

pub fn warm_default_glyphs(&self)

Pre-rasterize printable ASCII for the bundled default faces — see [TextPaint::warm_default_glyphs] for cost and rationale. On a shared pool this runs once per device: warm the pool before (or after) attaching runners, and every attached runner is warm. Runners attached to an already-warm pool skip the cost in their own warm_default_glyphs automatically (rasterized glyphs are cache hits).

Source

pub fn warm_glyphs(&self, families: &[FontFamily], chars: &[char])

Pre-rasterize a chosen set of (family, char) glyphs — the app-selectable counterpart to Self::warm_default_glyphs. Use it to warm fonts you registered yourself, or a glyph set beyond printable ASCII (e.g. the Latin-1 supplement, or the symbols your UI actually shows). MSDF keys are size/weight-independent, so each glyph is rasterized once and reused at every size.

Source

pub fn export_msdf_snapshot(&self) -> Vec<u8>

Serialize the resident outline-glyph atlas into a portable snapshot blob. Glyphs are keyed by a content hash of each font’s bytes, so the blob reloads across runs (and processes) regardless of font-registration order. Persist it however suits the app — embed via include_bytes!, or cache to disk — and reload with Self::import_msdf_snapshot to skip regenerating those glyphs.

This is the app-driven equivalent of the built-in prebaked-default-fonts bake, for fonts damascene can’t bake at its own build time (anything you register_font).

Source

pub fn import_msdf_snapshot(&self, bytes: &[u8]) -> Result<usize, SnapshotError>

Load a snapshot produced by Self::export_msdf_snapshot, resolving each font by content hash against the fonts currently loaded; sections whose font isn’t present are skipped, and already-resident glyphs are left untouched. Returns the number of glyphs loaded, or SnapshotError if the blob is unreadable or its bake parameters don’t match this renderer (in which case nothing is loaded and you should warm live instead).

Trait Implementations§

Source§

impl Clone for SharedText

Source§

fn clone(&self) -> SharedText

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

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

Source§

fn downcast(&self) -> &T

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = 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.
Source§

impl<T> Upcast<T> for T

Source§

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

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,