vkCmdBindDescriptorSets2KHR - Binds descriptor sets to a command buffer

Valid Usage

• Each bit in pBindDescriptorSetsInfo->stageFlags must be a stage supported by the commandBuffer’s parent CommandPool’s queue family

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pBindDescriptorSetsInfo must be a valid pointer to a valid BindDescriptorSetsInfoKHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_KHR_maintenance6, BindDescriptorSetsInfoKHR, CommandBuffer

vkCmdPushConstants2KHR - Update the values of push constants

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pPushConstantsInfo must be a valid pointer to a valid PushConstantsInfoKHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_KHR_maintenance6, CommandBuffer, PushConstantsInfoKHR

vkCmdPushDescriptorSet2KHR - Pushes descriptor updates into a command buffer

Valid Usage

• Each bit in pPushDescriptorSetInfo->stageFlags must be a stage supported by the commandBuffer’s parent CommandPool’s queue family

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pPushDescriptorSetInfo must be a valid pointer to a valid PushDescriptorSetInfoKHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_KHR_maintenance6, VK_KHR_push_descriptor, CommandBuffer, PushDescriptorSetInfoKHR

vkCmdPushDescriptorSetWithTemplate2KHR - Pushes descriptor updates into a command buffer using a descriptor update template

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pPushDescriptorSetWithTemplateInfo must be a valid pointer to a valid PushDescriptorSetWithTemplateInfoKHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_KHR_maintenance6, VK_KHR_push_descriptor, CommandBuffer, PushDescriptorSetWithTemplateInfoKHR

vkCmdSetDescriptorBufferOffsets2EXT - Setting descriptor buffer offsets in a command buffer

Valid Usage

• The descriptorBuffer feature must be enabled

• Each bit in pSetDescriptorBufferOffsetsInfo->stageFlags must be a stage supported by the commandBuffer’s parent CommandPool’s queue family

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pSetDescriptorBufferOffsetsInfo must be a valid pointer to a valid SetDescriptorBufferOffsetsInfoEXT structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_EXT_descriptor_buffer, VK_KHR_maintenance6, CommandBuffer, SetDescriptorBufferOffsetsInfoEXT

vkCmdBindDescriptorBufferEmbeddedSamplers2EXT - Setting embedded immutable samplers offsets in a command buffer

Valid Usage

• The descriptorBuffer feature must be enabled

• Each bit in pBindDescriptorBufferEmbeddedSamplersInfo->stageFlags must be a stage supported by the commandBuffer’s parent CommandPool’s queue family

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pBindDescriptorBufferEmbeddedSamplersInfo must be a valid pointer to a valid BindDescriptorBufferEmbeddedSamplersInfoEXT structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_EXT_descriptor_buffer, VK_KHR_maintenance6, BindDescriptorBufferEmbeddedSamplersInfoEXT, CommandBuffer

VkPhysicalDeviceMaintenance6FeaturesKHR - Structure describing whether the implementation supports maintenance6 functionality

Members

This structure describes the following feature:

Description

If the PhysicalDeviceMaintenance6FeaturesKHR structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceMaintenance6FeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance6, Bool32, StructureType

VkPhysicalDeviceMaintenance6PropertiesKHR - Structure describing various implementation-defined properties introduced with VK_KHR_maintenance6

Description

If the PhysicalDeviceMaintenance6PropertiesKHR structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance6, Bool32, StructureType

VkBindMemoryStatusKHR - Structure specifying where to return memory binding status

Description

If the pNext chain of BindBufferMemoryInfo or BindImageMemoryInfo includes a BindMemoryStatusKHR structure, then the BindMemoryStatusKHR::pResult will be populated with a value describing the result of the corresponding memory binding operation.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance6, Result, StructureType

VkBindDescriptorSetsInfoKHR - Structure specifying a descriptor set binding operation

Description

