Vulkan.Extensions.VK_EXT_descriptor_buffer

vkGetDescriptorSetLayoutSizeEXT - Get the size of a descriptor set layout in memory

Description

The size of a descriptor set layout will be at least as large as the sum total of the size of all descriptors in the layout, and may be larger. This size represents the amount of memory that will be required to store all of the descriptors for this layout in memory, when placed according to the layout’s offsets as obtained by getDescriptorSetLayoutBindingOffsetEXT.

If any binding in layout is DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT, the returned size includes space for the maximum descriptorCount descriptors as declared for that binding. To compute the required size of a descriptor set with a DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT:

• size = offset + descriptorSize × variableDescriptorCount

where offset is obtained by getDescriptorSetLayoutBindingOffsetEXT and descriptorSize is the size of the relevant descriptor as obtained from PhysicalDeviceDescriptorBufferPropertiesEXT, and variableDescriptorCount is the equivalent of DescriptorSetVariableDescriptorCountAllocateInfo::pDescriptorCounts. For DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, variableDescriptorCount is the size in bytes for the inline uniform block, and descriptorSize is 1.

If PhysicalDeviceDescriptorBufferPropertiesEXT::combinedImageSamplerDescriptorSingleArray is FALSE and the variable descriptor type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, variableDescriptorCount is always considered to be the upper bound.

Valid Usage

• The descriptorBuffer feature must be enabled

• layout must have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT flag set

• layout must have not been created with the DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT flag set

• layout must have not been created with the DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT flag set

Valid Usage (Implicit)

• device must be a valid Device handle

• layout must be a valid DescriptorSetLayout handle

• pLayoutSizeInBytes must be a valid pointer to a DeviceSize value

• layout must have been created, allocated, or retrieved from device

See Also

VK_EXT_descriptor_buffer, DescriptorSetLayout, Device, DeviceSize

vkGetDescriptorSetLayoutBindingOffsetEXT - Get the offset of a binding within a descriptor set layout

Description

Each binding in a descriptor set layout is assigned an offset in memory by the implementation. When a shader accesses a resource with that binding, it will access the bound descriptor buffer from that offset to look for its descriptor. This command provides an application with that offset, so that descriptors can be placed in the correct locations. The precise location accessed by a shader for a given descriptor is as follows:

• location = bufferAddress + setOffset + descriptorOffset + (arrayElement × descriptorSize)

where bufferAddress and setOffset are the base address and offset for the identified descriptor set as specified by cmdBindDescriptorBuffersEXT and cmdSetDescriptorBufferOffsetsEXT, descriptorOffset is the offset for the binding returned by this command, arrayElement is the index into the array specified in the shader, and descriptorSize is the size of the relevant descriptor as obtained from PhysicalDeviceDescriptorBufferPropertiesEXT. Applications are responsible for placing valid descriptors at the expected location in order for a shader to access it. The overall offset added to bufferAddress to calculate location must be less than PhysicalDeviceDescriptorBufferPropertiesEXT::maxSamplerDescriptorBufferRange for samplers and PhysicalDeviceDescriptorBufferPropertiesEXT::maxResourceDescriptorBufferRange for resources.

If any binding in layout is DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT, that binding must have the largest offset of any binding.

A descriptor binding with type DESCRIPTOR_TYPE_MUTABLE_EXT can be used. Any potential types in MutableDescriptorTypeCreateInfoEXT::pDescriptorTypes for binding share the same offset. If the size of the mutable descriptor is larger than the size of a concrete descriptor type being accessed, the padding area is ignored by the implementation.

Valid Usage

• The descriptorBuffer feature must be enabled

• layout must have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT flag set

• layout must have not been created with the DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT flag set

• layout must have not been created with the DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT flag set

Valid Usage (Implicit)

• device must be a valid Device handle

• layout must be a valid DescriptorSetLayout handle

• pOffset must be a valid pointer to a DeviceSize value

• layout must have been created, allocated, or retrieved from device

See Also

VK_EXT_descriptor_buffer, DescriptorSetLayout, Device, DeviceSize

vkGetDescriptorEXT - To get a descriptor to place in a buffer

Description

The size of the data for each descriptor type is determined by the value in PhysicalDeviceDescriptorBufferPropertiesEXT. This value also defines the stride in bytes for arrays of that descriptor type.

