Vulkan.Extensions.VK_EXT_descriptor_heap

vkWriteSamplerDescriptorsEXT - Write sampler descriptors to memory

Description

Each descriptor will be written to pDescriptors[i].address where i is the index of its create info in pSamplers.

Descriptors written using a fully identical SamplerCreateInfo structure on the same Device will always return the same bit pattern. If the descriptorHeapCaptureReplay feature is enabled, descriptors written using a fully identical SamplerCreateInfo structure on a Device created from the same PhysicalDevice with identical parameters will always return the same bit pattern.

YCBCR samplers must be embedded in a shader by using ShaderDescriptorSetAndBindingMappingInfoEXT, they cannot be specified here.

Valid Usage

• The descriptorHeap feature must be enabled

• The size member of each element of pDescriptors must be greater than or equal to the value returned by getPhysicalDeviceDescriptorSizeEXT with a descriptorType equal to DESCRIPTOR_TYPE_SAMPLER

• Elements of pSamplers must not include SamplerYcbcrConversionInfo structures in their pNext chains

• If the borderColor of any element of pSamplers is BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT, SamplerCustomBorderColorIndexCreateInfoEXT must be included in the pNext chain of that element

• If the borderColor of any element of pSamplers is BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT, SamplerCustomBorderColorIndexCreateInfoEXT::index must be a value less than maxCustomBorderColorSamplers

• If there is a DebugUtilsObjectNameInfoEXT structure in the pNext chain of any element of pSamplers, its objectType must be OBJECT_TYPE_UNKNOWN

Valid Usage (Implicit)

• device must be a valid Device handle

• pSamplers must be a valid pointer to an array of samplerCount valid SamplerCreateInfo structures

• pDescriptors must be a valid pointer to an array of samplerCount valid HostAddressRangeEXT structures

• samplerCount must be greater than 0

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_heap, Device, HostAddressRangeEXT, SamplerCreateInfo

vkWriteResourceDescriptorsEXT - Write resource descriptors to memory

Description

Each descriptor will be written to pDescriptors[i].address where i is the index of its create info in pResources.

If any image descriptor written by this command includes a SamplerYcbcrConversion, multiple descriptors will be written adjacent to each other for that descriptor, equal to SamplerYcbcrConversionImageFormatProperties::combinedImageSamplerDescriptorCount for the image.

If any image descriptor written by this command is for an image created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT, multiple descriptors will be written adjacent to each other for that descriptor, equal to SubsampledImageFormatPropertiesEXT::subsampledImageDescriptorCount for the image.

Descriptors using the same type and written using a fully identical TexelBufferDescriptorInfoEXT or DeviceAddressRangeKHR structure on the same Device will always return the same bit pattern. If the descriptorHeapCaptureReplay feature is enabled, this applies to any Device created with identical parameters from the same PhysicalDevice.

Recreating the same buffer descriptor during replay of a prior capture requires that the device address is the same, which requires additional data to be captured and provided during replay when creating a buffer and allocating memory for it.

Image descriptors using the same type and written using a fully identical ImageDescriptorInfoEXT other than ImageDescriptorInfoEXT::pView->image, where image was successfully created with IMAGE_CREATE_DESCRIPTOR_HEAP_CAPTURE_REPLAY_BIT_EXT and a OpaqueCaptureDataCreateInfoEXT with data captured via getImageOpaqueCaptureDataEXT from an image used previously, will write a descriptor with the same bit pattern if possible; if the same bit pattern cannot be generated, ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS will be returned instead.

Tensor descriptors using the same type and written using a fully identical TensorViewCreateInfoARM other than TensorViewCreateInfoARM::tensor, where tensor was successfully created with OpaqueCaptureDataCreateInfoEXT with TENSOR_CREATE_DESCRIPTOR_HEAP_CAPTURE_REPLAY_BIT_ARM and a OpaqueCaptureDataCreateInfoEXT with data captured via getTensorOpaqueCaptureDataARM from a tensor used previously, will write a descriptor with the same bit pattern if possible; if the same bit pattern cannot be generated, ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS will be returned instead.

Image creation is sufficiently complex that it may not be possible to recreate all possible descriptors from an image during replay, even if the image itself was successfully recreated. The conditions for this happening will be largely the same as those which could cause allocating a buffer with the same device address during replay to fail. Replay tools are advised to recreate captured descriptors for an image immediately after recreating the image itself wherever possible. The same is true for tensors.

Valid Usage

• The descriptorHeap feature must be enabled

• The size member of each element of pDescriptors must be greater than or equal to the value returned by getPhysicalDeviceDescriptorSizeEXT with a descriptorType equal to type

• If any element of pResources specifies a ImageViewCreateInfo structure with a SamplerYcbcrConversionInfo structure in its pNext chain, the corresponding element of pDescriptors must have a size member that is greater than or equal to the product of the value returned by getPhysicalDeviceDescriptorSizeEXT with a descriptorType equal to type and SamplerYcbcrConversionImageFormatProperties::combinedImageSamplerDescriptorCount, as queried from PhysicalDeviceImageFormatInfo2 with image format info equivalent to the image view the descriptor is being created for

• If any element of pResources specifies a ImageViewCreateInfo structure with an image created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT, the corresponding element of pDescriptors must have a size member that is greater than or equal to the product of the value returned by getPhysicalDeviceDescriptorSizeEXT with a descriptorType equal to type and SubsampledImageFormatPropertiesEXT::subsampledImageDescriptorCount, as queried from PhysicalDeviceImageFormatInfo2 with image format info equivalent to the image view the descriptor is being created for

Valid Usage (Implicit)

• device must be a valid Device handle

• pResources must be a valid pointer to an array of resourceCount valid ResourceDescriptorInfoEXT structures

• pDescriptors must be a valid pointer to an array of resourceCount valid HostAddressRangeEXT structures

• resourceCount must be greater than 0

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_heap, Device, HostAddressRangeEXT, ResourceDescriptorInfoEXT

vkCmdBindSamplerHeapEXT - Binds a sampler heap to a command buffer

Description

Addresses in the range defined by pBindInfo->heapRange are bound as the sampler heap. The application can access samplers and data through this heap anywhere except for the reserved range specified by pBindInfo->reservedRangeOffset. Addresses in the range [pBindInfo->reservedRangeOffset, pBindInfo->reservedRangeOffset + pBindInfo->reservedRangeSize) are reserved for the implementation and must not be accessed by the application at any time from when this command is recorded until there are no command buffers with that range bound.

The reserved range is bound to the command buffer until it has been reset.

Implementations may require a larger sampler heap reservation to store embedded sampler descriptors when used in a mapping, as advertised by minSamplerHeapReservedRangeWithEmbedded.

Shaders executed by commands recorded after this command can use the specified sampler heap to access resources. pBindInfo->heapRange.address will be available to shaders to access samplers and data through the SamplerHeapEXT BuiltIn or via shader bindings.

When cmdBindSamplerHeapEXT is recorded, it immediately invalidates all non-heap descriptor state. Similarly, recording any non-heap descriptor state commands immediately invalidates state set by this command.

Valid Usage

• The sum of pBindInfo->reservedRangeOffset and pBindInfo->reservedRangeSize must be less than or equal to pBindInfo->heapRange.size

• pBindInfo->reservedRangeSize must be greater than or equal to minSamplerHeapReservedRange

• pBindInfo->heapRange.size must less than or equal to maxSamplerHeapSize

• pBindInfo->heapRange.address must be a multiple of samplerHeapAlignment

• pBindInfo->reservedRangeOffset must be a multiple of samplerDescriptorAlignment

• Memory bound to addresses in the range [pBindInfo->heapRange.address + pBindInfo->reservedRangeOffset, pBindInfo->heapRange.address + pBindInfo->reservedRangeOffset + pBindInfo->reservedRangeSize) must not be bound to any other command buffer as a reserved range for any heap unless the reserved range matches exactly and it is the same heap type

