Struct TextAtlasFrame

Source
pub struct TextAtlasFrame<'a> { /* private fields */ }
Expand description

Scoped atlas access for one frame (pins pages until drop).

Dropping the guard calls finish_frame, unpinning every page. The guard’s mutable borrow prevents other atlas access during the frame.

§Examples

use ailloli_ui_render_wgpu::text::TextAtlasFrame;
let _: usize = std::mem::size_of::<TextAtlasFrame<'static>>();

Implementations§

Source§

impl<'a> TextAtlasFrame<'a>

Source

pub fn get_or_rasterize( &mut self, device: &Device, queue: &Queue, bind_group_layout: &BindGroupLayout, key: GlyphKey, font_data: &[u8], ) -> Option<(u8, Glyph)>

Looks up or rasterizes a glyph and pins its page until this guard drops.

Returns None for invalid font data, a missing glyph image, an oversized allocation, or when all pages are pinned and full.

§Examples
use ailloli_ui_render_wgpu::text::{GlyphKey, TextAtlasFrame};
fn lookup(frame: &mut TextAtlasFrame<'_>, device: &wgpu::Device,
    queue: &wgpu::Queue, layout: &wgpu::BindGroupLayout, font: &[u8], key: GlyphKey) {
    let _glyph: Option<(u8, ailloli_ui_render_wgpu::text::Glyph)> =
        frame.get_or_rasterize(device, queue, layout, key, font);
}
Source

pub fn record_missing_face(&mut self)

Records one glyph skipped because its face bytes were unavailable.

§Examples
use ailloli_ui_render_wgpu::text::TextAtlasFrame;
fn missing(frame: &mut TextAtlasFrame<'_>) { frame.record_missing_face(); }
Source

pub fn stats(&self) -> TextAtlasStats

Returns current per-frame counters and allocated page count.

§Examples
use ailloli_ui_render_wgpu::text::{TextAtlasFrame, TextAtlasStats};
fn stats(frame: &TextAtlasFrame<'_>) -> TextAtlasStats { frame.stats() }

Trait Implementations§

Source§

impl Drop for TextAtlasFrame<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for TextAtlasFrame<'a>

§

impl<'a> !RefUnwindSafe for TextAtlasFrame<'a>

§

impl<'a> Send for TextAtlasFrame<'a>

§

impl<'a> Sync for TextAtlasFrame<'a>

§

impl<'a> Unpin for TextAtlasFrame<'a>

§

impl<'a> !UnwindSafe for TextAtlasFrame<'a>

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.

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

Source§

type Output = T

Should always be Self
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

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

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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