Struct vulkano::descriptor_set::pool::UnsafeDescriptorPool [−][src]
pub struct UnsafeDescriptorPool { /* fields omitted */ }
Expand description
Pool from which descriptor sets are allocated from.
A pool has a maximum number of descriptor sets and a maximum number of descriptors (one value per descriptor type) it can allocate.
Implementations
pub fn new(
device: Arc<Device>,
count: &DescriptorsCount,
max_sets: u32,
free_descriptor_set_bit: bool
) -> Result<UnsafeDescriptorPool, OomError>
pub fn new(
device: Arc<Device>,
count: &DescriptorsCount,
max_sets: u32,
free_descriptor_set_bit: bool
) -> Result<UnsafeDescriptorPool, OomError>
Initializes a new pool.
Initializes a pool whose capacity is given by count
and max_sets
. At most count
descriptors or max_sets
descriptor sets can be allocated at once with this pool.
If free_descriptor_set_bit
is true
, then individual descriptor sets can be free’d from
the pool. Otherwise you must reset or destroy the whole pool at once.
Panic
- Panics if all the descriptors count are 0.
- Panics if
max_sets
is 0.
pub unsafe fn alloc<'a>(
&mut self,
create_info: impl IntoIterator<Item = DescriptorSetAllocateInfo<'a>>
) -> Result<impl ExactSizeIterator<Item = UnsafeDescriptorSet>, DescriptorPoolAllocError>
pub unsafe fn alloc<'a>(
&mut self,
create_info: impl IntoIterator<Item = DescriptorSetAllocateInfo<'a>>
) -> Result<impl ExactSizeIterator<Item = UnsafeDescriptorSet>, DescriptorPoolAllocError>
Allocates descriptor sets from the pool, one for each element in create_info
.
Returns an iterator to the allocated sets, or an error.
The FragmentedPool
errors often can’t be prevented. If the function returns this error,
you should just create a new pool.
Panic
- Panics if one of the layouts wasn’t created with the same device as the pool.
Safety
See also the new
function.
- The total descriptors of the layouts must fit in the pool.
- The total number of descriptor sets allocated from the pool must not overflow the pool.
- You must ensure that the allocated descriptor sets are no longer in use when the pool is destroyed, as destroying the pool is equivalent to freeing all the sets.
pub unsafe fn free<I>(&mut self, descriptor_sets: I) -> Result<(), OomError> where
I: IntoIterator<Item = UnsafeDescriptorSet>,
pub unsafe fn free<I>(&mut self, descriptor_sets: I) -> Result<(), OomError> where
I: IntoIterator<Item = UnsafeDescriptorSet>,
Frees some descriptor sets.
Note that it is not mandatory to free sets. Destroying or resetting the pool destroys all the descriptor sets.
Safety
- The pool must have been created with
free_descriptor_set_bit
set totrue
. - The descriptor sets must have been allocated from the pool.
- The descriptor sets must not be free’d twice.
- The descriptor sets must not be in use by the GPU.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for UnsafeDescriptorPool
impl Send for UnsafeDescriptorPool
impl Sync for UnsafeDescriptorPool
impl Unpin for UnsafeDescriptorPool
impl UnwindSafe for UnsafeDescriptorPool
Blanket Implementations
Mutably borrows from an owned value. Read more
Builds a pointer to this type from a raw pointer.
Returns true if the size is suitable to store a type like this.
Returns the size of an individual element.