Struct SamplerCache 

pub struct SamplerCache { /* private fields */ }

A thread-safe cache of GPU samplers.

This cache ensures that identical sampler configurations share the same GPU sampler object, reducing memory usage and creation overhead.

Example

use astrelis_render::{SamplerCache, SamplerKey};

let cache = SamplerCache::new();

// Get or create a linear sampler
let sampler = cache.get_or_create(&device, SamplerKey::linear());

// The same sampler is returned for identical keys
let sampler2 = cache.get_or_create(&device, SamplerKey::linear());
// sampler and sampler2 point to the same GPU sampler

Implementations

impl SamplerCache

pub fn new() -> Self

Create a new empty sampler cache.

pub fn get_or_create(&self, device: &Device, key: SamplerKey) -> Arc<Sampler>

Get a sampler from the cache or create a new one.

If a sampler with the given key already exists in the cache, it is returned. Otherwise, a new sampler is created and cached.

Panics

Panics if the internal RwLock is poisoned (another thread panicked while holding the lock).

pub fn get_or_create_from_descriptor( &self, device: &Device, descriptor: &SamplerDescriptor<'_>, ) -> Arc<Sampler>

Get a sampler from the cache or create one using a descriptor.

This is a convenience method that converts the descriptor to a key.

pub fn linear(&self, device: &Device) -> Arc<Sampler>

Get a default linear sampler.

pub fn nearest(&self, device: &Device) -> Arc<Sampler>

Get a default nearest (point) sampler.

pub fn linear_repeat(&self, device: &Device) -> Arc<Sampler>

Get a repeating linear sampler.

pub fn nearest_repeat(&self, device: &Device) -> Arc<Sampler>

Get a repeating nearest sampler.

pub fn linear_mirror(&self, device: &Device) -> Arc<Sampler>

Get a mirrored linear sampler.

pub fn nearest_mirror(&self, device: &Device) -> Arc<Sampler>

Get a mirrored nearest sampler.

pub fn from_sampling( &self, device: &Device, sampling: ImageSampling, ) -> Arc<Sampler>

Get a sampler for the given sampling mode.

pub fn len(&self) -> usize

Get the number of cached samplers.

Panics

Panics if the internal RwLock is poisoned.

pub fn is_empty(&self) -> bool

Check if the cache is empty.

Panics

Panics if the internal RwLock is poisoned.

pub fn clear(&self)

Clear the cache, releasing all cached samplers.

This should only be called when you’re sure no references to cached samplers are still in use.

Panics

Panics if the internal RwLock is poisoned.

Trait Implementations

impl Default for SamplerCache

fn default() -> Self

Returns the “default value” for a type.