• heapRange must be a device address range allocated to the application from a buffer created with the BUFFER_USAGE_DESCRIPTOR_HEAP_BIT_EXT usage flag set

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

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pBindInfo must be a valid pointer to a valid BindHeapInfoEXT structure

• 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

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

vkCmdBindSamplerHeapEXT is not affected by conditional rendering

See Also

VK_EXT_descriptor_heap, BindHeapInfoEXT, CommandBuffer

vkCmdBindResourceHeapEXT - Binds a resource heap to a command buffer

Description

Addresses in the range defined by pBindInfo->heapRange are bound as the resource heap. The application can access resources and data through this heap anywhere except for the reserved range specified by pBindInfo->reservedRangeOffset. Addresses in the range [pBindInfo->reservedRangeOffset, pBindInfo->reservedRangeOffset + pBindInfo->reservedRangeSize) are reserved for the implementation and must not be accessed by the application at any time from when this command is recorded until there are no command buffers with that range bound.

The reserved range is bound to the command buffer until it has been reset.

Shaders executed by commands recorded after this command can use the specified resource heap to access resources. pBindInfo->heapRange.address will be available to shaders to access resources through the ResourceHeapEXT BuiltIn or via shader bindings.

When cmdBindResourceHeapEXT is recorded, it immediately invalidates all non-heap descriptor state. Similarly, recording any non-heap descriptor state commands immediately invalidates state set by this command.

Valid Usage

• The sum of pBindInfo->reservedRangeOffset and pBindInfo->reservedRangeSize must be less than or equal to pBindInfo->heapRange.size

• pBindInfo->reservedRangeSize must be greater than or equal to minResourceHeapReservedRange

• pBindInfo->heapRange.size must less than or equal to maxResourceHeapSize

• pBindInfo->heapRange.address must be a multiple of resourceHeapAlignment

• pBindInfo->reservedRangeOffset must be a multiple of bufferDescriptorAlignment

• pBindInfo->reservedRangeOffset must be a multiple of imageDescriptorAlignment

• Memory bound to addresses in the range [pBindInfo->heapRange.address + pBindInfo->reservedRangeOffset, pBindInfo->heapRange.address + pBindInfo->reservedRangeOffset + pBindInfo->reservedRangeSize) must not be bound to any other command buffer as a reserved range for any heap unless the reserved range matches exactly and it is the same heap type

• heapRange must be a device address range allocated to the application from a buffer created with the BUFFER_USAGE_DESCRIPTOR_HEAP_BIT_EXT usage flag set

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

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pBindInfo must be a valid pointer to a valid BindHeapInfoEXT structure

• 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

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

vkCmdBindResourceHeapEXT is not affected by conditional rendering

See Also

VK_EXT_descriptor_heap, BindHeapInfoEXT, CommandBuffer

vkCmdPushDataEXT - Update the values of push data

Description

When cmdPushDataEXT is recorded, it immediately invalidates all non-heap descriptor state. Similarly, recording any non-heap descriptor state commands immediately invalidates state set by this command.

All push data is available to all shaders using the existing PushConstant Storage Class.

Device addresses in push data are intended as the fast path for shader-constant data that does not fit into push data directly. In order to maximize performance of constant data inputs, addresses should be aligned to minUniformBufferOffsetAlignment, and decorated with Alignment and NonWritable in the shader when using physical pointers.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pPushDataInfo must be a valid pointer to a valid PushDataInfoEXT structure

• 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

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

vkCmdPushDataEXT is not affected by conditional rendering

See Also

VK_EXT_descriptor_heap, CommandBuffer, PushDataInfoEXT

vkRegisterCustomBorderColorEXT - Register a custom border color

Description

If requestIndex is TRUE, the value present in pIndex when passed to the command is a requested index, and rather than returning a new index, the implementation will attempt to register that index, leaving the value intact. If the implementation is unable to register a requested index, ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS will be returned. If an index has not been registered (either explicitly or implicitly by creating a sampler object), or if it has been subsequently unregistered, the implementation must register that index successfully.

If requestIndex is FALSE, the value stored in pIndex is ignored, and a new index will be returned if the implementation is able to register a new index. If the implementation is unable to register a new index, ERROR_TOO_MANY_OBJECTS will be returned.

If an index is successfully registered, it can be used when writing a sampler descriptor or creating a sampler object to use with the custom border color, via SamplerCustomBorderColorIndexCreateInfoEXT.

The type of border color is not specified by this command (BORDER_COLOR_FLOAT_CUSTOM_EXT vs. BORDER_COLOR_INT_CUSTOM_EXT); the data will be interpreted at the point the border color is sampled with an actual sampler. Implementations are expected to store the data as raw bytes if they do not need the format to be specified.

Valid Usage

• If requestIndex is TRUE, the value stored in pIndex must be less than maxCustomBorderColorSamplers

Valid Usage (Implicit)

• device must be a valid Device handle

• pBorderColor must be a valid pointer to a valid SamplerCustomBorderColorCreateInfoEXT structure

• pIndex must be a valid pointer to a uint32_t value

Return Codes

Success

• SUCCESS

Failure

• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_TOO_MANY_OBJECTS

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_custom_border_color, VK_EXT_descriptor_heap, Bool32, Device, SamplerCustomBorderColorCreateInfoEXT

vkUnregisterCustomBorderColorEXT - Unregister a custom border color

Valid Usage (Implicit)

See Also

VK_EXT_custom_border_color, VK_EXT_descriptor_heap, Device

vkGetImageOpaqueCaptureDataEXT - Get image opaque capture descriptor data for descriptor heap replay

Valid Usage

• The descriptorHeapCaptureReplay feature must be enabled

• The size member of each element of pDatas must be equal to imageCaptureReplayOpaqueDataSize

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

• Each element of pImages must have been created with IMAGE_CREATE_DESCRIPTOR_HEAP_CAPTURE_REPLAY_BIT_EXT set in ImageCreateInfo::flags

Valid Usage (Implicit)

• device must be a valid Device handle

• pImages must be a valid pointer to an array of imageCount valid Image handles

• pDatas must be a valid pointer to an array of imageCount HostAddressRangeEXT structures

• imageCount must be greater than 0

• Each element of pImages must have been created, allocated, or retrieved from device

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_heap, Device, HostAddressRangeEXT, Image

vkGetPhysicalDeviceDescriptorSizeEXT - Report specific descriptor sizes for each descriptor type

Description

The return value of this function will be a DeviceSize indicating the size in bytes (N) of a heap descriptor with a type equal to descriptorType. When a descriptor of this type is written by writeResourceDescriptorsEXT or writeSamplerDescriptorsEXT, only the first N bytes are written; the rest will not be accessed and can be safely discarded when copying descriptors around. Additionally, those first N bytes are the only bytes that will be accessed when the descriptor is accessed in the shader. N will never be larger than the applicable limits in PhysicalDeviceDescriptorHeapTensorPropertiesARM or PhysicalDeviceDescriptorHeapPropertiesEXT.

Values returned by this function have other requirements, so for example may not be power-of-two values.

This command is not intended for general use, and is for tools that already take advantage of tighter packing with other similar features (e.g. VK_EXT_descriptor_buffer) to optimize accesses in some cases. Applications can safely ignore this function and are advised to do so, to avoid depending on non-portable packing.

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_heap, DescriptorType, PhysicalDevice

vkGetTensorOpaqueCaptureDataARM - Get tensor opaque capture descriptor data for descriptor heap replay

Valid Usage

• The descriptorHeapCaptureReplay feature must be enabled

• The size member of each element of pDatas must be equal to tensorCaptureReplayOpaqueDataSize

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

• Each element of pTensors must have been created with TENSOR_CREATE_DESCRIPTOR_HEAP_CAPTURE_REPLAY_BIT_ARM set in TensorCreateInfoARM::flags

Valid Usage (Implicit)

• device must be a valid Device handle

• pTensors must be a valid pointer to an array of tensorCount valid TensorARM handles

• pDatas must be a valid pointer to an array of tensorCount HostAddressRangeEXT structures

• tensorCount must be greater than 0

