Struct RetainedLedger 

pub struct RetainedLedger {
    pub entries: HashMap<u64, RetainedEntry>,
    pub frame: u64,
}

The set of retained pages the renderer reported resident after a frame.

Fields

entries: HashMap<u64, RetainedEntry>

Resident pages by raw RetainedKey.

frame: u64

The paint serial (PaintOutcome::paint_serial) of the most recent scene whose retained-store commit the renderer completed before publishing this ledger. A refused or failed frame does not advance it; the empty ledger a store clear, surface destroy or scale change publishes carries the last committed serial (0 before any). See RetainedLedger::covers.

Implementations

impl RetainedLedger

pub fn empty() -> Self

An empty ledger: nothing is resident. What every shell starts with.

pub fn from_entries( frame: u64, entries: impl IntoIterator<Item = (u64, (u32, u32), f32)>, ) -> Self

Build a ledger from (key, extent_px, scale) triples, describing the store after the scene painted at serial frame was committed.

pub fn covers(&self, serial: u64) -> bool

Whether the renderer had committed the scene painted at serial (or a later one) when it published this ledger: frame >= serial. Serial 0 — a paint no render root numbered — is covered by every ledger.

pub fn is_resident( &self, key: RetainedKey, extent_px: (u32, u32), scale: f32, ) -> bool

Whether key is resident at exactly extent_px and (within 1e-3) scale. A page rasterized at another size or scale is not reusable.

Trait Implementations

impl Clone for RetainedLedger

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetainedLedger

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RetainedLedger

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RetainedLedger

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RetainedLedger