If the PhysicalDeviceDescriptorBufferPropertiesEXT::combinedImageSamplerDescriptorSingleArray property is FALSE the implementation requires an array of DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER descriptors to be written into a descriptor buffer as an array of image descriptors, immediately followed by an array of sampler descriptors. Applications must write the first PhysicalDeviceDescriptorBufferPropertiesEXT::sampledImageDescriptorSize bytes of the data returned through pDescriptor to the first array, and the remaining PhysicalDeviceDescriptorBufferPropertiesEXT::samplerDescriptorSize bytes of the data to the second array. For variable-sized descriptor bindings of DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER descriptors, the two arrays each have a size equal to the upper bound descriptorCount of that binding.

A descriptor obtained by this command references the underlying ImageView or Sampler, and these objects must not be destroyed before the last time a descriptor is dynamically accessed. For descriptor types which consume an address instead of an object, the underlying Buffer is referenced instead.

Valid Usage

• The descriptorBuffer feature must be enabled

• If pDescriptorInfo->type is not DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER or pDescriptorInfo->data.pCombinedImageSampler has an imageView member that was not created with a SamplerYcbcrConversionInfo structure in its pNext chain, dataSize must equal the size of a descriptor of type DescriptorGetInfoEXT::type determined by the value in PhysicalDeviceDescriptorBufferPropertiesEXT , or determined by PhysicalDeviceDescriptorBufferDensityMapPropertiesEXT::combinedImageSamplerDensityMapDescriptorSize if pDescriptorInfo specifies a DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER whose Sampler was created with SAMPLER_CREATE_SUBSAMPLED_BIT_EXT set

• If pDescriptorInfo->type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER and pDescriptorInfo->data.pCombinedImageSampler has an imageView member that was created with a SamplerYcbcrConversionInfo structure in its pNext chain, dataSize must equal the size of PhysicalDeviceDescriptorBufferPropertiesEXT::combinedImageSamplerDescriptorSize times SamplerYcbcrConversionImageFormatProperties::combinedImageSamplerDescriptorCount

• If pDescriptorInfo->type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER and it has a imageView that is NULL_HANDLE then dataSize must be equal to the size of PhysicalDeviceDescriptorBufferPropertiesEXT::combinedImageSamplerDescriptorSize

Valid Usage (Implicit)

• device must be a valid Device handle

• pDescriptorInfo must be a valid pointer to a valid DescriptorGetInfoEXT structure

• pDescriptor must be a valid pointer to an array of dataSize bytes

• dataSize must be greater than 0

See Also

VK_EXT_descriptor_buffer, DescriptorGetInfoEXT, Device

vkCmdBindDescriptorBuffersEXT - Binding descriptor buffers to a command buffer

Description

cmdBindDescriptorBuffersEXT causes any offsets previously set by cmdSetDescriptorBufferOffsetsEXT that use the bindings numbered [0.. bufferCount-1] to be no longer valid for subsequent bound pipeline commands. Any previously bound buffers at binding points greater than or equal to bufferCount are unbound.

Valid Usage

• If commandBuffer is a secondary command buffer, it must have begun with CommandBufferInheritanceDescriptorHeapInfoEXT::pSamplerHeapBindInfo equal to NULL

• If commandBuffer is a secondary command buffer, it must have begun with CommandBufferInheritanceDescriptorHeapInfoEXT::pResourceHeapBindInfo equal to NULL

• The descriptorBuffer feature must be enabled

• There must be no more than PhysicalDeviceDescriptorBufferPropertiesEXT::maxSamplerDescriptorBufferBindings elements in pBindingInfos with DescriptorBufferBindingInfoEXT::usage containing BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT

• There must be no more than PhysicalDeviceDescriptorBufferPropertiesEXT::maxResourceDescriptorBufferBindings elements in pBindingInfos with DescriptorBufferBindingInfoEXT::usage containing BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT

• There must be no more than 1 element in pBindingInfos with DescriptorBufferBindingInfoEXT::usage containing BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT

• bufferCount must be less than or equal to PhysicalDeviceDescriptorBufferPropertiesEXT::maxDescriptorBufferBindings

• For each element of pBindingInfos, the buffer from which address was queried must have been created with the BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT usage flag set if it contains sampler descriptor data