• Each element of pTensors must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_ARM_tensors, VK_EXT_descriptor_heap, Device, HostAddressRangeEXT, TensorARM

VkHostAddressRangeEXT - Structure specifying a host address range

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_heap, getImageOpaqueCaptureDataEXT, getTensorOpaqueCaptureDataARM, writeResourceDescriptorsEXT, writeSamplerDescriptorsEXT

VkHostAddressRangeConstEXT - Structure specifying a constant host address range

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_heap, OpaqueCaptureDataCreateInfoEXT, PushDataInfoEXT

VkTexelBufferDescriptorInfoEXT - Structure describing an image descriptor created from a buffer

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_heap, DeviceAddressRangeKHR, Format, ResourceDescriptorDataEXT, StructureType

VkImageDescriptorInfoEXT - Structure describing an image descriptor created from an image

Valid Usage

• pView->viewType must not be IMAGE_VIEW_TYPE_2D_ARRAY if pView->image was created with an imageType of IMAGE_TYPE_3D

• If pView->viewType is IMAGE_VIEW_TYPE_2D and pView->image was created with an imageType of IMAGE_TYPE_3D, pView->image must have been created with IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT set

• layout must be IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_SHARED_PRESENT_KHR, IMAGE_LAYOUT_RENDERING_LOCAL_READ_KHR, IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT, or IMAGE_LAYOUT_GENERAL

• If layout 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_STENCIL_READ_ONLY_OPTIMAL, or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, then pView->aspectMask must not include IMAGE_ASPECT_COLOR_BIT

• If pView->image is a depth/stencil image, pView->subresourceRange.aspectMask must include either IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT but not both

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_DESCRIPTOR_INFO_EXT

• pNext must be NULL

• pView must be a valid pointer to a valid ImageViewCreateInfo structure

• layout must be a valid ImageLayout value

See Also

VK_EXT_descriptor_heap, ImageLayout, ImageViewCreateInfo, ResourceDescriptorDataEXT, StructureType

VkResourceDescriptorInfoEXT - Structure describing a resource descriptor

Description

If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, data->pTexelBuffer is used to construct the descriptor.

If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, VK_DESCRIPTOR_TYPE_PARTITIONED_ACCELERATION_STRUCTURE_NV, DESCRIPTOR_TYPE_UNIFORM_BUFFER, or DESCRIPTOR_TYPE_STORAGE_BUFFER, data->pAddressRange is used to construct the descriptor. For acceleration structures, the size of the range is not used by the descriptor, and can be set to 0. If a non-zero size is provided though, it must be a valid range.

Applications may wish to provide a valid range as a way to check their own assumptions about the range they are binding; but it has no bearing on anything except validation. Implementations cannot make any assumptions based on the size of the provided range.

If type is DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_STORAGE_IMAGE, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, data->pImage is used to construct the descriptor. If type is DESCRIPTOR_TYPE_TENSOR_ARM, data->pTensorARM is used to construct the descriptor.

If the nullDescriptor feature is enabled, the corresponding element of data may be NULL to generate a null descriptor.

Applications can give resource descriptors a debug name in a similar way to naming an object, via the DebugUtilsObjectNameInfoEXT structure. However, as there is no actual object, this structure must be passed via the pNext chain of this structure, with a objectType of OBJECT_TYPE_UNKNOWN and a objectHandle of NULL_HANDLE. The name is attached to the unique set of descriptor bits written by the implementation, and writing the same bits again with new debug info may rename the original descriptor.

Implementations are not prevented from returning the same bits for different descriptors. This can result in multiple different resources mapping to the same name. A common case for this might be something like a uniform buffer and storage buffer with the same device address range.

If a descriptor becomes invalid due to the underlying resource becoming invalid, implementations may remove the name association.

Valid Usage

• type must be one of DESCRIPTOR_TYPE_UNIFORM_BUFFER, DESCRIPTOR_TYPE_STORAGE_BUFFER, DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, VK_DESCRIPTOR_TYPE_PARTITIONED_ACCELERATION_STRUCTURE_NV, DESCRIPTOR_TYPE_TENSOR_ARM, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT

• If the nullDescriptor feature is not enabled, and type is DESCRIPTOR_TYPE_SAMPLED_IMAGE or DESCRIPTOR_TYPE_STORAGE_IMAGE, data->pImage must not be NULL

• If type is DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, data->pImage must not be NULL

• If the nullDescriptor feature is not enabled, and type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, data->pTexelBuffer must not be NULL

• If the nullDescriptor feature is not enabled, and type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, VK_DESCRIPTOR_TYPE_PARTITIONED_ACCELERATION_STRUCTURE_NV, DESCRIPTOR_TYPE_UNIFORM_BUFFER, or DESCRIPTOR_TYPE_STORAGE_BUFFER, data->pAddressRange must not be NULL

• If the nullDescriptor feature is not enabled, and type is DESCRIPTOR_TYPE_TENSOR_ARM, data->pTensorARM must not be NULL

• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, data->pTexelBuffer->addressRange.address must be a multiple of the effective alignment requirement of data->pTexelBuffer->format as determined by minTexelBufferOffsetAlignment

• If type is DESCRIPTOR_TYPE_UNIFORM_BUFFER, data->pAddressRange->address must be a multiple of minUniformBufferOffsetAlignment

• If type is DESCRIPTOR_TYPE_STORAGE_BUFFER, data->pAddressRange->address must be a multiple of minStorageBufferOffsetAlignment

• If type is one of

  • DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR

  • DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV

  • VK_DESCRIPTOR_TYPE_PARTITIONED_ACCELERATION_STRUCTURE_NV

    data->pAddressRange->address must be a multiple of 256

• If there is a DebugUtilsObjectNameInfoEXT structure in the pNext chain, its objectType must be OBJECT_TYPE_UNKNOWN

• If type is DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, data.pImage->pView->image must not have been created with an imageType of IMAGE_TYPE_3D

• If type is DESCRIPTOR_TYPE_STORAGE_IMAGE, data.pImage->pView->viewType is IMAGE_VIEW_TYPE_2D, and the image2DViewOf3D feature is not enabled, data.pImage->pView->image must not have been created with an imageType of IMAGE_TYPE_3D

• If type is DESCRIPTOR_TYPE_SAMPLED_IMAGE, data.pImage->pView->viewType is IMAGE_VIEW_TYPE_2D, and the sampler2DViewOf3D feature is not enabled, data.pImage->pView->image must not have been created with an imageType of IMAGE_TYPE_3D

• If type is DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER, data.pAddressRange->size must not be 0

• If type is DESCRIPTOR_TYPE_SAMPLED_IMAGE and data.pImage is not NULL, data.pImage->pView->image must have been created with the IMAGE_USAGE_SAMPLED_BIT usage flag set

• If type is DESCRIPTOR_TYPE_STORAGE_IMAGE and data.pImage is not NULL, data.pImage->pView->image must have been created with the IMAGE_USAGE_STORAGE_BIT usage flag set

• If type is DESCRIPTOR_TYPE_INPUT_ATTACHMENT and data.pImage is not NULL, data.pImage->pView->image must have been created with the IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage flag set

• If type is DESCRIPTOR_TYPE_UNIFORM_BUFFER and data.pAddressRange is not NULL, data.pAddressRange must be a device address range 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 and data.pAddressRange is not NULL, data.pAddressRange must be a device address range 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 and data.pTexelBuffer is not NULL, data.pTexelBuffer->addressRange must be a device address range 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 and data.pTexelBuffer is not NULL, data.pTexelBuffer->addressRange must be a device address range allocated to the application from a buffer created with the BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT usage flag set

• If type is VK_DESCRIPTOR_TYPE_PARTITIONED_ACCELERATION_STRUCTURE_NV or DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, and data.pAddressRange is not NULL, data.pAddressRange->address must be an acceleration structure address retrieved from a AccelerationStructureKHR object via getAccelerationStructureDeviceAddressKHR

