Struct vulkano::descriptor_set::pool::DescriptorPool

pub struct DescriptorPool { /* 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 DescriptorPool

pub fn new( device: Arc<Device>, create_info: DescriptorPoolCreateInfo ) -> Result<DescriptorPool, Validated<VulkanError>>

Creates a new DescriptorPool.

pub unsafe fn from_handle( device: Arc<Device>, handle: DescriptorPool, create_info: DescriptorPoolCreateInfo ) -> DescriptorPool

Creates a new DescriptorPool from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from device.
• create_info must match the info used to create the object.

pub fn flags(&self) -> DescriptorPoolCreateFlags

Returns the flags that the descriptor pool was created with.

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 max_inline_uniform_block_bindings(&self) -> u32

Returns the maximum number of DescriptorType::InlineUniformBlock bindings that can be allocated from the descriptor pool.

pub unsafe fn allocate_descriptor_sets( &self, allocate_infos: impl IntoIterator<Item = DescriptorSetAllocateInfo> ) -> Result<impl ExactSizeIterator<Item = DescriptorPoolAlloc>, Validated<VulkanError>>

Allocates descriptor sets from the pool, one for each element in allocate_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.

Safety

• When the pool is dropped, the returned descriptor sets must not be in use by either the host or device.
• If the device API version is less than 1.1, and the khr_maintenance1 extension is not enabled on the device, then the length of allocate_infos must not be greater than the number of descriptor sets remaining in the pool, and the total number of descriptors of each type being allocated must not be greater than the number of descriptors of that type remaining in the pool.

pub unsafe fn free_descriptor_sets( &self, descriptor_sets: impl IntoIterator<Item = UnsafeDescriptorSet> ) -> Result<(), Validated<VulkanError>>

Frees some descriptor sets.

Note that it is not mandatory to free sets. Destroying or resetting the pool destroys all the descriptor sets.

Safety

• All elements of descriptor_sets must have been allocated from self, and not freed previously.
• All elements of descriptor_sets must not be in use by the host or device.

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

Resets the pool.

This destroys all descriptor sets and empties the pool.

Safety

• All descriptor sets that were previously allocated from self must not be in use by the host or device.

Trait Implementations

impl Debug for DescriptorPool

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

Formats the value using the given formatter.

impl DeviceOwned for DescriptorPool

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

Returns the device that owns self.

impl Drop for DescriptorPool

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for DescriptorPool

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DescriptorPool

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VulkanObject for DescriptorPool

type Handle = DescriptorPool

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for DescriptorPool