• For each element of pBindingInfos, the buffer from which address was queried must have been created with the BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT usage flag set if it contains resource descriptor data

• For each element of pBindingInfos, at least one buffer from which address was queried must contain usage

• For all elements of pBindingInfos, the buffer from which address was queried must have been created with the BUFFER_USAGE_2_DATA_GRAPH_FOREIGN_DESCRIPTOR_BIT_ARM usage flag set if the command pool from which commandBuffer was allocated from was created with any element of DataGraphProcessingEngineCreateInfoARM::pProcessingEngines with isForeign set to TRUE

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pBindingInfos must be a valid pointer to an array of bufferCount valid DescriptorBufferBindingInfoEXT structures

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, QUEUE_DATA_GRAPH_BIT_ARM, or QUEUE_GRAPHICS_BIT operations

• This command must only be called outside of a video coding scope

• bufferCount must be greater than 0

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

'

Conditional Rendering

vkCmdBindDescriptorBuffersEXT is not affected by conditional rendering

See Also

VK_EXT_descriptor_buffer, CommandBuffer, DescriptorBufferBindingInfoEXT

vkCmdSetDescriptorBufferOffsetsEXT - Setting descriptor buffer offsets in a command buffer

Description

cmdSetDescriptorBufferOffsetsEXT binds setCount pairs of descriptor buffers, specified by indices into the binding points bound using cmdBindDescriptorBuffersEXT, and buffer offsets to set numbers [firstSet..firstSet+setCount-1] for subsequent bound pipeline commands set by pipelineBindPoint. Set [firstSet + i] is bound to the descriptor buffer at binding pBufferIndices[i] at an offset of pOffsets[i]. Any bindings that were previously applied via these sets, or calls to cmdBindDescriptorSets, are no longer valid. Other sets will also be invalidated upon calling this command if layout differs from the pipeline layout used to bind those other sets, as described in Pipeline Layout Compatibility.

After binding descriptors, applications can modify descriptor memory either by performing writes on the host or with device commands. When descriptor memory is updated with device commands, visibility for the shader stage accessing a descriptor is ensured with the ACCESS_2_DESCRIPTOR_BUFFER_READ_BIT_EXT access flag. Implementations must not access resources referenced by these descriptors unless they are dynamically accessed by shaders. Descriptors bound with this call can be undefined if they are not dynamically accessed by shaders.

Implementations may read descriptor data for any statically accessed descriptor if the binding in layout is not declared with the DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT flag. If the binding in layout is declared with DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT, implementations must not read descriptor data that is not dynamically accessed.

Applications must ensure that any descriptor which the implementation may read must be in-bounds of the underlying descriptor buffer binding.

Applications can freely decide how large a variable descriptor buffer binding is, so it may not be safe to read such descriptor payloads statically. The intention of these rules is to allow implementations to speculatively prefetch descriptor payloads where feasible.

Dynamically accessing a resource through descriptor data from an unbound region of a sparse partially-resident buffer will result in invalid descriptor data being read, and therefore undefined behavior.

For descriptors written by the host, visibility is implied through the automatic visibility operation on queue submit, and there is no need to consider VK_ACCESS_2_DESCRIPTOR_BUFFER_READ_BIT. Explicit synchronization for descriptors is only required when descriptors are updated on the device.

The requirements above imply that all descriptor bindings have been defined with the equivalent of DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT, DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT and DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT, but enabling those features is not required to get this behavior.

Valid Usage

• If commandBuffer is a secondary command buffer, it must have begun with CommandBufferInheritanceDescriptorHeapInfoEXT::pSamplerHeapBindInfo equal to NULL

• If commandBuffer is a secondary command buffer, it must have begun with CommandBufferInheritanceDescriptorHeapInfoEXT::pResourceHeapBindInfo equal to NULL

• 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

• The DescriptorSetLayout for each set from firstSet to firstSet + setCount when layout was created must not have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR bit set

• The DescriptorSetLayout for each set from firstSet to firstSet + setCount when layout was created must not have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT bit set

• The descriptorBuffer feature must be enabled

• pipelineBindPoint must be supported by the commandBuffer’s parent CommandPool’s queue family

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pipelineBindPoint must be a valid PipelineBindPoint value

• 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

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, QUEUE_DATA_GRAPH_BIT_ARM, or QUEUE_GRAPHICS_BIT operations