• If type is VK_DESCRIPTOR_TYPE_PARTITIONED_ACCELERATION_STRUCTURE_NV or DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, data.pAddressRange is not NULL, and data.pAddressRange->size is not 0, data.pAddressRange must be a device address range allocated to the application from the buffer used to create the acceleration structure that data.pAddressRange->address was retrieved from, and within the buffer range bound to that acceleration structure

• If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV and data.pAddressRange is not NULL, data.pAddressRange->address must be an acceleration structure handle retrieved from a AccelerationStructureNV object via getAccelerationStructureHandleNV

• If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV and data.pAddressRange is not NULL, data.pAddressRange->size must be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RESOURCE_DESCRIPTOR_INFO_EXT

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

• 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_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_INPUT_ATTACHMENT, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, or DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, and if pImage is not NULL, the pImage member of data must be a valid pointer to a valid ImageDescriptorInfoEXT structure

• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, and if pTexelBuffer is not NULL, the pTexelBuffer member of data must be a valid pointer to a valid TexelBufferDescriptorInfoEXT structure

• If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, DESCRIPTOR_TYPE_UNIFORM_BUFFER, or DESCRIPTOR_TYPE_STORAGE_BUFFER, and if pAddressRange is not NULL, the pAddressRange member of data must be a valid pointer to a valid DeviceAddressRangeEXT structure

• If type is DESCRIPTOR_TYPE_TENSOR_ARM, and if pTensorARM is not NULL, the pTensorARM member of data must be a valid pointer to a valid TensorViewCreateInfoARM structure

See Also

VK_EXT_descriptor_heap, DescriptorType, ResourceDescriptorDataEXT, StructureType, writeResourceDescriptorsEXT

VkBindHeapInfoEXT - Structure describing a device address range and implementation reservation for a descriptor heap

Valid Usage (Implicit)

See Also

VK_EXT_descriptor_heap, CommandBufferInheritanceDescriptorHeapInfoEXT, DeviceAddressRangeKHR, DeviceSize, StructureType, cmdBindResourceHeapEXT, cmdBindSamplerHeapEXT

VkPushDataInfoEXT - Structure specifying a push data update operation

Valid Usage

• The sum of offset and data.size must be less than or equal to maxPushDataSize

• offset must be a multiple of 4

• data.size must be a multiple of 4

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PUSH_DATA_INFO_EXT

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

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

• data must be a valid HostAddressRangeConstEXT structure

See Also

VK_EXT_descriptor_heap, HostAddressRangeConstEXT, StructureType, cmdPushDataEXT

VkDescriptorMappingSourceConstantOffsetEXT - Structure specifying mapping resources to a constant heap index

Description

Resources using this mapping will be backed by a descriptor in the heap, at an offset calculated as

• shaderIndex = (Binding - firstBinding) + arrayIndex

• offset = heapOffset + (shaderIndex * heapArrayStride)

where Binding is the binding value in the shader, arrayIndex is the index into the array if the shader binding is declared as an array.

If the mapped resource is a OpTypeSampledImage, offset is instead calculated for the sampler as

• offset = samplerHeapOffset + (shaderIndex * samplerHeapArrayStride)

If the mapped resource is a OpTypeSampler or OpTypeSampledImage, and pEmbeddedSampler is not NULL, the specified embedded sampler will be used rather than accessing the sampler heap.

Valid Usage

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, its borderColor must not be BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, and there is a DebugUtilsObjectNameInfoEXT structure in its pNext chain, its objectType must be OBJECT_TYPE_UNKNOWN

Valid Usage (Implicit)

• If pEmbeddedSampler is not NULL, pEmbeddedSampler must be a valid pointer to a valid SamplerCreateInfo structure

See Also

VK_EXT_descriptor_heap, DescriptorMappingSourceDataEXT, SamplerCreateInfo

VkDescriptorMappingSourcePushIndexEXT - Structure specifying mapping resources to a heap index in push data

Description

Resources using this mapping will be backed by a descriptor in the heap, at an offset calculated as

• pushIndex = ((uint32_t*)pPushData)[pushOffset/4]

• shaderIndex = (Binding - firstBinding) + arrayIndex

• offset = heapOffset + (pushIndex × heapIndexStride) + (shaderIndex × heapArrayStride)

where Binding is the binding value in the shader, arrayIndex is the index into the array if the shader binding is declared as an array, and pPushData is the total set of push data specified by cmdPushDataEXT.

If the mapped resource is a OpTypeSampledImage, offset is instead calculated for the sampler as

• samplerPushIndex = ((uint32_t*)pPushData)[samplerPushOffset/4]

• offset = samplerHeapOffset + (samplerPushIndex × samplerHeapIndexStride) + (shaderIndex × samplerHeapArrayStride)

If useCombinedImageSamplerIndex is TRUE, and the mapped resource is a OpTypeSampledImage, pushIndex and samplerPushIndex in the above equations are instead calculated as

• pushIndex = ((uint32_t*)pPushData)[pushOffset/4] & 0xFFFFF

• samplerPushIndex = (((uint32_t*)pPushData)[pushOffset/4] >> 20) & 0xFFF

If the mapped resource is a OpTypeSampler or OpTypeSampledImage, and pEmbeddedSampler is not NULL, the specified embedded sampler will be used rather than accessing the sampler heap.

Valid Usage

• pushOffset must be a multiple of 4

• pushOffset must be less than or equal to maxPushDataSize - 4

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, its borderColor must not be BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, and there is a DebugUtilsObjectNameInfoEXT structure in its pNext chain, its objectType must be OBJECT_TYPE_UNKNOWN

Valid Usage (Implicit)

• If pEmbeddedSampler is not NULL, pEmbeddedSampler must be a valid pointer to a valid SamplerCreateInfo structure

See Also

VK_EXT_descriptor_heap, Bool32, DescriptorMappingSourceDataEXT, SamplerCreateInfo

VkDescriptorMappingSourceIndirectIndexEXT - Structure specifying mapping resources to a heap index in indirect data

Description

Resources using this mapping will be backed by a descriptor in the heap, at an offset calculated as

• uint32_t *indirectAddress = ((VkDeviceAddress*)pPushData)[pushOffset/8]

• indirectIndex = indirectAddress[(addressOffset / 4)]

• shaderIndex = (Binding - firstBinding) + arrayIndex

• offset = heapOffset + (indirectIndex × heapIndexStride) + (shaderIndex × heapArrayStride)

where Binding is the binding value in the shader, arrayIndex is the index into the array if the shader binding is declared as an array, and pPushData is the total set of push data specified by cmdPushDataEXT. The value of the address in push data must be a multiple of 4. Index reads through indirectAddress are performed as non-volatile uniform buffer reads, and can be synchronized using ACCESS_2_UNIFORM_READ_BIT. The value in memory must remain static while any shader invocation using this mapping is in flight to avoid a data race.

If the mapped resource is a OpTypeSampledImage, offset is instead calculated for the sampler as

• uint32_t *samplerIndirectAddress = ((VkDeviceAddress*)pPushData)[samplerPushOffset/8]

• samplerIndirectIndex = samplerIndirectAddress[(samplerAddressOffset / 4)]

• offset = samplerHeapOffset + (samplerIndirectIndex × samplerHeapIndexStride) + (shaderIndex × samplerHeapArrayStride)

If useCombinedImageSamplerIndex is TRUE, and the mapped resource is a OpTypeSampledImage, indirectIndex and samplerIndirectIndex in the above equations are instead calculated as

• indirectIndex = indirectAddress[addressOffset/4] & 0xFFFFF

• samplerIndirectIndex = indirectAddress[addressOffset/4] >> 20) & 0xFFF

If the mapped resource is a OpTypeSampler or OpTypeSampledImage, and pEmbeddedSampler is not NULL, the specified embedded sampler will be used rather than accessing the sampler heap.

Valid Usage

• pushOffset must be a multiple of 8

• pushOffset must be less than or equal to maxPushDataSize - 8

• addressOffset must be a multiple of 4

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, its borderColor must not be BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, and there is a DebugUtilsObjectNameInfoEXT structure in its pNext chain, its objectType must be OBJECT_TYPE_UNKNOWN

Valid Usage (Implicit)

