Struct gpu_descriptor::allocator::DescriptorAllocator

pub struct DescriptorAllocator<P, S> {
    buckets: HashMap<(DescriptorTotalCount, bool), DescriptorBucket<P>>,
    sets_cache: Vec<DescriptorSet<S>>,
    raw_sets_cache: Vec<S>,
    max_update_after_bind_descriptors_in_all_pools: u32,
    current_update_after_bind_descriptors_in_all_pools: u32,
    total: u32,
}

Descriptor allocator. Can be used to allocate descriptor sets for any layout.

Fields

buckets: HashMap<(DescriptorTotalCount, bool), DescriptorBucket<P>>

sets_cache: Vec<DescriptorSet<S>>

raw_sets_cache: Vec<S>

max_update_after_bind_descriptors_in_all_pools: u32

current_update_after_bind_descriptors_in_all_pools: u32

total: u32

Implementations

impl<P, S> DescriptorAllocator<P, S>

pub fn new(max_update_after_bind_descriptors_in_all_pools: u32) -> Self

Create new allocator instance.

pub unsafe fn allocate<L, D>( &mut self, device: &D, layout: &L, flags: DescriptorSetLayoutCreateFlags, layout_descriptor_count: &DescriptorTotalCount, count: u32, ) -> Result<Vec<DescriptorSet<S>>, AllocationError>

where S: Debug, L: Debug, D: DescriptorDevice<L, P, S>,

Allocate descriptor set with specified layout.

Safety

• Same device instance must be passed to all method calls of one DescriptorAllocator instance.
• flags must match flags that were used to create the layout.
• layout_descriptor_count must match descriptor numbers in the layout.

pub unsafe fn free<L, D, I>(&mut self, device: &D, sets: I)

where D: DescriptorDevice<L, P, S>, I: IntoIterator<Item = DescriptorSet<S>>,

Free descriptor sets.

Safety

• Same device instance must be passed to all method calls of one DescriptorAllocator instance.
• None of descriptor sets can be referenced in any pending command buffers.
• All command buffers where at least one of descriptor sets referenced move to invalid state.

pub unsafe fn cleanup<L>(&mut self, device: &impl DescriptorDevice<L, P, S>)

Perform cleanup to allow resources reuse.

Safety

• Same device instance must be passed to all method calls of one DescriptorAllocator instance.

Trait Implementations

impl<P: Debug, S: Debug> Debug for DescriptorAllocator<P, S>

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

Formats the value using the given formatter.

impl<P, S> Drop for DescriptorAllocator<P, S>

fn drop(&mut self)

Executes the destructor for this type.