Skip to main content

TextureCache

Struct TextureCache 

Source
pub struct TextureCache {
    pub width: u32,
    pub height: u32,
    pub tile_size: u32,
    /* private fields */
}
Expand description

2D tile-based LRU texture cache.

The simulated texture has width × height texels divided into tile_size × tile_size tiles. At most capacity tiles reside in the cache simultaneously.

§Cache line model

Each cache “line” corresponds to one complete tile. On a miss the whole tile is loaded from simulated main memory. The tile’s data is a flat Vec<u8> with tile_size * tile_size bytes (one byte per texel).

Fields§

§width: u32

Width of the texture in texels.

§height: u32

Height of the texture in texels.

§tile_size: u32

Edge length (in texels) of each square tile / cache line.

Implementations§

Source§

impl TextureCache

Source

pub fn new( width: u32, height: u32, tile_size: u32, capacity: usize, texture_data: Vec<u8>, ) -> Result<Self, CacheError>

Create a new texture cache backed by a flat texture buffer.

texture_data must have exactly width * height bytes. If it is shorter it is padded with zeros; if longer, the excess is ignored.

§Errors

Returns an error if width, height, tile_size, or capacity is 0.

Source

pub fn fetch(&mut self, x: u32, y: u32) -> Result<u8, CacheError>

Fetch the texel value at (x, y).

If the tile containing (x, y) is not in the cache, it is loaded (a miss); otherwise the cached copy is used (a hit).

§Errors

Returns CacheError::OutOfBounds if x >= width or y >= height.

Source

pub fn prefetch(&mut self, x: u32, y: u32) -> Result<(), CacheError>

Prefetch the tile containing (x, y) into the cache.

If the tile is already cached, this is a no-op (the hit counter is not incremented). If it is not cached, it is loaded and the prefetch counter is incremented.

§Errors

Returns CacheError::OutOfBounds if x >= width or y >= height.

Source

pub fn flush(&mut self)

Invalidate (evict) all tiles from the cache.

Statistics are preserved; only the tile storage is cleared.

Source

pub fn invalidate_tile(&mut self, key: TileKey) -> bool

Invalidate a specific tile if present.

Returns true if the tile was in the cache and was removed.

Source

pub fn resident_count(&self) -> usize

Number of tiles currently resident in the cache.

Source

pub fn is_resident(&self, key: TileKey) -> bool

Whether a specific tile is currently resident in the cache.

Source

pub fn stats(&self) -> &TexCacheStats

A reference to the current aggregate statistics.

Source

pub fn reset_stats(&mut self)

Reset all statistics counters to zero.

Source

pub fn capacity(&self) -> usize

Maximum number of tiles the cache can hold.

Source

pub fn grid_size(&self) -> (u32, u32)

Number of tiles in each dimension of the tile grid.

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

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

Source§

impl<T> WasmNotSendSync for T

Source§

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