• If pEmbeddedSampler is not NULL, pEmbeddedSampler must be a valid pointer to a valid SamplerCreateInfo structure

See Also

VK_EXT_descriptor_heap, Bool32, DescriptorMappingSourceDataEXT, SamplerCreateInfo

VkDescriptorMappingSourceIndirectIndexArrayEXT - Structure specifying mapping resources to a heap index array in indirect data

Description

Resources using this mapping will be backed by a descriptor in the heap, at an offset calculated as

• uint32_t *indirectAddress = ((VkDeviceAddress*)pPushData)[pushOffset/8]

• shaderIndex = (Binding - firstBinding) + arrayIndex

• indirectIndex = indirectAddress[(addressOffset / 4) + shaderIndex]

• offset = heapOffset + (indirectIndex × heapIndexStride)

where Binding is the binding value in the shader, arrayIndex is the index into the array if the shader binding is declared as an array, and pPushData is the total set of push data specified by cmdPushDataEXT. The value of the address in push data must be a multiple of 4. Index reads through indirectAddress are performed as non-volatile uniform buffer reads, and can be synchronized using ACCESS_2_UNIFORM_READ_BIT. The value in memory must remain static while any shader invocation using this mapping is in flight to avoid a data race.

If the mapped resource is a OpTypeSampledImage, offset is instead calculated for the sampler as

• uint32_t *samplerIndirectAddress = ((VkDeviceAddress*)pPushData)[samplerPushOffset/8]

• samplerIndirectIndex = samplerAddr[(samplerAddressOffset / 4) + shaderIndex]

• offset = samplerHeapOffset + (samplerIndirectIndex × samplerHeapIndexStride)

If useCombinedImageSamplerIndex is TRUE, and the mapped resource is a OpTypeSampledImage, indirectIndex and samplerIndirectIndex in the above equations are instead calculated as

• indirectIndex = indirectAddress[addressOffset/4 + shaderIndex] & 0xFFFFF

• samplerIndirectIndex = indirectAddress[addressOffset/4 + shaderIndex] >> 20) & 0xFFF

If the mapped resource is a OpTypeSampler or OpTypeSampledImage, and pEmbeddedSampler is not NULL, the specified embedded sampler will be used rather than accessing the sampler heap.

Valid Usage

• pushOffset must be a multiple of 8

• pushOffset must be less than or equal to maxPushDataSize - 8

• addressOffset must be a multiple of 4

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, its borderColor must not be BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, and there is a DebugUtilsObjectNameInfoEXT structure in its pNext chain, its objectType must be OBJECT_TYPE_UNKNOWN

Valid Usage (Implicit)

• If pEmbeddedSampler is not NULL, pEmbeddedSampler must be a valid pointer to a valid SamplerCreateInfo structure

See Also

VK_EXT_descriptor_heap, Bool32, DescriptorMappingSourceDataEXT, SamplerCreateInfo

VkDescriptorMappingSourceHeapDataEXT - Structure specifying mapping a uniform buffer to heap data

Description

Uniform buffers using this mapping will be backed directly by data in the heap. Accessing data in the uniform buffer at an offset of shaderOffset in the shader will access heap data at an offset equal to

• offset = shaderOffset + heapOffset + ((uint32_t*)pPushData)[pushOffset/4]

where pPushData is the total set of push data specified by cmdPushDataEXT. Shader reads through the heap mapped in this way are performed according to the mapped resource.

Valid Usage

See Also

VK_EXT_descriptor_heap, DescriptorMappingSourceDataEXT

VkDescriptorMappingSourceShaderRecordIndexEXT - Structure specifying mapping resources to a heap index in shader record data

Description

Resources using this mapping will be backed by a descriptor in the heap, at an offset calculated as

• shaderRecordIndex = ((uint32_t*)pShaderRecordData)[shaderRecordOffset/4]

• shaderIndex = (Binding - firstBinding) + arrayIndex

• offset = heapOffset + (shaderRecordIndex × heapIndexStride) + (shaderIndex × heapArrayStride)

where Binding is the binding value in the shader, arrayIndex is the index into the array if the shader binding is declared as an array, and pShaderRecordData is the set of shader record data accessible to the shader.

If the mapped resource is a OpTypeSampledImage, offset is instead calculated for the sampler as

• samplerShaderRecordIndex = ((uint32_t*)pShaderRecordData)[samplerShaderRecordOffset/4]

• offset = samplerHeapOffset + (samplerShaderRecordIndex × samplerHeapIndexStride) + (shaderIndex × samplerHeapArrayStride)

If useCombinedImageSamplerIndex is TRUE, and the mapped resource is a OpTypeSampledImage, shaderRecordIndex and samplerShaderRecordIndex in the above equations are instead calculated as

• shaderRecordIndex = ((uint32_t*)pShaderRecordData)[shaderRecordOffset/4] & 0xFFFFF

• samplerShaderRecordIndex = (((uint32_t*)pShaderRecordData)[shaderRecordOffset/4] >> 20) & 0xFFF

If the mapped resource is a OpTypeSampler or OpTypeSampledImage, and pEmbeddedSampler is not NULL, the specified embedded sampler will be used rather than accessing the sampler heap.

Valid Usage

• shaderRecordOffset must be a multiple of 4

• shaderRecordOffset must be less than or equal to maxShaderGroupStride

• 4

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, its borderColor must not be BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT

• If pEmbeddedSampler is a valid pointer to a SamplerCreateInfo, and there is a DebugUtilsObjectNameInfoEXT structure in its pNext chain, its objectType must be OBJECT_TYPE_UNKNOWN

Valid Usage (Implicit)

• If pEmbeddedSampler is not NULL, pEmbeddedSampler must be a valid pointer to a valid SamplerCreateInfo structure

See Also

VK_EXT_descriptor_heap, Bool32, DescriptorMappingSourceDataEXT, SamplerCreateInfo

VkDescriptorMappingSourceIndirectAddressEXT - Structure specifying mapping a uniform buffer to an address specified indirectly

Description

Accessing data via the mapped resource in the shader will access data backing the address specified in the indirect address at the supplied offset:

• indirectAddress = ((VkDeviceAddress*)pPushData)[pushOffset/8]

• resourceAddress = ((VkDeviceAddress*)indirectAddress)[addressOffset/8]

where pPushData is the total set of push data specified by cmdPushDataEXT. Reads through indirectAddress are performed as non-volatile uniform buffer reads, and can be synchronized using ACCESS_2_UNIFORM_READ_BIT. Shader reads through resourceAddress are performed according to the mapped resource. If the shader resource is an acceleration structure, the address must be a valid acceleration structure address.

Valid Usage

See Also

VK_EXT_descriptor_heap, DescriptorMappingSourceDataEXT

VkDescriptorSetAndBindingMappingEXT - Structure specifying mappings from a set of shader resources to a descriptor heap

Description

Resources specified in a shader with a DescriptorSet decoration set to descriptorSet, a Binding decoration greater than or equal to firstBinding and less than the sum of firstBinding and bindingCount, and a resource type matching one of the bits in resourceMask will be mapped according to source and sourceData.

Applications are free to overspecify bindings that are not present; allowing reuse of the same mapping structures with multiple shaders, even when those shaders only partially reuse those mappings. This includes things like setting binding counts higher than the number used in the shader, specifying bindings that are not present in the shader, and setting resourceMask to all possible resources that may be encountered.

If source selects an element of sourceData defined by a structure, the description of that structure defines how resources are mapped. Source mappings using a single base type are defined here.

If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, the resource will be backed by heap data as specified by constantOffset.

If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, the resource will be backed by heap data as specified by pushIndex.

If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, the resource will be backed by heap data as specified by indirectIndex.

If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, the resource will be backed by heap data as specified by indirectIndexArray.

If source is DESCRIPTOR_MAPPING_SOURCE_RESOURCE_HEAP_DATA_EXT, the resource will be backed by heap data as specified by heapData.