If stageFlags specifies a subset of all stages corresponding to one or more pipeline bind points, the binding operation still affects all stages corresponding to the given pipeline bind point(s) as if the equivalent original version of this command had been called with the same parameters. For example, specifying a stageFlags value of SHADER_STAGE_VERTEX_BIT | SHADER_STAGE_FRAGMENT_BIT | SHADER_STAGE_COMPUTE_BIT is equivalent to calling the original version of this command once with PIPELINE_BIND_POINT_GRAPHICS and once with PIPELINE_BIND_POINT_COMPUTE.

Valid Usage

• Each element of pDescriptorSets must have been allocated with a DescriptorSetLayout that matches (is the same as, or identically defined as) the DescriptorSetLayout at set n in layout, where n is the sum of firstSet and the index into pDescriptorSets

• dynamicOffsetCount must be equal to the total number of dynamic descriptors in pDescriptorSets
• The sum of firstSet and descriptorSetCount must be less than or equal to PipelineLayoutCreateInfo::setLayoutCount provided when layout was created
• Each element of pDynamicOffsets which corresponds to a descriptor binding with type DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC must be a multiple of PhysicalDeviceLimits::minUniformBufferOffsetAlignment
• Each element of pDynamicOffsets which corresponds to a descriptor binding with type DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC must be a multiple of PhysicalDeviceLimits::minStorageBufferOffsetAlignment
• For each dynamic uniform or storage buffer binding in pDescriptorSets, the sum of the effective offset and the range of the binding must be less than or equal to the size of the buffer
• For each dynamic uniform or storage buffer binding in pDescriptorSets, if the range was set with WHOLE_SIZE then pDynamicOffsets which corresponds to the descriptor binding must be 0
• Each element of pDescriptorSets must not have been allocated from a DescriptorPool with the DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_EXT flag set
• If the graphicsPipelineLibrary feature is not enabled, each element of pDescriptorSets must be a valid DescriptorSet
• Each element of pDescriptorSets must have been allocated with a DescriptorSetLayout which was not created with DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the dynamicPipelineLayout feature is not enabled, layout must be a valid PipelineLayout handle
• If layout is NULL_HANDLE, the pNext chain must include a valid PipelineLayoutCreateInfo structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of PipelineLayoutCreateInfo
• The sType value of each struct in the pNext chain must be unique
• stageFlags must be a valid combination of ShaderStageFlagBits values
• stageFlags must not be 0
• If layout is not NULL_HANDLE, layout must be a valid PipelineLayout handle
• pDescriptorSets must be a valid pointer to an array of descriptorSetCount valid DescriptorSet handles
• If dynamicOffsetCount is not 0, and pDynamicOffsets is not NULL, pDynamicOffsets must be a valid pointer to an array of dynamicOffsetCount or NULL_HANDLE uint32_t values
• descriptorSetCount must be greater than 0
• Both of layout, and the elements of pDescriptorSets that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_maintenance6, DescriptorSet, PipelineLayout, ShaderStageFlags, StructureType, cmdBindDescriptorSets2KHR

VkPushConstantsInfoKHR - Structure specifying a push constant update operation

Valid Usage

• For each byte in the range specified by offset and size and for each shader stage in stageFlags, there must be a push constant range in layout that includes that byte and that stage

• For each byte in the range specified by offset and size and for each push constant range that overlaps that byte, stageFlags must include all stages in that push constant range’s PushConstantRange::stageFlags
• offset must be a multiple of 4
• size must be a multiple of 4
• offset must be less than PhysicalDeviceLimits::maxPushConstantsSize
• size must be less than or equal to PhysicalDeviceLimits::maxPushConstantsSize minus offset
• If the dynamicPipelineLayout feature is not enabled, layout must be a valid PipelineLayout handle
• If layout is NULL_HANDLE, the pNext chain must include a valid PipelineLayoutCreateInfo structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of PipelineLayoutCreateInfo
• The sType value of each struct in the pNext chain must be unique
• If layout is not NULL_HANDLE, layout must be a valid PipelineLayout handle
• stageFlags must be a valid combination of ShaderStageFlagBits values
• stageFlags must not be 0
• pValues must be a valid pointer to an array of size bytes
• size must be greater than 0

See Also

VK_KHR_maintenance6, PipelineLayout, ShaderStageFlags, StructureType, cmdPushConstants2KHR

