vkCreateDescriptorSetLayout - Create a new descriptor set layout

Valid Usage

• If the descriptor layout exceeds the limits reported through the physical device limits, then getDescriptorSetLayoutSupport must have returned DescriptorSetLayoutSupport with support equal to TRUE for pCreateInfo

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid DescriptorSetLayoutCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSetLayout must be a valid pointer to a DescriptorSetLayout handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, AllocationCallbacks, DescriptorSetLayout, DescriptorSetLayoutCreateInfo, Device

A convenience wrapper to make a compatible pair of calls to createDescriptorSetLayout and destroyDescriptorSetLayout

To ensure that destroyDescriptorSetLayout is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyDescriptorSetLayout - Destroy a descriptor set layout object

Valid Usage

• If AllocationCallbacks were provided when descriptorSetLayout was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when descriptorSetLayout was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If descriptorSetLayout is not NULL_HANDLE, descriptorSetLayout must be a valid DescriptorSetLayout handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If descriptorSetLayout is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to descriptorSetLayout must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, DescriptorSetLayout, Device

vkCreateDescriptorPool - Creates a descriptor pool object

Description

The created descriptor pool is returned in pDescriptorPool.

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid DescriptorPoolCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pDescriptorPool must be a valid pointer to a DescriptorPool handle
• The device must have been created with at least 1 queue

Return Codes

Success

• SUCCESS

Failure

• ERROR_FRAGMENTATION_EXT
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, AllocationCallbacks, DescriptorPool, DescriptorPoolCreateInfo, Device

A convenience wrapper to make a compatible pair of calls to createDescriptorPool and destroyDescriptorPool

To ensure that destroyDescriptorPool is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyDescriptorPool - Destroy a descriptor pool object

Description

When a pool is destroyed, all descriptor sets allocated from the pool are implicitly freed and become invalid. Descriptor sets allocated from a given pool do not need to be freed before destroying that descriptor pool.

Valid Usage

• All submitted commands that refer to descriptorPool (via any allocated descriptor sets) must have completed execution

• If AllocationCallbacks were provided when descriptorPool was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when descriptorPool was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If descriptorPool is not NULL_HANDLE, descriptorPool must be a valid DescriptorPool handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If descriptorPool is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to descriptorPool must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, DescriptorPool, Device

vkResetDescriptorPool - Resets a descriptor pool object

Description

Resetting a descriptor pool recycles all of the resources from all of the descriptor sets allocated from the descriptor pool back to the descriptor pool, and the descriptor sets are implicitly freed.

Valid Usage

• All uses of descriptorPool (via any allocated descriptor sets) must have completed execution

Valid Usage (Implicit)

• device must be a valid Device handle

• descriptorPool must be a valid DescriptorPool handle
• flags must be 0
• descriptorPool must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to descriptorPool must be externally synchronized

• Host access to any DescriptorSet objects allocated from descriptorPool must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, DescriptorPool, DescriptorPoolResetFlags, Device

vkAllocateDescriptorSets - Allocate one or more descriptor sets

Description

The allocated descriptor sets are returned in pDescriptorSets.

When a descriptor set is allocated, the initial state is largely uninitialized and all descriptors are undefined, with the exception that samplers with a non-null pImmutableSamplers are initialized on allocation. Descriptors also become undefined if the underlying resource or view object is destroyed. Descriptor sets containing undefined descriptors can still be bound and used, subject to the following conditions:

• For descriptor set bindings created with the DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT bit set, all descriptors in that binding that are dynamically used must have been populated before the descriptor set is consumed.
• For descriptor set bindings created without the DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT bit set, all descriptors in that binding that are statically used must have been populated before the descriptor set is consumed.
• Descriptor bindings with descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK can be undefined when the descriptor set is consumed; though values in that block will be undefined.
• Entries that are not used by a pipeline can have undefined descriptors.

If a call to allocateDescriptorSets would cause the total number of descriptor sets allocated from the pool to exceed the value of DescriptorPoolCreateInfo::maxSets used to create pAllocateInfo->descriptorPool, then the allocation may fail due to lack of space in the descriptor pool. Similarly, the allocation may fail due to lack of space if the call to allocateDescriptorSets would cause the number of any given descriptor type to exceed the sum of all the descriptorCount members of each element of DescriptorPoolCreateInfo::pPoolSizes with a type equal to that type.

Additionally, the allocation may also fail if a call to allocateDescriptorSets would cause the total number of inline uniform block bindings allocated from the pool to exceed the value of DescriptorPoolInlineUniformBlockCreateInfo::maxInlineUniformBlockBindings used to create the descriptor pool.

If the allocation fails due to no more space in the descriptor pool, and not because of system or device memory exhaustion, then ERROR_OUT_OF_POOL_MEMORY must be returned.

allocateDescriptorSets can be used to create multiple descriptor sets. If the creation of any of those descriptor sets fails, then the implementation must destroy all successfully created descriptor set objects from this command, set all entries of the pDescriptorSets array to NULL_HANDLE and return the error.

Valid Usage (Implicit)

• device must be a valid Device handle

• pAllocateInfo must be a valid pointer to a valid DescriptorSetAllocateInfo structure
• pDescriptorSets must be a valid pointer to an array of pAllocateInfo->descriptorSetCount DescriptorSet handles
• The device must have been created with at least 1 queue
• pAllocateInfo->descriptorSetCount must be greater than 0

Return Codes

Success

• SUCCESS

Failure

• ERROR_FRAGMENTED_POOL
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_POOL_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, DescriptorSet, DescriptorSetAllocateInfo, Device

A convenience wrapper to make a compatible pair of calls to allocateDescriptorSets and freeDescriptorSets

To ensure that freeDescriptorSets is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkFreeDescriptorSets - Free one or more descriptor sets

Description

After calling freeDescriptorSets, all descriptor sets in pDescriptorSets are invalid.

Valid Usage

• All submitted commands that refer to any element of pDescriptorSets must have completed execution