If source is DESCRIPTOR_MAPPING_SOURCE_PUSH_DATA_EXT, the resource will be backed by push data at a range from pushDataOffset to the size of the resource, allowing a uniform buffer to be backed by push data access push data. Accessing data in the uniform buffer at an offset of shaderOffset in the shader will access push data at an offset equal to

• offset = shaderOffset + pushDataOffset.

If source is DESCRIPTOR_MAPPING_SOURCE_PUSH_ADDRESS_EXT, the resource will be backed by data pointed to by a device address in push data at an offset of pushAddressOffset. Accessing data via the mapped resource in the shader will access data backing the address specified in push data:

• address = ((VkDeviceAddress*)pPushData)[pushAddressOffset/8]

where pPushData is the total set of push data specified by cmdPushDataEXT. If the shader resource is an acceleration structure, the address must be a valid acceleration structure address.

If source is DESCRIPTOR_MAPPING_SOURCE_INDIRECT_ADDRESS_EXT, the resource will be backed by heap data as specified by indirectAddress.

Accesses to resources using mappings to anything that is not a descriptor in a heap are not subject to robustness guarantees; resources for such mappings must not be accessed out of bounds.

If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, the resource will be backed by heap data as specified by shaderRecordIndex.

If source is DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_DATA_EXT, the resource will be backed by shader record data at a range from shaderRecordDataOffset to the size of the resource, allowing a uniform buffer to be used as a way to access shader record data. Accessing data in the uniform buffer at an offset shaderOffset in the shader will access shader record data at an offset equal to

• offset = shaderOffset + shaderRecordDataOffset.

If source is DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_ADDRESS_EXT, the resource will be backed by data pointed to by a device address in the shader record at shaderRecordAddressOffset. Accessing data via the mapped resource in the shader will access data backing the address specified in shader record data:

• address = ((VkDeviceAddress*)pShaderRecordData)[shaderRecordAddressOffset/8]

where pShaderRecord is the memory associated with a given shader as its shader record. If the shader resource is an acceleration structure, the address must be a valid acceleration structure address.

Accesses to resources using DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_ADDRESS_EXT mappings are not subject to robustness guarantees; data must not be accessed outside of the allocated memory range.

Mappings must be declared for all variables with a DescriptorSet and Binding in the shader resource interface.

Valid Usage

• If source is DESCRIPTOR_MAPPING_SOURCE_PUSH_DATA_EXT, DESCRIPTOR_MAPPING_SOURCE_PUSH_ADDRESS_EXT, DESCRIPTOR_MAPPING_SOURCE_INDIRECT_ADDRESS_EXT, or DESCRIPTOR_MAPPING_SOURCE_RESOURCE_HEAP_DATA_EXT, bindingCount must be 1

• If source is DESCRIPTOR_MAPPING_SOURCE_PUSH_DATA_EXT, sourceData.pushDataOffset must be a multiple of 4

• If source is DESCRIPTOR_MAPPING_SOURCE_PUSH_ADDRESS_EXT, sourceData.pushAddressOffset must be a multiple of 8

• If source is DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_DATA_EXT or DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_ADDRESS_EXT, bindingCount must be 1

• If source is DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_DATA_EXT, sourceData.shaderRecordDataOffset must be a multiple of 4

• If source is DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_ADDRESS_EXT, sourceData.shaderRecordAddressOffset must be a multiple of 8

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, or DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, and descriptorSet, firstBinding, and bindingCount identify any OpTypeImage variables, any heapOffset, and heapArrayStride members of the corresponding member of sourceData must be 0 or a multiple of imageDescriptorAlignment

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, or DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, and descriptorSet, firstBinding, and bindingCount identify any OpTypeStruct variables, any heapOffset, and heapArrayStride members of the corresponding member of sourceData must be 0 or a multiple of bufferDescriptorAlignment

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, or DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, and descriptorSet, firstBinding, and bindingCount identify any OpTypeSampler variables, any heapOffset and heapArrayStride members of the corresponding member of sourceData must be 0 or a multiple of samplerDescriptorAlignment

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, or DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, and descriptorSet, firstBinding, and bindingCount identify any OpTypeSampledImage variables, any samplerHeapOffset and samplerHeapArrayStride members of the corresponding member of sourceData must be 0 or a multiple of samplerDescriptorAlignment

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, or DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, and descriptorSet, firstBinding, and bindingCount identify any OpTypeSampledImage variables, any heapOffset and heapArrayStride members of the corresponding member of sourceData must be 0 or a multiple of imageDescriptorAlignment

• If source is DESCRIPTOR_MAPPING_SOURCE_RESOURCE_HEAP_DATA_EXT, DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_DATA_EXT, or DESCRIPTOR_MAPPING_SOURCE_PUSH_DATA_EXT, resourceMask must include SPIRV_RESOURCE_TYPE_UNIFORM_BUFFER_BIT_EXT

• If source is DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_ADDRESS_EXT or DESCRIPTOR_MAPPING_SOURCE_PUSH_ADDRESS_EXT, resourceMask must include at least one of SPIRV_RESOURCE_TYPE_UNIFORM_BUFFER_BIT_EXT, SPIRV_RESOURCE_TYPE_READ_ONLY_STORAGE_BUFFER_BIT_EXT, SPIRV_RESOURCE_TYPE_READ_WRITE_STORAGE_BUFFER_BIT_EXT, or SPIRV_RESOURCE_TYPE_ACCELERATION_STRUCTURE_BIT_EXT

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, or DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, and the mapping sets useCombinedImageSamplerIndex to TRUE, resourceMask must include at least one of SPIRV_RESOURCE_TYPE_COMBINED_SAMPLED_IMAGE_BIT_EXT, SPIRV_RESOURCE_TYPE_SAMPLED_IMAGE_BIT_EXT, or SPIRV_RESOURCE_TYPE_SAMPLER_BIT_EXT

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, or DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, and bindingCount is not 1, the pEmbeddedSampler member of the corresponding mapping structure must be NULL

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, or DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, and descriptorSet, firstBinding, and bindingCount identify any OpTypeTensorARM variables, the heapOffset, and heapArrayStride members of the corresponding member of sourceData must be 0 or a multiple of tensorDescriptorAlignment

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_AND_BINDING_MAPPING_EXT

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

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

• resourceMask must be a valid combination of SpirvResourceTypeFlagBitsEXT values

• resourceMask must not be 0

• source must be a valid DescriptorMappingSourceEXT value

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT, the constantOffset member of sourceData must be a valid DescriptorMappingSourceConstantOffsetEXT structure

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT, the pushIndex member of sourceData must be a valid DescriptorMappingSourcePushIndexEXT structure

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT, the indirectIndex member of sourceData must be a valid DescriptorMappingSourceIndirectIndexEXT structure

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT, the indirectIndexArray member of sourceData must be a valid DescriptorMappingSourceIndirectIndexArrayEXT structure

• If source is DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT, the shaderRecordIndex member of sourceData must be a valid DescriptorMappingSourceShaderRecordIndexEXT structure

See Also

VK_EXT_descriptor_heap, DescriptorMappingSourceDataEXT, DescriptorMappingSourceEXT, ShaderDescriptorSetAndBindingMappingInfoEXT, SpirvResourceTypeFlagsEXT, StructureType

VkShaderDescriptorSetAndBindingMappingInfoEXT - Structure specifying mappings from shader resources to descriptor heaps

Description

Including this structure in the pNext chain of PipelineShaderStageCreateInfo will set mappings for the shader defined by that structure. Similarly, including this structure in the pNext chain of a ShaderCreateInfoEXT with a codeType of SHADER_CODE_TYPE_SPIRV_EXT, will set mappings for that shader.

If this structure is not present, it is equivalent to setting mappingCount to 0.

Valid Usage

• Any two elements of pMappings must not have the same value of descriptorSet, an overlapping range specified by firstBinding and bindingCount, and any overlapping bits in resourceMask

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SHADER_DESCRIPTOR_SET_AND_BINDING_MAPPING_INFO_EXT

• If mappingCount is not 0, pMappings must be a valid pointer to an array of mappingCount valid DescriptorSetAndBindingMappingEXT structures

