Struct vulkano::descriptor_set::pool::UnsafeDescriptorPool

pub struct UnsafeDescriptorPool { /* private fields */ }

Pool that descriptors 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

impl UnsafeDescriptorPool

pub fn new(
    device: Arc<Device>,
    create_info: UnsafeDescriptorPoolCreateInfo
) -> Result<UnsafeDescriptorPool, OomError>

Creates a new UnsafeDescriptorPool.

Panics

• Panics if create_info.max_sets is 0.
• Panics if create_info.pool_sizes is empty.
• Panics if create_info.pool_sizes contains a descriptor type with a count of 0.

pub fn max_sets(&self) -> u32

Returns the maximum number of sets that can be allocated from the pool.

pub fn pool_sizes(&self) -> &HashMap<DescriptorType, u32>

Returns the number of descriptors of each type that the pool was created with.

pub fn can_free_descriptor_sets(&self) -> bool

Returns whether the descriptor sets allocated from the pool can be individually freed.

pub unsafe fn allocate_descriptor_sets<'a>(
    &mut self,
    allocate_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_descriptor_sets<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 to true.
• 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.

pub unsafe fn reset(&mut self) -> Result<(), OomError>

Resets the pool.

This destroys all descriptor sets and empties the pool.

Trait Implementations

impl Debug for UnsafeDescriptorPool

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

Formats the value using the given formatter.

impl DeviceOwned for UnsafeDescriptorPool

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl Drop for UnsafeDescriptorPool

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for UnsafeDescriptorPool

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<UnsafeDescriptorPool> for UnsafeDescriptorPool

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl VulkanObject for UnsafeDescriptorPool

type Object = DescriptorPool

The type of the object.

fn internal_object(&self) -> Self::Object

Returns a reference to the object.

impl Eq for UnsafeDescriptorPool