• pDescriptorSets must be a valid pointer to an array of descriptorSetCount DescriptorSet handles, each element of which must either be a valid handle or NULL_HANDLE
• descriptorPool must have been created with the DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT flag

Valid Usage (Implicit)

• device must be a valid Device handle

• descriptorPool must be a valid DescriptorPool handle
• descriptorSetCount must be greater than 0
• descriptorPool must have been created, allocated, or retrieved from device
• Each element of pDescriptorSets that is a valid handle must have been created, allocated, or retrieved from descriptorPool

Host Synchronization

• Host access to descriptorPool must be externally synchronized

• Host access to each member of pDescriptorSets must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, DescriptorPool, DescriptorSet, Device

vkUpdateDescriptorSets - Update the contents of a descriptor set object

Description

The operations described by pDescriptorWrites are performed first, followed by the operations described by pDescriptorCopies. Within each array, the operations are performed in the order they appear in the array.

Each element in the pDescriptorWrites array describes an operation updating the descriptor set using descriptors for resources specified in the structure.

Each element in the pDescriptorCopies array is a CopyDescriptorSet structure describing an operation copying descriptors between sets.

If the dstSet member of any element of pDescriptorWrites or pDescriptorCopies is bound, accessed, or modified by any command that was recorded to a command buffer which is currently in the recording or executable state, and any of the descriptor bindings that are updated were not created with the DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT or DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT bits set, that command buffer becomes invalid.

Copying a descriptor from a descriptor set does not constitute a use of the referenced resource or view, as it is the reference itself that is copied. Applications can copy a descriptor referencing a destroyed resource, and it can copy an undefined descriptor. The destination descriptor becomes undefined in both cases.

Valid Usage

• For each element i where pDescriptorWrites[i].descriptorType is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, elements of the pTexelBufferView member of pDescriptorWrites[i] must have been created on device

• For each element i where pDescriptorWrites[i].descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER, DESCRIPTOR_TYPE_STORAGE_BUFFER, DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the buffer member of any element of the pBufferInfo member of pDescriptorWrites[i] must have been created on device
• For each element i where pDescriptorWrites[i].descriptorType is DESCRIPTOR_TYPE_SAMPLER or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and dstSet was not allocated with a layout that included immutable samplers for dstBinding with descriptorType, the sampler member of any element of the pImageInfo member of pDescriptorWrites[i] must have been created on device
• For each element i where pDescriptorWrites[i].descriptorType is DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_INPUT_ATTACHMENT, DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER the imageView member of any element of pDescriptorWrites[i] must have been created on device
• For each element i where pDescriptorWrites[i].descriptorType is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, elements of the pAccelerationStructures member of a WriteDescriptorSetAccelerationStructureKHR structure in the pNext chain of pDescriptorWrites[i] must have been created on device
• For each element i where pDescriptorWrites[i].descriptorType is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, elements of the pAccelerationStructures member of a WriteDescriptorSetAccelerationStructureNV structure in the pNext chain of pDescriptorWrites[i] must have been created on device
• For each element i where pDescriptorWrites[i].descriptorType is DESCRIPTOR_TYPE_TENSOR_ARM, elements of the pTensorViews member of a WriteDescriptorSetTensorARM structure in the pNext chain of pDescriptorWrites[i] must have been created on device
• For each element i where pDescriptorWrites[i].descriptorType is DESCRIPTOR_TYPE_SAMPLER, DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, pDescriptorWrites[i].pImageInfo must be a valid pointer to an array of pDescriptorWrites[i].descriptorCount valid DescriptorImageInfo structures
• The dstSet member of each element of pDescriptorWrites or pDescriptorCopies for bindings which were created without the DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT or DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT bits set must not be used by any command that was recorded to a command buffer which is in the pending state
• Host access to pDescriptorWrites[i].dstSet and pDescriptorCopies[i].dstSet must be externally synchronized unless explicitly denoted otherwise for specific flags

Valid Usage (Implicit)

• device must be a valid Device handle

• If descriptorWriteCount is not 0, pDescriptorWrites must be a valid pointer to an array of descriptorWriteCount valid WriteDescriptorSet structures
• If descriptorCopyCount is not 0, pDescriptorCopies must be a valid pointer to an array of descriptorCopyCount valid CopyDescriptorSet structures

See Also

VK_VERSION_1_0, CopyDescriptorSet, Device, WriteDescriptorSet

VkDescriptorBufferInfo - Structure specifying descriptor buffer information

Description

For DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC and DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC descriptor types, offset is the base offset from which the dynamic offset is applied and range is the static size used for all dynamic offsets.

When range is WHOLE_SIZE the effective range is calculated at updateDescriptorSets is by taking the size of buffer minus the offset.

Valid Usage

• offset must be less than the size of buffer

• If range is not equal to WHOLE_SIZE, range must be greater than 0
• If range is not equal to WHOLE_SIZE, range must be less than or equal to the size of buffer minus offset
• If the nullDescriptor feature is not enabled, buffer must not be NULL_HANDLE
• If buffer is NULL_HANDLE, offset must be zero and range must be WHOLE_SIZE

Valid Usage (Implicit)

• If buffer is not NULL_HANDLE, buffer must be a valid Buffer handle

See Also

VK_VERSION_1_0, Buffer, DeviceSize, WriteDescriptorSet

VkDescriptorImageInfo - Structure specifying descriptor image information

Description

Members of DescriptorImageInfo that are not used in an update (as described above) are ignored.

Valid Usage

• imageView must not be a 2D array image view created from a 3D image