Structure Chaining

Extends the structures

• PipelineShaderStageCreateInfo

• ShaderCreateInfoEXT

See Also

VK_EXT_descriptor_heap, DescriptorSetAndBindingMappingEXT, StructureType

VkSamplerCustomBorderColorIndexCreateInfoEXT - Structure specifying the custom border color index for a sampler

Description

If this structure is included in the pNext chain of SamplerCreateInfo, the value of index will be used for the custom border color registration. index does not need to be registered at the point that a sampler object is created or a sampler descriptor is written; as long as it is registered when any use of the sampler is recorded to a command, and remains registered while the sampler is in use. The color registered with the index and the color specified in the sampler must be identically defined.

If this structure is not provided when creating a sampler object with a custom border color, it is equivalent to registering a new custom border color by calling registerCustomBorderColorEXT with that custom border color value, and using that value as index in this structure. This implicit registration will be implicitly unregistered when the sampler is destroyed.

If this structure is not provided when creating a sampler object without a custom border color, it is equivalent to setting index to 0.

Structure Chaining

Extends the structure

• SamplerCreateInfo

See Also

VK_EXT_custom_border_color, VK_EXT_descriptor_heap, StructureType

VkOpaqueCaptureDataCreateInfoEXT - Structure specifying opaque capture data

Description

When an image is created with IMAGE_CREATE_DESCRIPTOR_HEAP_CAPTURE_REPLAY_BIT_EXT set in ImageCreateInfo::flags, if the pNext chain of ImageCreateInfo includes this structure, and pData is not NULL, the implementation will attempt to recreate the image such that descriptors written with writeResourceDescriptorsEXT will be reproduced with the same bit pattern as during capture if possible. If the implementation is unable to recreate the image based on this data, image creation will fail and return ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS.

When a tensor is created with TENSOR_CREATE_DESCRIPTOR_HEAP_CAPTURE_REPLAY_BIT_ARM set in TensorCreateInfoARM::flags, if the pNext chain of TensorCreateInfoARM includes this structure, and pData is not NULL, the implementation will attempt to recreate the tensor such that descriptors written with writeResourceDescriptorsEXT will be reproduced with the same bit pattern as during capture if possible. If the implementation is unable to recreate the tensor based on this data, tensor creation will fail and return ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS.

If this structure is not present, it is equivalent to setting pData to NULL.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_OPAQUE_CAPTURE_DATA_CREATE_INFO_EXT

• If pData is not NULL, pData must be a valid pointer to a valid HostAddressRangeConstEXT structure

Structure Chaining

Extends the structures

• ImageCreateInfo

• TensorCreateInfoARM

See Also

VK_EXT_descriptor_heap, HostAddressRangeConstEXT, StructureType

VkIndirectCommandsLayoutPushDataTokenNV - Struct specifying the details of an indirect push data command layout token

Description

If this structure is in the pNext chain of IndirectCommandsLayoutTokenNV, and IndirectCommandsLayoutTokenNV::tokenType is set to INDIRECT_COMMANDS_TOKEN_TYPE_PUSH_DATA_NV, this structure defines a push data command layout token.

If this structure is not provided, it is equivalent to setting pushDataOffset and pushDataSize to 0.

Valid Usage

• The sum of pushDataOffset and pushDataSize must be less than maxPushDataSize

• pushDataOffset must be a multiple of 4

• pushDataSize must be a multiple of 4

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_PUSH_DATA_TOKEN_NV

Structure Chaining

Extends the structure

• IndirectCommandsLayoutTokenNV

See Also

VK_EXT_descriptor_heap, VK_NV_device_generated_commands, StructureType

VkSubsampledImageFormatPropertiesEXT - Structure specifying image descriptor count for subsampled images

Structure Chaining

Extends the structure

• ImageFormatProperties2

See Also

VK_EXT_descriptor_heap, VK_EXT_fragment_density_map, StructureType

VkPhysicalDeviceDescriptorHeapFeaturesEXT - Structure describing support for descriptor heaps

Description

If the PhysicalDeviceDescriptorHeapFeaturesEXT 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 PhysicalDeviceDescriptorHeapFeaturesEXT, 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_heap, Bool32, StructureType

VkPhysicalDeviceDescriptorHeapPropertiesEXT - Structure describing supported image alignments for a physical device

Description

If the PhysicalDeviceDescriptorHeapPropertiesEXT 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_heap, Bool32, DeviceSize, StructureType

VkCommandBufferInheritanceDescriptorHeapInfoEXT - Structure specifying command buffer inheritance information

Description

If this structure is not present, the behavior is as if pSamplerHeapBindInfo and pResourceHeapBindInfo were both NULL.

Valid Usage

• If the descriptorHeap feature is not enabled, pSamplerHeapBindInfo must be NULL

• If the descriptorHeap feature is not enabled, pResourceHeapBindInfo must be NULL

• If pSamplerHeapBindInfo is not NULL, pSamplerHeapBindInfo->heapRange must be a device address range allocated to the application from a buffer created with the BUFFER_USAGE_DESCRIPTOR_HEAP_BIT_EXT usage flag set

• If pResourceHeapBindInfo is not NULL, pResourceHeapBindInfo->heapRange must be a device address range allocated to the application from a buffer created with the BUFFER_USAGE_DESCRIPTOR_HEAP_BIT_EXT usage flag set

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_DESCRIPTOR_HEAP_INFO_EXT

• If pSamplerHeapBindInfo is not NULL, pSamplerHeapBindInfo must be a valid pointer to a valid BindHeapInfoEXT structure

• If pResourceHeapBindInfo is not NULL, pResourceHeapBindInfo must be a valid pointer to a valid BindHeapInfoEXT structure

Structure Chaining

Extends the structure

• CommandBufferInheritanceInfo

See Also

VK_EXT_descriptor_heap, BindHeapInfoEXT, StructureType

VkPhysicalDeviceDescriptorHeapTensorPropertiesARM - Structure describing descriptor heap tensor properties supported by an implementation

Description

If the PhysicalDeviceDescriptorHeapTensorPropertiesARM 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_ARM_tensors, VK_EXT_descriptor_heap, DeviceSize, StructureType

VkDescriptorMappingSourceEXT - Specifies the mapping source for a shader binding

Description

• DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_CONSTANT_OFFSET_EXT specifies that the resource will be backed by a descriptor from the heap at a constant index.

• DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_PUSH_INDEX_EXT specifies that the resource will be backed by a descriptor from the heap at an index sourced from push data, added to a constant index.

• DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_EXT specifies that the resource will be backed by a descriptor from the heap at an index sourced from an address in push data, added to a constant index. If the mapping is an array, the array will be mapped to a base offset in indirect memory, and subsequent elements are mapped as offsets to that base.

• DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_INDIRECT_INDEX_ARRAY_EXT specifies that the resource will be backed by a descriptor from the heap at an index sourced from an address in push data, added to a constant index. If the mapping is an array, each array element will be mapped to a separate index in indirect memory.

• DESCRIPTOR_MAPPING_SOURCE_RESOURCE_HEAP_DATA_EXT specifies that the resource will be backed by heap data directly.

• DESCRIPTOR_MAPPING_SOURCE_PUSH_DATA_EXT specifies that the resource will be backed by push data directly.

• DESCRIPTOR_MAPPING_SOURCE_PUSH_ADDRESS_EXT specifies that the resource will be backed by an address in push data.

• DESCRIPTOR_MAPPING_SOURCE_INDIRECT_ADDRESS_EXT specifies that the resource will be backed by an address sourced via another address in push data.

• DESCRIPTOR_MAPPING_SOURCE_HEAP_WITH_SHADER_RECORD_INDEX_EXT specifies that the resource will be backed by a descriptor from the heap at an index sourced from shader record data, added to a constant index.

• DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_DATA_EXT specifies that the resource will be backed by shader record data directly.

• DESCRIPTOR_MAPPING_SOURCE_SHADER_RECORD_ADDRESS_EXT specifies that the resource will be backed by an address in shader record data.

See Also