VkPushDescriptorSetInfoKHR - Structure specifying a descriptor set push operation

Description

If stageFlags specifies a subset of all stages corresponding to one or more pipeline bind points, the binding operation still affects all stages corresponding to the given pipeline bind point(s) as if the equivalent original version of this command had been called with the same parameters. For example, specifying a stageFlags value of SHADER_STAGE_VERTEX_BIT | SHADER_STAGE_FRAGMENT_BIT | SHADER_STAGE_COMPUTE_BIT is equivalent to calling the original version of this command once with PIPELINE_BIND_POINT_GRAPHICS and once with PIPELINE_BIND_POINT_COMPUTE.

Valid Usage

• set must be less than PipelineLayoutCreateInfo::setLayoutCount provided when layout was created

• set must be the unique set number in the pipeline layout that uses a descriptor set layout that was created with DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR
• 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, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, pDescriptorWrites[i].pImageInfo must be a valid pointer to an array of pDescriptorWrites[i].descriptorCount valid DescriptorImageInfo structures
• If the dynamicPipelineLayout feature is not enabled, layout must be a valid PipelineLayout handle
• If layout is NULL_HANDLE, the pNext chain must include a valid PipelineLayoutCreateInfo structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of PipelineLayoutCreateInfo
• The sType value of each struct in the pNext chain must be unique
• stageFlags must be a valid combination of ShaderStageFlagBits values
• stageFlags must not be 0
• If layout is not NULL_HANDLE, layout must be a valid PipelineLayout handle
• pDescriptorWrites must be a valid pointer to an array of descriptorWriteCount valid WriteDescriptorSet structures
• descriptorWriteCount must be greater than 0

See Also

VK_KHR_maintenance6, VK_KHR_push_descriptor, PipelineLayout, ShaderStageFlags, StructureType, WriteDescriptorSet, cmdPushDescriptorSet2KHR

VkPushDescriptorSetWithTemplateInfoKHR - Structure specifying a descriptor set push operation using a descriptor update template

Valid Usage

• The pipelineBindPoint specified during the creation of the descriptor update template must be supported by the commandBuffer’s parent CommandPool’s queue family

• pData must be a valid pointer to a memory containing one or more valid instances of DescriptorImageInfo, DescriptorBufferInfo, or BufferView in a layout defined by descriptorUpdateTemplate when it was created with createDescriptorUpdateTemplate
• layout must be compatible with the layout used to create descriptorUpdateTemplate
• descriptorUpdateTemplate must have been created with a templateType of DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR
• set must be the same value used to create descriptorUpdateTemplate
• set must be less than PipelineLayoutCreateInfo::setLayoutCount provided when layout was created
• set must be the unique set number in the pipeline layout that uses a descriptor set layout that was created with DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR
• If the dynamicPipelineLayout feature is not enabled, layout must be a valid PipelineLayout handle
• If layout is NULL_HANDLE, the pNext chain must include a valid PipelineLayoutCreateInfo structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of PipelineLayoutCreateInfo
• The sType value of each struct in the pNext chain must be unique
• descriptorUpdateTemplate must be a valid DescriptorUpdateTemplate handle
• If layout is not NULL_HANDLE, layout must be a valid PipelineLayout handle
• pData must be a pointer value
• Both of descriptorUpdateTemplate, and layout that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_maintenance6, VK_KHR_push_descriptor, DescriptorUpdateTemplate, PipelineLayout, StructureType, cmdPushDescriptorSetWithTemplate2KHR

VkSetDescriptorBufferOffsetsInfoEXT - Structure specifying descriptor buffer offsets to set in a command buffer

Description

If stageFlags specifies a subset of all stages corresponding to one or more pipeline bind points, the binding operation still affects all stages corresponding to the given pipeline bind point(s) as if the equivalent original version of this command had been called with the same parameters. For example, specifying a stageFlags value of SHADER_STAGE_VERTEX_BIT | SHADER_STAGE_FRAGMENT_BIT | SHADER_STAGE_COMPUTE_BIT is equivalent to calling the original version of this command once with PIPELINE_BIND_POINT_GRAPHICS and once with PIPELINE_BIND_POINT_COMPUTE.