• If imageView is a 2D view created from a 3D image, then descriptorType must be DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_SAMPLED_IMAGE, or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
• If imageView is a 2D view created from a 3D image, then the image must have been created with IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT set
• If the image2DViewOf3D feature is not enabled or descriptorType is not DESCRIPTOR_TYPE_STORAGE_IMAGE then imageView must not be a 2D view created from a 3D image
• If the sampler2DViewOf3D feature is not enabled or descriptorType is not DESCRIPTOR_TYPE_SAMPLED_IMAGE or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER then imageView must not be a 2D view created from a 3D image
• If imageView is created from a depth/stencil image, the aspectMask used to create the imageView must include either IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT but not both
• If imageLayout is IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, then the aspectMask used to create imageView must not include either IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If imageLayout is IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, then the aspectMask used to create imageView must not include IMAGE_ASPECT_COLOR_BIT
• If sampler is used and the Format of the image is a multi-planar format, the image must have been created with IMAGE_CREATE_MUTABLE_FORMAT_BIT, and the aspectMask of the imageView must be a valid multi-planar aspect mask bit
• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::mutableComparisonSamplers is FALSE, then sampler must have been created with SamplerCreateInfo::compareEnable set to FALSE

Valid Usage (Implicit)

• Both of imageView, and sampler that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

VK_VERSION_1_0, DescriptorDataEXT, ImageLayout, ImageView, Sampler, WriteDescriptorSet

VkWriteDescriptorSet - Structure specifying the parameters of a descriptor set write operation

Description

Only one of pImageInfo, pBufferInfo, or pTexelBufferView members is used according to the descriptor type specified in the descriptorType member of the containing WriteDescriptorSet structure, or none of them in case descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, in which case the source data for the descriptor writes is taken from the WriteDescriptorSetInlineUniformBlock structure included in the pNext chain of WriteDescriptorSet, or if descriptorType is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, in which case the source data for the descriptor writes is taken from the WriteDescriptorSetAccelerationStructureKHR structure in the pNext chain of WriteDescriptorSet, or if descriptorType is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, in which case the source data for the descriptor writes is taken from the WriteDescriptorSetAccelerationStructureNV structure in the pNext chain of WriteDescriptorSet, or if descriptorType is DESCRIPTOR_TYPE_TENSOR_ARM, in which case the source data for the descriptor writes is taken from the instance of WriteDescriptorSetTensorARM in the pNext chain of WriteDescriptorSet, as specified below.

If the nullDescriptor feature is enabled, the buffer, acceleration structure, tensor, imageView, or bufferView can be NULL_HANDLE. Loads from a null descriptor return zero values and stores and atomics to a null descriptor are discarded. A null acceleration structure descriptor results in the miss shader being invoked.

If the destination descriptor is a mutable descriptor, the active descriptor type for the destination descriptor becomes descriptorType.

Consecutive Binding Updates

If the dstBinding has fewer than descriptorCount array elements remaining starting from dstArrayElement, then the remainder will be used to update the subsequent binding - dstBinding+1 starting at array element zero. If a binding has a descriptorCount of zero, it is skipped. This behavior applies recursively, with the update affecting consecutive bindings as needed to update all descriptorCount descriptors. Consecutive bindings must have identical DescriptorType, ShaderStageFlags, DescriptorBindingFlagBits, and immutable samplers references. In addition, if the DescriptorType is DESCRIPTOR_TYPE_MUTABLE_EXT, the supported descriptor types in MutableDescriptorTypeCreateInfoEXT must be equally defined.

The same behavior applies to bindings with a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK where descriptorCount specifies the number of bytes to update while dstArrayElement specifies the starting byte offset, thus in this case if the dstBinding has a smaller byte size than the sum of dstArrayElement and descriptorCount, then the remainder will be used to update the subsequent binding - dstBinding+1 starting at offset zero. This falls out as a special case of the above rule.

Valid Usage

• dstBinding must be less than or equal to the maximum value of binding of all DescriptorSetLayoutBinding structures specified when dstSet’s descriptor set layout was created

