Struct LazyPool

pub struct LazyPool { /* private fields */ }

A balanced resource allocator.

The information for each lease request is compared against the stored resources for compatibility. If no acceptable resources are stored for the information provided a new resource is created and returned.

Details

• Acceleration structures may be larger than requested
• Buffers may be larger than requested or have additional usage flags
• Images may have additional usage flags

Bucket Strategy

The information for each lease request is the key for a HashMap of buckets. If no bucket exists with compatible information 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 incompatible attributes will store an additional maximum of 4 images.

Memory Management

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

Implementations

impl LazyPool

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

Constructs a new LazyPool.

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

Constructs a new LazyPool with the given capacity information.

pub fn clear(&mut self)

Clears the pool, removing all resources.

pub fn clear_accel_structs(&mut self)

Clears the pool of acceleration structure resources.

pub fn clear_accel_structs_by_ty(&mut self, ty: AccelerationStructureTypeKHR)

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

pub fn clear_buffers(&mut self)

Clears the pool of buffer resources.

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 image resources matching the given information.

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

where F: FnMut(AccelerationStructureTypeKHR) -> bool,

Retains only the acceleration structure resources specified by the predicate.

In other words, remove all resources for which f(vk::AccelerationStructureTypeKHR) 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 LazyPool

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

Formats the value using the given formatter.

impl Pool<AccelerationStructureInfo, AccelerationStructure> for LazyPool

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

Lease a resource.

impl Pool<BufferInfo, Buffer> for LazyPool

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

Lease a resource.

impl Pool<ImageInfo, Image> for LazyPool

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

Lease a resource.