Struct screen_13::pool::hash::HashPool

pub struct HashPool { /* private fields */ }

A high-performance resource allocator.

Bucket Strategy

The information for each lease request is the key for a HashMap of buckets. If no bucket exists with the exact information provided a new bucket is created.

In practice this means that for a PoolInfo::image_capacity of 4, requests for a 1024x1024 image with certain attributes will store a maximum of 4 such images. Requests for any image having a different size or attributes will store an additional maximum of 4 images.

Memory Management

If requests for varying resources is common HashPool::clear_images_by_info and other memory management functions are nessecery in order to avoid using all available device memory.

Implementations

impl HashPool

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

Constructs a new HashPool.

pub fn with_capacity(device: &Arc<Device>, info: impl Into<PoolInfo>) -> Self

Constructs a new HashPool with the given capacity information.

pub fn clear(&mut self)

Clears the pool, removing all resources.

impl HashPool

pub fn clear_accel_structs(&mut self)

Clears the pool of acceleration structure resources.

pub fn clear_accel_structs_by_info( &mut self, info: impl Into<AccelerationStructureInfo> )

Clears the pool of all acceleration structure resources matching the given information.

pub fn retain_accel_structs<F>(&mut self, f: F)

where F: FnMut(AccelerationStructureInfo) -> bool,

Retains only the acceleration structure resources specified by the predicate.

In other words, remove all acceleration structure resources for which f(AccelerationStructureInfo) returns false.

The elements are visited in unsorted (and unspecified) order.

Performance

Provides the same performance guarantees as HashMap::retain.

impl HashPool

pub fn clear_buffers(&mut self)

Clears the pool of buffer resources.

pub fn clear_buffers_by_info(&mut self, info: impl Into<BufferInfo>)

Clears the pool of all buffer resources matching the given information.

pub fn retain_buffers<F>(&mut self, f: F)

where F: FnMut(BufferInfo) -> bool,

Retains only the buffer resources specified by the predicate.

In other words, remove all buffer resources for which f(BufferInfo) returns false.

The elements are visited in unsorted (and unspecified) order.

Performance

Provides the same performance guarantees as HashMap::retain.

impl HashPool

pub fn clear_images(&mut self)

Clears the pool of image resources.

pub fn clear_images_by_info(&mut self, info: impl Into<ImageInfo>)

Clears the pool of all image resources matching the given information.

pub fn retain_images<F>(&mut self, f: F)

where F: FnMut(ImageInfo) -> bool,

Retains only the image resources specified by the predicate.

In other words, remove all image resources for which f(ImageInfo) returns false.

The elements are visited in unsorted (and unspecified) order.

Performance

Provides the same performance guarantees as HashMap::retain.

Trait Implementations

impl Debug for HashPool

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

Formats the value using the given formatter.

impl Pool<AccelerationStructureInfo, AccelerationStructure> for HashPool

fn lease( &mut self, info: AccelerationStructureInfo ) -> Result<Lease<AccelerationStructure>, DriverError>

Lease a resource.

impl Pool<BufferInfo, Buffer> for HashPool

fn lease(&mut self, info: BufferInfo) -> Result<Lease<Buffer>, DriverError>

Lease a resource.

impl Pool<ImageInfo, Image> for HashPool

fn lease(&mut self, info: ImageInfo) -> Result<Lease<Image>, DriverError>

Lease a resource.