• dstBinding must be a binding with a non-zero descriptorCount
• dstBinding must be a binding with a non-zero DescriptorSetLayoutCreateInfo::bindingCount
• All consecutive bindings updated via a single WriteDescriptorSet structure, except those with a descriptorCount of zero, must have identical descriptorType
• All consecutive bindings updated via a single WriteDescriptorSet structure, except those with a descriptorCount of zero, must have identical stageFlags
• All consecutive bindings updated via a single WriteDescriptorSet structure, except those with a descriptorCount of zero, must all either use immutable samplers or must all not use immutable samplers
• All consecutive bindings updated via a single WriteDescriptorSet structure, except those with a descriptorCount of zero, must have identical DescriptorBindingFlagBits
• descriptorType must match the type of dstBinding within dstSet
• dstSet must be a valid DescriptorSet handle
• The sum of dstArrayElement and descriptorCount must be less than or equal to the number of array elements in the descriptor set binding specified by dstBinding, and all applicable consecutive bindings
• If descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, dstArrayElement must be an integer multiple of 4
• If descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, descriptorCount must be an integer multiple of 4
• If descriptorType is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, each element of pTexelBufferView must be either a valid BufferView handle or NULL_HANDLE
• If descriptorType is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER and the nullDescriptor feature is not enabled, each element of pTexelBufferView must not be NULL_HANDLE
• If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER, DESCRIPTOR_TYPE_STORAGE_BUFFER, DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, pBufferInfo must be a valid pointer to an array of descriptorCount valid DescriptorBufferInfo structures
• If descriptorType is DESCRIPTOR_TYPE_SAMPLER or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and dstSet was not allocated with a layout that included immutable samplers for dstBinding with descriptorType, the sampler member of each element of pImageInfo must be a valid Sampler object
• If descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, DESCRIPTOR_TYPE_SAMPLED_IMAGE, or DESCRIPTOR_TYPE_STORAGE_IMAGE, the imageView member of each element of pImageInfo must be either a valid ImageView handle or NULL_HANDLE
• If descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, DESCRIPTOR_TYPE_SAMPLED_IMAGE, or DESCRIPTOR_TYPE_STORAGE_IMAGE, and the nullDescriptor feature is not enabled, the imageView member of each element of pImageInfo must not be NULL_HANDLE
• If descriptorType is DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, then the imageView member of each element of pImageInfo must not be NULL_HANDLE
• If descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, the pNext chain must include a WriteDescriptorSetInlineUniformBlock structure whose dataSize member equals descriptorCount
• If descriptorType is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, the pNext chain must include a WriteDescriptorSetAccelerationStructureKHR structure whose accelerationStructureCount member equals descriptorCount
• If descriptorType is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, the pNext chain must include a WriteDescriptorSetAccelerationStructureNV structure whose accelerationStructureCount member equals descriptorCount
• If descriptorType is DESCRIPTOR_TYPE_TENSOR_ARM, the pNext chain must include a WriteDescriptorSetTensorARM structure whose tensorViewCount member equals descriptorCount
• If descriptorType is DESCRIPTOR_TYPE_SAMPLED_IMAGE, then the imageView member of each pImageInfo element must have been created without a SamplerYcbcrConversionInfo structure in its pNext chain
• If descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and if any element of pImageInfo has an imageView member that was created with a SamplerYcbcrConversionInfo structure in its pNext chain, then dstSet must have been allocated with a layout that included immutable samplers for dstBinding, and the corresponding immutable sampler must have been created with an identically defined SamplerYcbcrConversionInfo object
• If descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and dstSet was allocated with a layout that included immutable samplers for dstBinding, then the imageView member of each element of pImageInfo which corresponds to an immutable sampler that enables sampler Y′CBCR conversion must have been created with a SamplerYcbcrConversionInfo structure in its pNext chain with an identically defined SamplerYcbcrConversionInfo to the corresponding immutable sampler
• If descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, dstSet was allocated with a layout that included immutable samplers for dstBinding, and those samplers enable sampler Y′CBCR conversion, then imageView must not be NULL_HANDLE
• If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the offset member of each element of pBufferInfo must be a multiple of PhysicalDeviceLimits::minUniformBufferOffsetAlignment
• If descriptorType is DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the offset member of each element of pBufferInfo must be a multiple of PhysicalDeviceLimits::minStorageBufferOffsetAlignment
• If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER, DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, DESCRIPTOR_TYPE_STORAGE_BUFFER, or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, and the buffer member of any element of pBufferInfo is the handle of a non-sparse buffer, then that buffer must be bound completely and contiguously to a single DeviceMemory object
• If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the buffer member of each element of pBufferInfo must have been created with the BUFFER_USAGE_UNIFORM_BUFFER_BIT usage flag set
• If descriptorType is DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the buffer member of each element of pBufferInfo must have been created with the BUFFER_USAGE_STORAGE_BUFFER_BIT usage flag set
• If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the range member of each element of pBufferInfo, or the effective range if range is WHOLE_SIZE, must be less than or equal to PhysicalDeviceLimits::maxUniformBufferRange
• If descriptorType is DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, and the shader64BitIndexing feature is not enabled, the range member of each element of pBufferInfo, or the effective range if range is WHOLE_SIZE, must be less than or equal to PhysicalDeviceLimits::maxStorageBufferRange
• If descriptorType is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, the pTexelBufferView buffer view usage must include BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT
• If descriptorType is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, the pTexelBufferView buffer view usage must include BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT
• If descriptorType is DESCRIPTOR_TYPE_STORAGE_IMAGE or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView member of each element of pImageInfo must have been created with the identity swizzle
• If descriptorType is DESCRIPTOR_TYPE_SAMPLED_IMAGE or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the imageView member of each element of pImageInfo must have been created with the IMAGE_USAGE_SAMPLED_BIT usage flag set
• If descriptorType is DESCRIPTOR_TYPE_SAMPLED_IMAGE the imageLayout member of each element of pImageInfo must be a member of the list given in Sampled Image
• If descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER the imageLayout member of each element of pImageInfo must be a member of the list given in Combined Image Sampler
• If descriptorType is DESCRIPTOR_TYPE_INPUT_ATTACHMENT the imageLayout member of each element of pImageInfo must be a member of the list given in Input Attachment
• If descriptorType is DESCRIPTOR_TYPE_STORAGE_IMAGE the imageLayout member of each element of pImageInfo must be a member of the list given in Storage Image
• If descriptorType is DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView member of each element of pImageInfo must have been created with the IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage flag set
• If descriptorType is DESCRIPTOR_TYPE_STORAGE_IMAGE, the imageView member of each element of pImageInfo must have been created with the IMAGE_USAGE_STORAGE_BIT usage flag set
• If descriptorType is DESCRIPTOR_TYPE_SAMPLER, then dstSet must not have been allocated with a layout that included immutable samplers for dstBinding
• If the DescriptorSetLayoutBinding for dstSet at dstBinding is DESCRIPTOR_TYPE_MUTABLE_EXT, the new active descriptor type descriptorType must exist in the corresponding pMutableDescriptorTypeLists list for dstBinding
• If descriptorType is DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView member of each element of pImageInfo must have either been created without a ImageViewMinLodCreateInfoEXT included in the pNext chain or with a ImageViewMinLodCreateInfoEXT::minLod of 0.0
• If descriptorType is DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, the imageView member of each element of pImageInfo must have been created with a view created with an image created with the IMAGE_USAGE_SAMPLE_WEIGHT_BIT_QCOM usage flag set
• If descriptorType is DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, the imageView member of each element of pImageInfo must have been created with a view created with an image created with the IMAGE_USAGE_SAMPLE_BLOCK_MATCH_BIT_QCOM usage flag set

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of WriteDescriptorSetAccelerationStructureKHR, WriteDescriptorSetAccelerationStructureNV, WriteDescriptorSetInlineUniformBlock, VkWriteDescriptorSetPartitionedAccelerationStructureNV, or WriteDescriptorSetTensorARM
• The sType value of each structure in the pNext chain must be unique
• descriptorType must be a valid DescriptorType value
• descriptorCount must be greater than 0
• Both of dstSet, and the elements of pTexelBufferView that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

