Struct GarbageCollector 

pub struct GarbageCollector<T> { /* private fields */ }

A request-aware garbage collector for built-in Pool types.

Successful acceleration-structure, buffer, and image requests are recorded until GarbageCollector::collect_resources is called. Collection retains only cached resources that the wrapped pool could use to satisfy those requests, then begins a new observation interval. Calling collect_resources without making any requests clears all managed resources.

Checked-out resources remain valid during collection. Resources returning to a retained bucket are evaluated by the next collection, while resources returning to a removed bucket are dropped. Command buffers, descriptor pools, and render passes are forwarded without being collected.

Examples

let mut pool = GarbageCollector::new(LazyPool::new(&device));

let buffer = pool.resource(BufferInfo::device_mem(
    1024,
    vk::BufferUsageFlags::STORAGE_BUFFER,
))?;
drop(buffer);

// Retain cached resources supporting requests made since the previous collection.
pool.collect_resources();

Implementations

impl<T> GarbageCollector<T>

pub fn new(pool: T) -> Self

Creates a garbage collector wrapper over the given pool.

impl<T> GarbageCollector<T>

where T: CollectResources,

pub fn collect_resources(&mut self)

Collects cached resources and begins a new request observation interval.

Only acceleration structures, buffers, and images supporting successful requests made since the previous call are retained. If there were no such requests, all managed resources are removed.

Trait Implementations

impl<T> Deref for GarbageCollector<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for GarbageCollector<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Pool<AccelerationStructureInfo, AccelerationStructure> for GarbageCollector<T>

where T: Pool<AccelerationStructureInfo, AccelerationStructure>,

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

Request a resource.

impl<T> Pool<BufferInfo, Buffer> for GarbageCollector<T>

where T: Pool<BufferInfo, Buffer>,

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

Request a resource.

impl<T> Pool<CommandBufferInfo, CommandBuffer> for GarbageCollector<T>

where T: Pool<CommandBufferInfo, CommandBuffer>,

fn resource( &mut self, info: CommandBufferInfo, ) -> Result<Lease<CommandBuffer>, DriverError>

Request a resource.

impl<T> Pool<ImageInfo, Image> for GarbageCollector<T>

where T: Pool<ImageInfo, Image>,

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

Request a resource.