• This command must only be called outside of a video coding scope

• setCount must be greater than 0

• Both of commandBuffer, and layout must have been created, allocated, or retrieved from the same Device

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

'

Conditional Rendering

vkCmdSetDescriptorBufferOffsetsEXT is not affected by conditional rendering

See Also

VK_EXT_descriptor_buffer, CommandBuffer, DeviceSize, PipelineBindPoint, PipelineLayout

vkCmdBindDescriptorBufferEmbeddedSamplersEXT - Setting embedded immutable samplers offsets in a command buffer

Description

cmdBindDescriptorBufferEmbeddedSamplersEXT binds the embedded immutable samplers in set of layout to set for the command buffer for subsequent bound pipeline commands set by pipelineBindPoint. Any previous binding to this set by cmdSetDescriptorBufferOffsetsEXT or this command is overwritten. Any sets that were last bound by a call to cmdBindDescriptorSets are invalidated upon calling this command. Other sets will also be invalidated upon calling this command if layout differs from the pipeline layout used to bind those other sets, as described in Pipeline Layout Compatibility.

Valid Usage

• If commandBuffer is a secondary command buffer, it must have begun with CommandBufferInheritanceDescriptorHeapInfoEXT::pSamplerHeapBindInfo equal to NULL

• If commandBuffer is a secondary command buffer, it must have begun with CommandBufferInheritanceDescriptorHeapInfoEXT::pResourceHeapBindInfo equal to NULL

• 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

• The descriptorBuffer feature must be enabled

• pipelineBindPoint must be supported by the commandBuffer’s parent CommandPool’s queue family

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pipelineBindPoint must be a valid PipelineBindPoint value

• layout must be a valid PipelineLayout handle

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, or QUEUE_GRAPHICS_BIT operations

• This command must only be called outside of a video coding scope

• Both of commandBuffer, and layout must have been created, allocated, or retrieved from the same Device

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

'

Conditional Rendering

vkCmdBindDescriptorBufferEmbeddedSamplersEXT is not affected by conditional rendering

See Also

VK_EXT_descriptor_buffer, CommandBuffer, PipelineBindPoint, PipelineLayout

vkGetBufferOpaqueCaptureDescriptorDataEXT - Get buffer opaque capture descriptor data

Valid Usage

• The descriptorBufferCaptureReplay feature must be enabled

• pData must point to a buffer that is at least PhysicalDeviceDescriptorBufferPropertiesEXT::bufferCaptureReplayDescriptorDataSize bytes in size

• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid BufferCaptureDescriptorDataInfoEXT structure

• pData must be a pointer value

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_descriptor_buffer, BufferCaptureDescriptorDataInfoEXT, Device

vkGetImageOpaqueCaptureDescriptorDataEXT - Get image opaque capture descriptor data

Valid Usage

• The descriptorBufferCaptureReplay feature must be enabled

• pData must point to a buffer that is at least PhysicalDeviceDescriptorBufferPropertiesEXT::imageCaptureReplayDescriptorDataSize bytes in size

• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid ImageCaptureDescriptorDataInfoEXT structure

• pData must be a pointer value

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_descriptor_buffer, Device, ImageCaptureDescriptorDataInfoEXT

vkGetImageViewOpaqueCaptureDescriptorDataEXT - Get image view opaque capture descriptor data

Valid Usage

• The descriptorBufferCaptureReplay feature must be enabled

• pData must point to a buffer that is at least PhysicalDeviceDescriptorBufferPropertiesEXT::imageViewCaptureReplayDescriptorDataSize bytes in size

• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid ImageViewCaptureDescriptorDataInfoEXT structure

• pData must be a pointer value

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_descriptor_buffer, Device, ImageViewCaptureDescriptorDataInfoEXT

vkGetSamplerOpaqueCaptureDescriptorDataEXT - Get sampler opaque capture descriptor data

Valid Usage

• The descriptorBufferCaptureReplay feature must be enabled

• pData must point to a buffer that is at least PhysicalDeviceDescriptorBufferPropertiesEXT::samplerCaptureReplayDescriptorDataSize bytes in size

• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid SamplerCaptureDescriptorDataInfoEXT structure

• pData must be a pointer value

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_descriptor_buffer, Device, SamplerCaptureDescriptorDataInfoEXT

vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT - Get acceleration structure opaque capture descriptor data

Valid Usage

• The descriptorBufferCaptureReplay feature must be enabled

• pData must point to a buffer that is at least PhysicalDeviceDescriptorBufferPropertiesEXT::accelerationStructureCaptureReplayDescriptorDataSize bytes in size

• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid AccelerationStructureCaptureDescriptorDataInfoEXT structure

• pData must be a pointer value

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_descriptor_buffer, VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureCaptureDescriptorDataInfoEXT, Device

VkPhysicalDeviceDescriptorBufferFeaturesEXT - Structure describing the descriptor buffer features that can be supported by an implementation

Members

This structure describes the following feature:

Description

If the PhysicalDeviceDescriptorBufferFeaturesEXT 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. If the application wishes to use a Device with any features described by PhysicalDeviceDescriptorBufferFeaturesEXT, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_EXT_descriptor_buffer, Bool32, StructureType

VkPhysicalDeviceDescriptorBufferPropertiesEXT - Structure describing descriptor buffer properties supported by an implementation

Description

A descriptor binding with type DESCRIPTOR_TYPE_MUTABLE_EXT has a descriptor size which is implied by the descriptor types included in the MutableDescriptorTypeCreateInfoEXT::pDescriptorTypes list. The descriptor size is equal to the maximum size of any descriptor type included in the pDescriptorTypes list.

As there is no way to request robust and non-robust descriptors separately, or specify robust/non-robust descriptors in the set layout, if the robustBufferAccess feature is enabled then robust descriptors are always used.

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

Structure Chaining

Extends the structure

• PhysicalDeviceProperties2

See Also

VK_EXT_descriptor_buffer, Bool32, DeviceSize, StructureType

VkPhysicalDeviceDescriptorBufferDensityMapPropertiesEXT - Structure describing descriptor buffer density map properties supported by an implementation

Description

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

Structure Chaining

Extends the structure

• PhysicalDeviceProperties2

See Also

VK_EXT_descriptor_buffer, VK_EXT_fragment_density_map, StructureType

VkDescriptorAddressInfoEXT - Structure specifying descriptor buffer address info

Valid Usage

• If address is not zero, and the descriptor is of type DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, then format must not be FORMAT_UNDEFINED

• If the nullDescriptor feature is not enabled, address must not be zero

• If address is zero, range must be WHOLE_SIZE

• If address is not zero, range must not be WHOLE_SIZE

• If address is not zero, then range must be less than or equal to the size of the buffer containing address minus the offset of address from the base address of the buffer

• range must not be zero

• If Vulkan 1.3 is not supported and the ycbcr2plane444Formats feature is not enabled, format must not be FORMAT_G8_B8R8_2PLANE_444_UNORM, FORMAT_G10X6_B10X6R10X6_2PLANE_444_UNORM_3PACK16, FORMAT_G12X4_B12X4R12X4_2PLANE_444_UNORM_3PACK16, or FORMAT_G16_B16R16_2PLANE_444_UNORM

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_ADDRESS_INFO_EXT

• pNext must be NULL

• If address is not 0, address must be a valid DeviceAddress value

• format must be a valid Format value

If the nullDescriptor feature is enabled, address can be zero. Loads from a null descriptor return zero values and stores and atomics to a null descriptor are discarded.

See Also

VK_EXT_descriptor_buffer, DescriptorDataEXT, DeviceAddress, DeviceSize, Format, StructureType

VkDescriptorBufferBindingInfoEXT - Structure specifying descriptor buffer binding information

Description

If the pNext chain includes a BufferUsageFlags2CreateInfo structure, BufferUsageFlags2CreateInfo::usage from that structure is used instead of usage from this structure.

Valid Usage

• If the pNext chain does not include a BufferUsageFlags2CreateInfo structure, usage must be a valid combination of BufferUsageFlagBits values

• If the pNext chain does not include a BufferUsageFlags2CreateInfo structure, usage must not be 0

• The usage must include at least one of BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT, BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT, or BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT

• If ::bufferlessPushDescriptors is FALSE, and usage contains BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, then the pNext chain must include a DescriptorBufferBindingPushDescriptorBufferHandleEXT structure

• address must be aligned to PhysicalDeviceDescriptorBufferPropertiesEXT::descriptorBufferOffsetAlignment