VK_VERSION_1_0, BufferView, DescriptorBufferInfo, DescriptorImageInfo, DescriptorSet, DescriptorType, Promoted_From_VK_KHR_maintenance6AdditionalFunctionality.PushDescriptorSetInfo', StructureType, cmdPushDescriptorSet, cmdPushDescriptorSet, updateDescriptorSets

VkCopyDescriptorSet - Structure specifying a copy descriptor set operation

Description

If the DescriptorSetLayoutBinding for dstBinding is DESCRIPTOR_TYPE_MUTABLE_EXT and srcBinding is not DESCRIPTOR_TYPE_MUTABLE_EXT, the new active descriptor type becomes the descriptor type of srcBinding. If both DescriptorSetLayoutBinding for srcBinding and dstBinding are DESCRIPTOR_TYPE_MUTABLE_EXT, the active descriptor type in each source descriptor is copied into the corresponding destination descriptor. The active descriptor type can be different for each source descriptor.

The intention is that copies to and from mutable descriptors is a simple memcpy. Copies between non-mutable and mutable descriptors are expected to require one memcpy per descriptor to handle the difference in size, but this use case with more than one descriptorCount is considered rare.

Valid Usage

• srcBinding must be a valid binding within srcSet

• The sum of srcArrayElement and descriptorCount must be less than or equal to the number of array elements in the descriptor set binding specified by srcBinding, and all applicable consecutive bindings
• dstBinding must be a valid binding within dstSet
• The sum of dstArrayElement and descriptorCount must be less than or equal to the number of array elements in the descriptor set binding specified by dstBinding, and all applicable consecutive bindings
• The type of dstBinding within dstSet must be equal to the type of srcBinding within srcSet
• If srcSet is equal to dstSet, then the source and destination ranges of descriptors must not overlap, where the ranges may include array elements from consecutive bindings
• If the descriptor type of the descriptor set binding specified by srcBinding is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, srcArrayElement must be an integer multiple of 4
• If the descriptor type of the descriptor set binding specified by dstBinding is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, dstArrayElement must be an integer multiple of 4
• If the descriptor type of the descriptor set binding specified by either srcBinding or dstBinding is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, descriptorCount must be an integer multiple of 4
• If srcSet’s layout was created with the DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT flag set, then dstSet’s layout must also have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT flag set
• If srcSet’s layout was created without either the DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT flag or the DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT flag set, then dstSet’s layout must have been created without the DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT flag set
• If the descriptor pool from which srcSet was allocated was created with the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT flag set, then the descriptor pool from which dstSet was allocated must also have been created with the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT flag set
• If the descriptor pool from which srcSet was allocated was created without either the DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_EXT flag or the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT flag set, then the descriptor pool from which dstSet was allocated must have been created without the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT flag set
• If the descriptor type of the descriptor set binding specified by dstBinding is DESCRIPTOR_TYPE_SAMPLER, then dstSet must not have been allocated with a layout that included immutable samplers for dstBinding
• If DescriptorSetLayoutBinding for dstSet at dstBinding is DESCRIPTOR_TYPE_MUTABLE_EXT, the new active descriptor type must exist in the corresponding pMutableDescriptorTypeLists list for dstBinding if the new active descriptor type is not DESCRIPTOR_TYPE_MUTABLE_EXT
• If DescriptorSetLayoutBinding for srcSet at srcBinding is DESCRIPTOR_TYPE_MUTABLE_EXT and the DescriptorSetLayoutBinding for dstSet at dstBinding is not DESCRIPTOR_TYPE_MUTABLE_EXT, the active descriptor type for the source descriptor must match the descriptor type of dstBinding
• If DescriptorSetLayoutBinding for dstSet at dstBinding is DESCRIPTOR_TYPE_MUTABLE_EXT, and the new active descriptor type is DESCRIPTOR_TYPE_MUTABLE_EXT, the pMutableDescriptorTypeLists for srcBinding and dstBinding must match exactly

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_DESCRIPTOR_SET

• pNext must be NULL
• srcSet must be a valid DescriptorSet handle
• dstSet must be a valid DescriptorSet handle
• Both of dstSet, and srcSet must have been created, allocated, or retrieved from the same Device

See Also

VK_VERSION_1_0, DescriptorSet, StructureType, updateDescriptorSets

VkDescriptorSetLayoutBinding - Structure specifying a descriptor set layout binding

Description

The above layout definition allows the descriptor bindings to be specified sparsely such that not all binding numbers between 0 and the maximum binding number need to be specified in the pBindings array. Bindings that are not specified have a descriptorCount and stageFlags of zero, and the value of descriptorType is undefined. However, all binding numbers between 0 and the maximum binding number in the DescriptorSetLayoutCreateInfo::pBindings array may consume memory in the descriptor set layout even if not all descriptor bindings are used, though it should not consume additional memory from the descriptor pool.

The maximum binding number specified should be as compact as possible to avoid wasted memory.

Valid Usage

• If descriptorType is DESCRIPTOR_TYPE_SAMPLER or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and descriptorCount is not 0 and pImmutableSamplers is not NULL, pImmutableSamplers must be a valid pointer to an array of descriptorCount valid Sampler handles