Valid Usage

• The offsets in pOffsets must be aligned to PhysicalDeviceDescriptorBufferPropertiesEXT::descriptorBufferOffsetAlignment

• The offsets in pOffsets must be small enough such that any descriptor binding referenced by layout without the DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT flag computes a valid address inside the underlying Buffer
• The offsets in pOffsets must be small enough such that any location accessed by a shader as a sampler descriptor must be within PhysicalDeviceDescriptorBufferPropertiesEXT::maxSamplerDescriptorBufferRange of the sampler descriptor buffer binding
• The offsets in pOffsets must be small enough such that any location accessed by a shader as a resource descriptor must be within PhysicalDeviceDescriptorBufferPropertiesEXT::maxResourceDescriptorBufferRange of the resource descriptor buffer binding
• Each element of pBufferIndices must be less than PhysicalDeviceDescriptorBufferPropertiesEXT::maxDescriptorBufferBindings
• Each element of pBufferIndices must reference a valid descriptor buffer binding set by a previous call to cmdBindDescriptorBuffersEXT in commandBuffer
• The sum of firstSet and setCount must be less than or equal to PipelineLayoutCreateInfo::setLayoutCount provided when layout was created
• The DescriptorSetLayout for each set from firstSet to firstSet + setCount when layout was created must have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT bit set
• If the dynamicPipelineLayout feature is not enabled, layout must be a valid PipelineLayout handle
• If layout is NULL_HANDLE, the pNext chain must include a valid PipelineLayoutCreateInfo structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SET_DESCRIPTOR_BUFFER_OFFSETS_INFO_EXT

• pNext must be NULL or a pointer to a valid instance of PipelineLayoutCreateInfo
• The sType value of each struct in the pNext chain must be unique
• stageFlags must be a valid combination of ShaderStageFlagBits values
• stageFlags must not be 0
• If layout is not NULL_HANDLE, layout must be a valid PipelineLayout handle
• pBufferIndices must be a valid pointer to an array of setCount uint32_t values
• pOffsets must be a valid pointer to an array of setCount DeviceSize values
• setCount must be greater than 0

See Also

VK_EXT_descriptor_buffer, VK_KHR_maintenance6, DeviceSize, PipelineLayout, ShaderStageFlags, StructureType, cmdSetDescriptorBufferOffsets2EXT

VkBindDescriptorBufferEmbeddedSamplersInfoEXT - Structure specifying embedded immutable sampler offsets to set in a command buffer

Description

If stageFlags specifies a subset of all stages corresponding to one or more pipeline bind points, the binding operation still affects all stages corresponding to the given pipeline bind point(s) as if the equivalent original version of this command had been called with the same parameters. For example, specifying a stageFlags value of SHADER_STAGE_VERTEX_BIT | SHADER_STAGE_FRAGMENT_BIT | SHADER_STAGE_COMPUTE_BIT is equivalent to calling the original version of this command once with PIPELINE_BIND_POINT_GRAPHICS and once with PIPELINE_BIND_POINT_COMPUTE.

Valid Usage

• The DescriptorSetLayout at index set when layout was created must have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT bit set

• set must be less than or equal to PipelineLayoutCreateInfo::setLayoutCount provided when layout was created
• If the dynamicPipelineLayout feature is not enabled, layout must be a valid PipelineLayout handle
• If layout is NULL_HANDLE, the pNext chain must include a valid PipelineLayoutCreateInfo structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT

• pNext must be NULL or a pointer to a valid instance of PipelineLayoutCreateInfo
• The sType value of each struct in the pNext chain must be unique
• stageFlags must be a valid combination of ShaderStageFlagBits values
• stageFlags must not be 0
• If layout is not NULL_HANDLE, layout must be a valid PipelineLayout handle

See Also

VK_EXT_descriptor_buffer, VK_KHR_maintenance6, PipelineLayout, ShaderStageFlags, StructureType, cmdBindDescriptorBufferEmbeddedSamplers2EXT