• If usage includes BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT, address must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT usage flag set

• If usage includes BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT, address must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT usage flag set

• If usage includes BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, address must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT usage flag set

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_BUFFER_BINDING_INFO_EXT

• 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 BufferUsageFlags2CreateInfo or DescriptorBufferBindingPushDescriptorBufferHandleEXT

• The sType value of each structure in the pNext chain must be unique

• address must be a valid DeviceAddress value

See Also

VK_EXT_descriptor_buffer, BufferUsageFlags, DeviceAddress, StructureType, cmdBindDescriptorBuffersEXT

VkDescriptorBufferBindingPushDescriptorBufferHandleEXT - Structure specifying push descriptor buffer binding information

Valid Usage

• ::bufferlessPushDescriptors must be FALSE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_BUFFER_BINDING_PUSH_DESCRIPTOR_BUFFER_HANDLE_EXT

• buffer must be a valid Buffer handle

Structure Chaining

Extends the structure

• DescriptorBufferBindingInfoEXT

See Also

VK_EXT_descriptor_buffer, Buffer, StructureType

VkDescriptorGetInfoEXT - Structure specifying parameters of descriptor to get

Valid Usage

• type must not be DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC or DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK

• If type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the pCombinedImageSampler->sampler member of data must be a Sampler created on device

• If type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the pCombinedImageSampler->imageView member of data must be a ImageView created on device, or NULL_HANDLE

• If type is DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the pInputAttachmentImage->imageView member of data must be a ImageView created on device

• If type is DESCRIPTOR_TYPE_SAMPLED_IMAGE, and if pSampledImage is not NULL, the pSampledImage->imageView member of data must be a ImageView created on device, or NULL_HANDLE

• If type is DESCRIPTOR_TYPE_STORAGE_IMAGE, and if pStorageImage is not NULL, the pStorageImage->imageView member of data must be a ImageView created on device, or NULL_HANDLE

• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, pUniformBuffer is not NULL , the number of texel buffer elements given by (⌊pUniformBuffer->range / (texel block size)⌋ × (texels per block)) where texel block size and texels per block are as defined in the Compatible Formats table for pUniformBuffer->format, must be less than or equal to PhysicalDeviceLimits::maxTexelBufferElements

• If type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, pStorageBuffer is not NULL , the number of texel buffer elements given by (⌊pStorageBuffer->range / (texel block size)⌋ × (texels per block)) where texel block size and texels per block are as defined in the Compatible Formats table for pStorageBuffer->format, must be less than or equal to PhysicalDeviceLimits::maxTexelBufferElements

• If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR and accelerationStructure is not 0, accelerationStructure must contain the address of a AccelerationStructureKHR created on device

• If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV and accelerationStructure is not 0, accelerationStructure must contain the handle of a AccelerationStructureNV created on device, returned by getAccelerationStructureHandleNV

• If type is DESCRIPTOR_TYPE_TENSOR_ARM, a DescriptorGetTensorInfoARM structure must be included in the pNext chain and data is ignored

• If type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER and pCombinedImageSampler->imageView is not NULL_HANDLE, the pCombinedImageSampler->imageView member of data must have been created with IMAGE_USAGE_SAMPLED_BIT set

• If type is DESCRIPTOR_TYPE_SAMPLED_IMAGE, pSampledImage is not NULL, and pSampledImage->imageView is not NULL_HANDLE, the pSampledImage->imageView member of data must have been created with IMAGE_USAGE_SAMPLED_BIT set

• If type is DESCRIPTOR_TYPE_STORAGE_IMAGE, pStorageImage is not NULL, and pStorageImage->imageView is not NULL_HANDLE, the pStorageImage->imageView member of data must have been created with IMAGE_USAGE_STORAGE_BIT set

• If type is DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the pInputAttachmentImage->imageView member of data must have been created with IMAGE_USAGE_INPUT_ATTACHMENT_BIT set

• If type is DESCRIPTOR_TYPE_UNIFORM_BUFFER, pUniformBuffer is not NULL and pUniformBuffer->address is not zero, pUniformBuffer->address must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_UNIFORM_BUFFER_BIT usage flag set

• If type is DESCRIPTOR_TYPE_STORAGE_BUFFER, pStorageBuffer is not NULL and pStorageBuffer->address is not zero, pStorageBuffer->address must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_STORAGE_BUFFER_BIT usage flag set

• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, pUniformTexelBuffer is not NULL and pUniformTexelBuffer->address is not zero, pUniformTexelBuffer->address must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT usage flag set

• If type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, pStorageTexelBuffer is not NULL and pStorageTexelBuffer->address is not zero, pStorageTexelBuffer->address must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT usage flag set

• If type is DESCRIPTOR_TYPE_UNIFORM_BUFFER and pUniformBuffer is not NULL, pUniformBuffer->address must be aligned to PhysicalDeviceLimits::minUniformBufferOffsetAlignment

• If type is DESCRIPTOR_TYPE_STORAGE_BUFFER and pStorageBuffer is not NULL, pStorageBuffer->address must be aligned to PhysicalDeviceLimits::minStorageBufferOffsetAlignment

• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, and pUniformTexelBuffer is not NULL, pUniformTexelBuffer->address must be a multiple of the effective alignment requirement as determined by minTexelBufferOffsetAlignment

• If type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, and pStorageTexelBuffer is not NULL, pStorageTexelBuffer->address must be a multiple of the effective alignment requirement as determined by minTexelBufferOffsetAlignment

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_GET_INFO_EXT

• pNext must be NULL or a pointer to a valid instance of DescriptorGetTensorInfoARM

• The sType value of each structure in the pNext chain must be unique

• type must be a valid DescriptorType value

• If type is DESCRIPTOR_TYPE_SAMPLER, the pSampler member of data must be a valid pointer to a valid Sampler handle

• If type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the pCombinedImageSampler member of data must be a valid pointer to a valid DescriptorImageInfo structure

• If type is DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the pInputAttachmentImage member of data must be a valid pointer to a valid DescriptorImageInfo structure

• If type is DESCRIPTOR_TYPE_SAMPLED_IMAGE, and if pSampledImage is not NULL, the pSampledImage member of data must be a valid pointer to a valid DescriptorImageInfo structure

• If type is DESCRIPTOR_TYPE_STORAGE_IMAGE, and if pStorageImage is not NULL, the pStorageImage member of data must be a valid pointer to a valid DescriptorImageInfo structure

• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, and if pUniformTexelBuffer is not NULL, the pUniformTexelBuffer member of data must be a valid pointer to a valid DescriptorAddressInfoEXT structure

• If type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, and if pStorageTexelBuffer is not NULL, the pStorageTexelBuffer member of data must be a valid pointer to a valid DescriptorAddressInfoEXT structure

• If type is DESCRIPTOR_TYPE_UNIFORM_BUFFER, and if pUniformBuffer is not NULL, the pUniformBuffer member of data must be a valid pointer to a valid DescriptorAddressInfoEXT structure

• If type is DESCRIPTOR_TYPE_STORAGE_BUFFER, and if pStorageBuffer is not NULL, the pStorageBuffer member of data must be a valid pointer to a valid DescriptorAddressInfoEXT structure

• If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR or DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, the accelerationStructure member of data must be a valid DeviceAddress value

See Also

VK_EXT_descriptor_buffer, DescriptorDataEXT, DescriptorType, StructureType, getDescriptorEXT

VkBufferCaptureDescriptorDataInfoEXT - Structure specifying a buffer for descriptor capture

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_buffer, Buffer, StructureType, getBufferOpaqueCaptureDescriptorDataEXT

VkImageCaptureDescriptorDataInfoEXT - Structure specifying an image for descriptor capture

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_buffer, Image, StructureType, getImageOpaqueCaptureDescriptorDataEXT

VkImageViewCaptureDescriptorDataInfoEXT - Structure specifying an image view for descriptor capture

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_buffer, ImageView, StructureType, getImageViewOpaqueCaptureDescriptorDataEXT

VkSamplerCaptureDescriptorDataInfoEXT - Structure specifying a sampler for descriptor capture

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_buffer, Sampler, StructureType, getSamplerOpaqueCaptureDescriptorDataEXT

VkAccelerationStructureCaptureDescriptorDataInfoEXT - Structure specifying an acceleration structure for descriptor capture

Valid Usage

• If accelerationStructure is not NULL_HANDLE then accelerationStructure must have been created with ACCELERATION_STRUCTURE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT set in AccelerationStructureCreateInfoKHR::createFlags