• If descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and descriptorCount is not 0 and pImmutableSamplers is not NULL, either each element of pImmutableSamplers must be a Sampler that enables sampler Y′CBCR conversion or none of them enable sampler Y′CBCR conversion
• If descriptorType is DESCRIPTOR_TYPE_SAMPLER, each element of pImmutableSamplers must not be a Sampler object that enables sampler Y′CBCR conversion
• If the inlineUniformBlock feature is not enabled, descriptorType must not be DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK
• If descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK then descriptorCount must be a multiple of 4
• If descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK and DescriptorSetLayoutCreateInfo::flags does not contain DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT then descriptorCount must be less than or equal to PhysicalDeviceInlineUniformBlockProperties::maxInlineUniformBlockSize
• If DescriptorSetLayoutCreateInfo::flags contains DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT, descriptorType must be DESCRIPTOR_TYPE_SAMPLER
• If DescriptorSetLayoutCreateInfo::flags contains DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT, descriptorCount must be less than or equal to 1
• If DescriptorSetLayoutCreateInfo::flags contains DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT, and descriptorCount is equal to 1, pImmutableSamplers must not be NULL
• If descriptorCount is not 0, stageFlags must be SHADER_STAGE_ALL or a valid combination of other ShaderStageFlagBits values
• If descriptorType is DESCRIPTOR_TYPE_INPUT_ATTACHMENT and descriptorCount is not 0, then stageFlags must be 0 or SHADER_STAGE_FRAGMENT_BIT
• The sampler objects indicated by pImmutableSamplers must not have a borderColor with one of the values BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT
• If descriptorType is DESCRIPTOR_TYPE_MUTABLE_EXT, then pImmutableSamplers must be NULL
• If DescriptorSetLayoutCreateInfo::flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PER_STAGE_BIT_NV, and descriptorCount is not 0, then stageFlags must be a valid combination of SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_TESSELLATION_CONTROL_BIT, SHADER_STAGE_TESSELLATION_EVALUATION_BIT, SHADER_STAGE_GEOMETRY_BIT, SHADER_STAGE_FRAGMENT_BIT and SHADER_STAGE_COMPUTE_BIT values

Valid Usage (Implicit)

• descriptorType must be a valid DescriptorType value

See Also

VK_VERSION_1_0, DescriptorSetLayoutCreateInfo, DescriptorType, Sampler, ShaderStageFlags

VkDescriptorSetLayoutCreateInfo - Structure specifying parameters of a newly created descriptor set layout

Valid Usage

• If the perStageDescriptorSet feature is not enabled, or flags does not contain DESCRIPTOR_SET_LAYOUT_CREATE_PER_STAGE_BIT_NV, then the DescriptorSetLayoutBinding::binding members of the elements of the pBindings array must each have different values

• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, and the VK_KHR_push_descriptor extension is not enabled, pushDescriptor must be enabled
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, then all elements of pBindings must not have a descriptorType of DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, then all elements of pBindings must not have a descriptorType of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, then the total number of elements of all bindings must be less than or equal to PhysicalDevicePushDescriptorProperties::maxPushDescriptors
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, flags must not contain DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, pBindings must not have a descriptorType of DESCRIPTOR_TYPE_MUTABLE_EXT
• If any binding has the DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT bit set, flags must include DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT
• If any binding has the DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT bit set, then all bindings must not have descriptorType of DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT, flags must not contain DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT
• If any element pBindings[i] has a descriptorType of DESCRIPTOR_TYPE_MUTABLE_EXT, then the pNext chain must include a MutableDescriptorTypeCreateInfoEXT structure, and mutableDescriptorTypeListCount must be greater than i
• If a binding has a descriptorType value of DESCRIPTOR_TYPE_MUTABLE_EXT, then pImmutableSamplers must be NULL
• If PhysicalDeviceMutableDescriptorTypeFeaturesEXT::mutableDescriptorType is not enabled, pBindings must not contain a descriptorType of DESCRIPTOR_TYPE_MUTABLE_EXT
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT, PhysicalDeviceMutableDescriptorTypeFeaturesEXT::mutableDescriptorType must be enabled
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, then all elements of pBindings must not have a descriptorType of DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT, flags must also contain DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, then flags must not contain DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, then flags must not contain DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PER_STAGE_BIT_NV, then perStageDescriptorSet must be enabled
• If flags contains DESCRIPTOR_SET_LAYOUT_CREATE_PER_STAGE_BIT_NV, then there must not be any two elements of the pBindings array with the same DescriptorSetLayoutBinding::binding value and their DescriptorSetLayoutBinding::stageFlags containing the same bit

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of DescriptorSetLayoutBindingFlagsCreateInfo or MutableDescriptorTypeCreateInfoEXT
• The sType value of each structure in the pNext chain must be unique
• flags must be a valid combination of DescriptorSetLayoutCreateFlagBits values
• If bindingCount is not 0, pBindings must be a valid pointer to an array of bindingCount valid DescriptorSetLayoutBinding structures

See Also

VK_VERSION_1_0, DescriptorSetLayoutBinding, DescriptorSetLayoutCreateFlags, StructureType, createDescriptorSetLayout, getDescriptorSetLayoutSupport, getDescriptorSetLayoutSupport

VkDescriptorPoolSize - Structure specifying descriptor pool size

Description

When creating a descriptor pool that will contain descriptors for combined image samplers of multi-planar formats, an application needs to account for non-trivial descriptor consumption when choosing the descriptorCount value, as indicated by SamplerYcbcrConversionImageFormatProperties::combinedImageSamplerDescriptorCount.

For simplicity the application can use the Promoted_From_VK_KHR_maintenance6AdditionalFunctionality.PhysicalDeviceMaintenance6Properties'::maxCombinedImageSamplerDescriptorCount property, which is sized to accommodate any and all formats that require a sampler Y′CBCR conversion supported by the implementation.

Valid Usage

• descriptorCount must be greater than 0

• If type is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK then descriptorCount must be a multiple of 4

Valid Usage (Implicit)

• type must be a valid DescriptorType value

See Also

VK_VERSION_1_0, DescriptorPoolCreateInfo, DescriptorType

VkDescriptorPoolCreateInfo - Structure specifying parameters of a newly created descriptor pool

Description

If multiple DescriptorPoolSize structures containing the same descriptor type appear in the pPoolSizes array then the pool will be created with enough storage for the total number of descriptors of each type.

Fragmentation of a descriptor pool is possible and may lead to descriptor set allocation failures. A failure due to fragmentation is defined as failing a descriptor set allocation despite the sum of all outstanding descriptor set allocations from the pool plus the requested allocation requiring no more than the total number of descriptors requested at pool creation. Implementations provide certain guarantees of when fragmentation must not cause allocation failure, as described below.