VK_EXT_descriptor_heap, DescriptorSetAndBindingMappingEXT

VkSpirvResourceTypeFlagBitsEXT - Bitmask specifying different SPIR-V resource declarations

Description

• SPIRV_RESOURCE_TYPE_ALL_EXT specifies that all resource declarations are included.

• SPIRV_RESOURCE_TYPE_SAMPLER_BIT_EXT specifies OpTypeSampler variables.

• SPIRV_RESOURCE_TYPE_SAMPLED_IMAGE_BIT_EXT specifies OpTypeImage variables with a Sampled parameter of 1.

• SPIRV_RESOURCE_TYPE_READ_ONLY_IMAGE_BIT_EXT specifies OpTypeImage variables with a Sampled parameter of 2 and decorated with NonWritable.

• SPIRV_RESOURCE_TYPE_READ_WRITE_IMAGE_BIT_EXT specifies OpTypeImage variables with a Sampled parameter of 2 and not decorated with NonWritable.

• SPIRV_RESOURCE_TYPE_COMBINED_SAMPLED_IMAGE_BIT_EXT specifies OpTypeSampledImage variables.

• SPIRV_RESOURCE_TYPE_UNIFORM_BUFFER_BIT_EXT specifies OpTypeStruct variables in the Uniform storage class decorated with Block

• SPIRV_RESOURCE_TYPE_READ_ONLY_STORAGE_BUFFER_BIT_EXT specifies OpTypeStruct variables either in the StorageBuffer storage class decorated with Block or in the Uniform storage class decorated with BufferBlock, and decorated with NonWritable

• SPIRV_RESOURCE_TYPE_READ_WRITE_STORAGE_BUFFER_BIT_EXT specifies OpTypeStruct variables either in the StorageBuffer storage class decorated with Block or in the Uniform storage class decorated with BufferBlock, but not decorated with NonWritable

• SPIRV_RESOURCE_TYPE_ACCELERATION_STRUCTURE_BIT_EXT specifies OpTypeAccelerationStructureKHR variables

• SPIRV_RESOURCE_TYPE_TENSOR_BIT_ARM specifies OpTypeTensorARM variables

See Also

VK_EXT_descriptor_heap, SpirvResourceTypeFlagsEXT

VkTensorARM - Opaque handle to a tensor object

See Also

VK_ARM_tensors, VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_EXT_descriptor_heap, BindTensorMemoryInfoARM, CopyTensorInfoARM, FrameBoundaryTensorsARM, MemoryDedicatedAllocateInfoTensorARM, TensorCaptureDescriptorDataInfoARM, TensorMemoryBarrierARM, TensorMemoryRequirementsInfoARM, TensorViewCreateInfoARM, createTensorARM, destroyTensorARM, getTensorOpaqueCaptureDataARM

VkSamplerCustomBorderColorCreateInfoEXT - Structure specifying custom border color

Description

If format is a depth/stencil format, the aspect is determined by the value of SamplerCreateInfo::borderColor. If SamplerCreateInfo::borderColor is BORDER_COLOR_FLOAT_CUSTOM_EXT, the depth aspect is considered. If SamplerCreateInfo::borderColor is BORDER_COLOR_INT_CUSTOM_EXT, the stencil aspect is considered.

If format is FORMAT_UNDEFINED, the SamplerCreateInfo::borderColor is BORDER_COLOR_INT_CUSTOM_EXT, and the sampler is used with an image with a stencil format, then the implementation must source the custom border color from either the first or second components of SamplerCreateInfo::borderColor and should source it from the first component.

Valid Usage

• If format is not FORMAT_UNDEFINED and format is not a depth/stencil format then the SamplerCreateInfo::borderColor type must match the sampled type of the provided format, as shown in the SPIR-V Type column of the https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#formats-numericformat table

• If the customBorderColorWithoutFormat feature is not enabled then format must not be FORMAT_UNDEFINED

• If the sampler is used to sample an image view of FORMAT_B4G4R4A4_UNORM_PACK16, FORMAT_B5G6R5_UNORM_PACK16, FORMAT_A1B5G5R5_UNORM_PACK16, or FORMAT_B5G5R5A1_UNORM_PACK16 format then format must not be FORMAT_UNDEFINED

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SAMPLER_CUSTOM_BORDER_COLOR_CREATE_INFO_EXT

• format must be a valid Format value

Structure Chaining

Extends the structure

• SamplerCreateInfo

See Also

VK_EXT_custom_border_color, ClearColorValue, Format, StructureType, registerCustomBorderColorEXT

VkTensorViewCreateInfoARM - Structure specifying parameters of a newly created tensor view

Description

If tensor was created with the TENSOR_CREATE_MUTABLE_FORMAT_BIT_ARM flag, format can be different from the tensor’s format, but if they are not equal they must be compatible. Tensor format compatibility is defined in the Format Compatibility Classes section. Views of compatible formats will have the same mapping between element locations irrespective of the format, with only the interpretation of the bit pattern changing.

Values intended to be used with one view format may not be exactly preserved when written or read through a different format. For example, an integer value that happens to have the bit pattern of a floating-point denorm or NaN may be flushed or canonicalized when written or read through a view with a floating-point format. Similarly, a value written through a signed normalized format that has a bit pattern exactly equal to -2b may be changed to -2b + 1 as described in Conversion from Normalized Fixed-Point to Floating-Point.

Valid Usage

• If tensor was not created with TENSOR_CREATE_MUTABLE_FORMAT_BIT_ARM flag, format must be identical to the format used to create tensor

• If tensor was created with TENSOR_CREATE_MUTABLE_FORMAT_BIT_ARM flag, format must be compatible with the format used to create tensor, as defined in Format Compatibility Classes

• If flags includes TENSOR_VIEW_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_ARM, the descriptorBufferCaptureReplay feature must be enabled

• If the pNext chain includes a OpaqueCaptureDescriptorDataCreateInfoEXT structure, flags must contain TENSOR_VIEW_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_ARM

• The usage flags of tensor must have at least one of the following bits set:

  • TENSOR_USAGE_SHADER_BIT_ARM

  • TENSOR_USAGE_DATA_GRAPH_BIT_ARM

• The tensor view’s format features must contain the format feature flags required by the usage flags of tensor for format as indicated in the https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#format-feature-dependent-usage-flags section

• If tensor is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_TENSOR_VIEW_CREATE_INFO_ARM

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

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

• flags must be a valid combination of TensorViewCreateFlagBitsARM values

• tensor must be a valid TensorARM handle

• format must be a valid Format value

See Also

VK_ARM_tensors, VK_EXT_descriptor_heap, Format, ResourceDescriptorDataEXT, StructureType, TensorARM, TensorViewCreateFlagsARM, createTensorViewARM

VkDeviceAddressRangeKHR - Structure specifying a device address range

Valid Usage

• If size is not 0, address must not be 0

• The sum of address and size must be less than or equal to the sum of an address retrieved from a Buffer and the value of BufferCreateInfo::size used to create that Buffer

Valid Usage (Implicit)

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

See Also

VK_EXT_descriptor_heap, VK_KHR_device_address_commands, AccelerationStructureCreateInfo2KHR, BindHeapInfoEXT, BindIndexBuffer3InfoKHR, BindTransformFeedbackBuffer2InfoEXT, ConditionalRenderingBeginInfo2EXT, DeviceAddress, DeviceMemoryCopyKHR, DeviceMemoryImageCopyKHR, DeviceSize, DispatchIndirect2InfoKHR, DrawIndirectCount2InfoKHR, MemoryMarkerInfoAMD, MemoryRangeBarrierKHR, ResourceDescriptorDataEXT, TexelBufferDescriptorInfoEXT, cmdFillMemoryKHR, cmdUpdateMemoryKHR

VkIndirectCommandsTokenTypeNV - Enum specifying token commands

Description

'

Supported Indirect Command Tokens

See Also

VK_NV_device_generated_commands, IndirectCommandsLayoutTokenNV

VkIndirectCommandsTokenTypeEXT - Enum specifying token commands

Description

'