• If accelerationStructureNV is not NULL_HANDLE then accelerationStructureNV must have been created with ACCELERATION_STRUCTURE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT set in AccelerationStructureCreateInfoNV::info.flags

• If accelerationStructure is not NULL_HANDLE then accelerationStructureNV must be NULL_HANDLE

• If accelerationStructureNV is not NULL_HANDLE then accelerationStructure must be NULL_HANDLE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CAPTURE_DESCRIPTOR_DATA_INFO_EXT

• pNext must be NULL

• If accelerationStructure is not NULL_HANDLE, accelerationStructure must be a valid AccelerationStructureKHR handle

• If accelerationStructureNV is not NULL_HANDLE, accelerationStructureNV must be a valid AccelerationStructureNV handle

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

See Also

VK_EXT_descriptor_buffer, VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureKHR, AccelerationStructureNV, StructureType, getAccelerationStructureOpaqueCaptureDescriptorDataEXT

VkOpaqueCaptureDescriptorDataCreateInfoEXT - Structure specifying opaque capture descriptor data

Description

During replay, opaque descriptor capture data can be specified by adding a OpaqueCaptureDescriptorDataCreateInfoEXT structure to the relevant pNext chain of a BufferCreateInfo, ImageCreateInfo, ImageViewCreateInfo, SamplerCreateInfo, TensorCreateInfoARM, TensorViewCreateInfoARM, AccelerationStructureCreateInfoNV or AccelerationStructureCreateInfoKHR structure.

When providing opaque capture data for an image, if the pNext chain of ImageCreateInfo or TensorCreateInfoARM contains an instance of both this structure and OpaqueCaptureDataCreateInfoEXT, they should both specify data from the same original resource. If they have capture data from different original resources, resource creation is much more likely to fail.

Structure Chaining

Extends the structures

• AccelerationStructureCreateInfo2KHR

• AccelerationStructureCreateInfoKHR

• AccelerationStructureCreateInfoNV

• BufferCreateInfo

• ImageCreateInfo

• ImageViewCreateInfo

• SamplerCreateInfo

• TensorCreateInfoARM

• TensorViewCreateInfoARM

See Also

VK_EXT_descriptor_buffer, StructureType

VkAccelerationStructureKHR - Opaque handle to an acceleration structure object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_KHR_acceleration_structure, AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureCaptureDescriptorDataInfoEXT, AccelerationStructureDeviceAddressInfoKHR, AccelerationStructureTrianglesOpacityMicromapKHR, CopyAccelerationStructureInfoKHR, CopyAccelerationStructureToMemoryInfoKHR, CopyMemoryToAccelerationStructureInfoKHR, WriteDescriptorSetAccelerationStructureKHR, cmdWriteAccelerationStructuresPropertiesKHR, createAccelerationStructure2KHR, createAccelerationStructureKHR, destroyAccelerationStructureKHR, writeAccelerationStructuresPropertiesKHR

VkAccelerationStructureNV - Opaque handle to an acceleration structure object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_NV_ray_tracing, AccelerationStructureCaptureDescriptorDataInfoEXT, AccelerationStructureMemoryRequirementsInfoNV, BindAccelerationStructureMemoryInfoNV, WriteDescriptorSetAccelerationStructureNV, cmdBuildAccelerationStructureNV, cmdCopyAccelerationStructureNV, cmdWriteAccelerationStructuresPropertiesNV, createAccelerationStructureNV, destroyAccelerationStructureNV, getAccelerationStructureHandleNV

VkAccelerationStructureCreateFlagBitsKHR - Bitmask specifying additional creation parameters for acceleration structure

Description

• ACCELERATION_STRUCTURE_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR specifies that the acceleration structure’s address can be saved and reused on a subsequent run.

• ACCELERATION_STRUCTURE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT specifies that the acceleration structure can be used with descriptor buffers when capturing and replaying (e.g. for trace capture and replay), see OpaqueCaptureDescriptorDataCreateInfoEXT for more detail.

• ACCELERATION_STRUCTURE_CREATE_MOTION_BIT_NV specifies that the acceleration structure will be used with motion information, see AccelerationStructureMotionInfoNV for more detail.

See Also

VK_KHR_acceleration_structure, AccelerationStructureCreateFlagsKHR