If a descriptor pool has not had any descriptor sets freed since it was created or most recently reset then fragmentation must not cause an allocation failure (note that this is always the case for a pool created without the DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT bit set). Additionally, if all sets allocated from the pool since it was created or most recently reset use the same number of descriptors (of each type) and the requested allocation also uses that same number of descriptors (of each type), then fragmentation must not cause an allocation failure.

If an allocation failure occurs due to fragmentation, an application can create an additional descriptor pool to perform further descriptor set allocations.

If flags has the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT bit set, descriptor pool creation may fail with the error ERROR_FRAGMENTATION if the total number of descriptors across all pools (including this one) created with this bit set exceeds maxUpdateAfterBindDescriptorsInAllPools, or if fragmentation of the underlying hardware resources occurs.

If a pPoolSizes[i]::type is DESCRIPTOR_TYPE_MUTABLE_EXT, a MutableDescriptorTypeCreateInfoEXT structure in the pNext chain can be used to specify which mutable descriptor types can be allocated from the pool. If included in the pNext chain, MutableDescriptorTypeCreateInfoEXT::pMutableDescriptorTypeLists[i] specifies which kind of DESCRIPTOR_TYPE_MUTABLE_EXT descriptors can be allocated from this pool entry. If MutableDescriptorTypeCreateInfoEXT does not exist in the pNext chain, or MutableDescriptorTypeCreateInfoEXT::pMutableDescriptorTypeLists[i] is out of range, the descriptor pool allocates enough memory to be able to allocate a DESCRIPTOR_TYPE_MUTABLE_EXT descriptor with any supported DescriptorType as a mutable descriptor. A mutable descriptor can be allocated from a pool entry if the type list in DescriptorSetLayoutCreateInfo is a subset of the type list declared in the descriptor pool, or if the pool entry is created without a descriptor type list. Multiple pPoolSizes entries with DESCRIPTOR_TYPE_MUTABLE_EXT can be declared. When multiple such pool entries are present in pPoolSizes, they specify sets of supported descriptor types which either fully overlap, partially overlap, or are disjoint. Two sets fully overlap if the sets of supported descriptor types are equal. If the sets are not disjoint they partially overlap. A pool entry without a MutableDescriptorTypeListEXT assigned to it is considered to partially overlap any other pool entry which has a MutableDescriptorTypeListEXT assigned to it. The application must ensure that partial overlap does not exist in pPoolSizes.

The requirement of no partial overlap is intended to resolve ambiguity for validation as there is no confusion which pPoolSizes entries will be allocated from. An implementation is not expected to depend on this requirement.

Valid Usage

• If the descriptorPoolOverallocation feature is not enabled, or flags does not have DESCRIPTOR_POOL_CREATE_ALLOW_OVERALLOCATION_SETS_BIT_NV set, maxSets must be greater than 0

• If flags has the DESCRIPTOR_POOL_CREATE_ALLOW_OVERALLOCATION_SETS_BIT_NV or DESCRIPTOR_POOL_CREATE_ALLOW_OVERALLOCATION_POOLS_BIT_NV bits set, then descriptorPoolOverallocation must be enabled
• If flags has the DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_EXT bit set, then the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT bit must not be set
• If PhysicalDeviceMutableDescriptorTypeFeaturesEXT::mutableDescriptorType is not enabled, pPoolSizes must not contain a descriptorType of DESCRIPTOR_TYPE_MUTABLE_EXT
• If flags has the DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_EXT bit set, PhysicalDeviceMutableDescriptorTypeFeaturesEXT::mutableDescriptorType must be enabled
• If pPoolSizes contains a descriptorType of DESCRIPTOR_TYPE_MUTABLE_EXT, any other DESCRIPTOR_TYPE_MUTABLE_EXT element in pPoolSizes must not have sets of supported descriptor types which partially overlap
• If pPoolSizes contains a descriptorType of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, the pNext chain must include a DescriptorPoolInlineUniformBlockCreateInfo structure whose maxInlineUniformBlockBindings member is not zero
• If a DataGraphProcessingEngineCreateInfoARM structure is included in the pNext chain, each member of pProcessingEngines must be identical to an QueueFamilyDataGraphPropertiesARM::engine retrieved from getPhysicalDeviceQueueFamilyDataGraphPropertiesARM with the physicalDevice that was used to create device

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of DataGraphProcessingEngineCreateInfoARM, DescriptorPoolInlineUniformBlockCreateInfo, or MutableDescriptorTypeCreateInfoEXT
• The sType value of each structure in the pNext chain must be unique
• flags must be a valid combination of DescriptorPoolCreateFlagBits values
• If poolSizeCount is not 0, pPoolSizes must be a valid pointer to an array of poolSizeCount valid DescriptorPoolSize structures

See Also

VK_VERSION_1_0, DescriptorPoolCreateFlags, DescriptorPoolSize, StructureType, createDescriptorPool

VkDescriptorSetAllocateInfo - Structure specifying the allocation parameters for descriptor sets

Valid Usage

• If the VK_KHR_maintenance1 extension is not enabled and PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, descriptorSetCount must not be greater than the number of sets that are currently available for allocation in descriptorPool

• If the VK_KHR_maintenance1 extension is not enabled and PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, descriptorPool must have enough free descriptor capacity remaining to allocate the descriptor sets of the specified layouts
• Each element of pSetLayouts must not have been created with DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT set
• If any element of pSetLayouts was created with the DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT bit set, descriptorPool must have been created with the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT flag set
• If pSetLayouts[i] was created with an element of pBindingFlags that includes DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT, and DescriptorSetVariableDescriptorCountAllocateInfo is included in the pNext chain, and DescriptorSetVariableDescriptorCountAllocateInfo::descriptorSetCount is not zero, then DescriptorSetVariableDescriptorCountAllocateInfo::pDescriptorCounts[i] must be less than or equal to DescriptorSetLayoutBinding::descriptorCount for the corresponding binding used to create pSetLayouts[i]
• If any element of pSetLayouts was created with the DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT bit set, descriptorPool must have been created with the DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_EXT flag set
• Each element of pSetLayouts must not have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT bit set

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO

• pNext must be NULL or a pointer to a valid instance of DescriptorSetVariableDescriptorCountAllocateInfo
• The sType value of each structure in the pNext chain must be unique
• descriptorPool must be a valid DescriptorPool handle
• pSetLayouts must be a valid pointer to an array of descriptorSetCount valid DescriptorSetLayout handles
• descriptorSetCount must be greater than 0
• Both of descriptorPool, and the elements of pSetLayouts must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to descriptorPool must be externally synchronized

See Also

VK_VERSION_1_0, DescriptorPool, DescriptorSetLayout, StructureType, allocateDescriptorSets

VkDescriptorSet - Opaque handle to a descriptor set object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, Promoted_From_VK_KHR_maintenance6AdditionalFunctionality.BindDescriptorSetsInfo', CopyDescriptorSet, WriteDescriptorSet, allocateDescriptorSets, cmdBindDescriptorSets, freeDescriptorSets, getDescriptorSetHostMappingVALVE, updateDescriptorSetWithTemplate, updateDescriptorSetWithTemplate

VkDescriptorSetLayout - Opaque handle to a descriptor set layout object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, DescriptorSetAllocateInfo, DescriptorSetBindingReferenceVALVE, DescriptorUpdateTemplateCreateInfo, IndirectExecutionSetShaderLayoutInfoEXT, PipelineLayoutCreateInfo, ShaderCreateInfoEXT, createDescriptorSetLayout, destroyDescriptorSetLayout, getDescriptorSetLayoutBindingOffsetEXT, getDescriptorSetLayoutSizeEXT

VkDescriptorPool - Opaque handle to a descriptor pool object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, DescriptorSetAllocateInfo, createDescriptorPool, destroyDescriptorPool, freeDescriptorSets, resetDescriptorPool

VkDescriptorPoolResetFlags - Reserved for future use

Description

DescriptorPoolResetFlags is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

VK_VERSION_1_0, Flags, resetDescriptorPool

VkDescriptorType - Specifies the type of a descriptor in a descriptor set

Description

• DESCRIPTOR_TYPE_SAMPLER specifies a sampler descriptor.

• DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER specifies a combined image sampler descriptor.
• DESCRIPTOR_TYPE_SAMPLED_IMAGE specifies a sampled image descriptor.
• DESCRIPTOR_TYPE_STORAGE_IMAGE specifies a storage image descriptor.
• DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER specifies a uniform texel buffer descriptor.
• DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER specifies a storage texel buffer descriptor.
• DESCRIPTOR_TYPE_UNIFORM_BUFFER specifies a uniform buffer descriptor.
• DESCRIPTOR_TYPE_STORAGE_BUFFER specifies a storage buffer descriptor.
• DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC specifies a dynamic uniform buffer descriptor.
• DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC specifies a dynamic storage buffer descriptor.
• DESCRIPTOR_TYPE_INPUT_ATTACHMENT specifies an input attachment descriptor.
• DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK specifies an inline uniform block.
• DESCRIPTOR_TYPE_MUTABLE_EXT specifies a descriptor of mutable type.
• DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM specifies a sampled weight image descriptor.
• DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM specifies a block matching image descriptor.
• DESCRIPTOR_TYPE_TENSOR_ARM specifies a storage tensor descriptor.

When a descriptor set is updated via elements of WriteDescriptorSet, members of pImageInfo, pBufferInfo and pTexelBufferView are only accessed by the implementation when they correspond to descriptor type being defined - otherwise they are ignored. The members accessed are as follows for each descriptor type:

• For DESCRIPTOR_TYPE_SAMPLER, only the sampler member of each element of WriteDescriptorSet::pImageInfo is accessed.
• For DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, only the imageView and imageLayout members of each element of WriteDescriptorSet::pImageInfo are accessed.
• For DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, all members of each element of WriteDescriptorSet::pImageInfo are accessed.
• For DESCRIPTOR_TYPE_UNIFORM_BUFFER, DESCRIPTOR_TYPE_STORAGE_BUFFER, DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, all members of each element of WriteDescriptorSet::pBufferInfo are accessed.
• For DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, each element of WriteDescriptorSet::pTexelBufferView is accessed.

When updating descriptors with a descriptorType of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, none of the pImageInfo, pBufferInfo, or pTexelBufferView members are accessed, instead the source data of the descriptor update operation is taken from the WriteDescriptorSetInlineUniformBlock structure in the pNext chain of WriteDescriptorSet. When updating descriptors with a descriptorType of DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, none of the pImageInfo, pBufferInfo, or pTexelBufferView members are accessed, instead the source data of the descriptor update operation is taken from the WriteDescriptorSetAccelerationStructureKHR structure in the pNext chain of WriteDescriptorSet. When updating descriptors with a descriptorType of DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, none of the pImageInfo, pBufferInfo, or pTexelBufferView members are accessed, instead the source data of the descriptor update operation is taken from the WriteDescriptorSetAccelerationStructureNV structure in the pNext chain of WriteDescriptorSet. When updating descriptors with a descriptorType of DESCRIPTOR_TYPE_TENSOR_ARM, none of the pImageInfo, pBufferInfo, or pTexelBufferView members are accessed, instead the source data of the descriptor update operation is taken from the instance of WriteDescriptorSetTensorARM in the pNext chain of WriteDescriptorSet.

See Also

VK_VERSION_1_0, DescriptorGetInfoEXT, DescriptorPoolSize, DescriptorSetLayoutBinding, DescriptorUpdateTemplateEntry, ImageViewHandleInfoNVX, MutableDescriptorTypeListEXT, ResourceDescriptorInfoEXT, WriteDescriptorSet, getPhysicalDeviceDescriptorSizeEXT