C Specification
To dispatch ray tracing, with some parameters sourced on the device, use:
// Provided by VK_KHR_ray_tracing
void vkCmdTraceRaysIndirectKHR(
VkCommandBuffer commandBuffer,
const VkStridedBufferRegionKHR* pRaygenShaderBindingTable,
const VkStridedBufferRegionKHR* pMissShaderBindingTable,
const VkStridedBufferRegionKHR* pHitShaderBindingTable,
const VkStridedBufferRegionKHR* pCallableShaderBindingTable,
VkBuffer buffer,
VkDeviceSize offset);
Parameters
-
commandBuffer
is the command buffer into which the command will be recorded. -
pRaygenShaderBindingTable
is a VkStridedBufferRegionKHR that holds the shader binding table data for the ray generation shader stage. -
pMissShaderBindingTable
is a VkStridedBufferRegionKHR that holds the shader binding table data for the miss shader stage. -
pHitShaderBindingTable
is a VkStridedBufferRegionKHR that holds the shader binding table data for the hit shader stage. -
pCallableShaderBindingTable
is a VkStridedBufferRegionKHR that holds the shader binding table data for the callable shader stage. -
buffer
is the buffer containing the trace ray parameters. -
offset
is the byte offset intobuffer
where parameters begin.
Description
vkCmdTraceRaysIndirectKHR
behaves similarly to vkCmdTraceRaysKHR
except that the ray trace query dimensions are read by the device from
buffer
during execution.
The parameters of trace ray are encoded in the
VkTraceRaysIndirectCommandKHR structure located at offset
bytes
in buffer
.
-
VUID-vkCmdTraceRaysIndirectKHR-None-02690
If aVkImageView
is sampled withVK_FILTER_LINEAR
as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
-
VUID-vkCmdTraceRaysIndirectKHR-None-02691
If aVkImageView
is accessed using atomic operations as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
-
VUID-vkCmdTraceRaysIndirectKHR-None-02692
If aVkImageView
is sampled withVK_FILTER_CUBIC_EXT
as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
-
VUID-vkCmdTraceRaysIndirectKHR-filterCubic-02694
Any VkImageView being sampled withVK_FILTER_CUBIC_EXT
as a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified byVkFilterCubicImageViewImageFormatPropertiesEXT
::filterCubic
returned byvkGetPhysicalDeviceImageFormatProperties2
-
VUID-vkCmdTraceRaysIndirectKHR-filterCubicMinmax-02695
Any VkImageView being sampled withVK_FILTER_CUBIC_EXT
with a reduction mode of eitherVK_SAMPLER_REDUCTION_MODE_MIN
orVK_SAMPLER_REDUCTION_MODE_MAX
as a result of this command must have a VkImageViewType and format that supports cubic filtering together with minmax filtering, as specified byVkFilterCubicImageViewImageFormatPropertiesEXT
::filterCubicMinmax
returned byvkGetPhysicalDeviceImageFormatProperties2
-
VUID-vkCmdTraceRaysIndirectKHR-flags-02696
Any VkImage created with a VkImageCreateInfo::flags
containingVK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV
sampled as a result of this command must only be sampled using a VkSamplerAddressMode ofVK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
-
VUID-vkCmdTraceRaysIndirectKHR-None-02697
For each set n that is statically used by theVkPipeline
bound to the pipeline bind point used by this command, a descriptor set must have been bound to n at the same pipeline bind point, with aVkPipelineLayout
that is compatible for set n, with theVkPipelineLayout
used to create the currentVkPipeline
, as described in [descriptorsets-compatibility] -
VUID-vkCmdTraceRaysIndirectKHR-None-02698
For each push constant that is statically used by theVkPipeline
bound to the pipeline bind point used by this command, a push constant value must have been set for the same pipeline bind point, with aVkPipelineLayout
that is compatible for push constants, with theVkPipelineLayout
used to create the currentVkPipeline
, as described in [descriptorsets-compatibility] -
VUID-vkCmdTraceRaysIndirectKHR-None-02699
Descriptors in each bound descriptor set, specified viavkCmdBindDescriptorSets
, must be valid if they are statically used by theVkPipeline
bound to the pipeline bind point used by this command -
VUID-vkCmdTraceRaysIndirectKHR-None-02700
A valid pipeline must be bound to the pipeline bind point used by this command -
VUID-vkCmdTraceRaysIndirectKHR-commandBuffer-02701
If theVkPipeline
object bound to the pipeline bind point used by this command requires any dynamic state, that state must have been set forcommandBuffer
, and done so after any previously bound pipeline with the corresponding state not specified as dynamic -
VUID-vkCmdTraceRaysIndirectKHR-None-02859
There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in theVkPipeline
object bound to the pipeline bind point used by this command, since that pipeline was bound -
VUID-vkCmdTraceRaysIndirectKHR-None-02702
If theVkPipeline
object bound to the pipeline bind point used by this command accesses aVkSampler
object that uses unnormalized coordinates, that sampler must not be used to sample from anyVkImage
with aVkImageView
of the typeVK_IMAGE_VIEW_TYPE_3D
,VK_IMAGE_VIEW_TYPE_CUBE
,VK_IMAGE_VIEW_TYPE_1D_ARRAY
,VK_IMAGE_VIEW_TYPE_2D_ARRAY
orVK_IMAGE_VIEW_TYPE_CUBE_ARRAY
, in any shader stage -
VUID-vkCmdTraceRaysIndirectKHR-None-02703
If theVkPipeline
object bound to the pipeline bind point used by this command accesses aVkSampler
object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-VOpImageSample*
orOpImageSparseSample*
instructions withImplicitLod
,Dref
orProj
in their name, in any shader stage -
VUID-vkCmdTraceRaysIndirectKHR-None-02704
If theVkPipeline
object bound to the pipeline bind point used by this command accesses aVkSampler
object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-VOpImageSample*
orOpImageSparseSample*
instructions that includes a LOD bias or any offset values, in any shader stage -
VUID-vkCmdTraceRaysIndirectKHR-None-02705
If the robust buffer access feature is not enabled, and if theVkPipeline
object bound to the pipeline bind point used by this command accesses a uniform buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point -
VUID-vkCmdTraceRaysIndirectKHR-None-02706
If the robust buffer access feature is not enabled, and if theVkPipeline
object bound to the pipeline bind point used by this command accesses a storage buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point -
VUID-vkCmdTraceRaysIndirectKHR-commandBuffer-02707
IfcommandBuffer
is an unprotected command buffer, any resource accessed by theVkPipeline
object bound to the pipeline bind point used by this command must not be a protected resource -
VUID-vkCmdTraceRaysIndirectKHR-None-04115
If aVkImageView
is accessed usingOpImageWrite
as a result of this command, then theType
of theTexel
operand of that instruction must have at least as many components as the image view’s format. -
VUID-vkCmdTraceRaysIndirectKHR-None-03429
Any shader group handle referenced by this call must have been queried from the currently bound ray tracing shader pipeline -
VUID-vkCmdTraceRaysIndirectKHR-maxRecursionDepth-03430
This command must not cause a shader call instruction to be executed from a shader invocation with a recursion depth greater than the value ofmaxRecursionDepth
used to create the bound ray tracing pipeline
-
VUID-vkCmdTraceRaysIndirectKHR-pRayGenShaderBindingTable-04019
IfpRayGenShaderBindingTable->buffer
is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemory
object -
VUID-vkCmdTraceRaysIndirectKHR-offset-04020
Theoffset
member ofpRayGenShaderBindingTable
must be less than the size of thepRayGenShaderBindingTable->buffer
-
VUID-vkCmdTraceRaysIndirectKHR-pRayGenShaderBindingTable-04021
pRayGenShaderBindingTable->offset
must be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR
::shaderGroupBaseAlignment
-
VUID-vkCmdTraceRaysIndirectKHR-pRayGenShaderBindingTable-04022
pRayGenShaderBindingTable->offset
+pRayGenShaderBindingTable->size
must be less than or equal to the size ofpRayGenShaderBindingTable->buffer
-
VUID-vkCmdTraceRaysIndirectKHR-size-04023
Thesize
member ofpRayGenShaderBindingTable
must be equal to itsstride
member -
VUID-vkCmdTraceRaysIndirectKHR-pMissShaderBindingTable-04024
IfpMissShaderBindingTable->buffer
is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemory
object -
VUID-vkCmdTraceRaysIndirectKHR-offset-04025
Theoffset
member ofpMissShaderBindingTable
must be less than the size ofpMissShaderBindingTable->buffer
-
VUID-vkCmdTraceRaysIndirectKHR-offset-04026
Theoffset
member ofpMissShaderBindingTable
must be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR
::shaderGroupBaseAlignment
-
VUID-vkCmdTraceRaysIndirectKHR-pMissShaderBindingTable-04027
pMissShaderBindingTable->offset
+pMissShaderBindingTable->size
must be less than or equal to the size ofpMissShaderBindingTable->buffer
-
VUID-vkCmdTraceRaysIndirectKHR-stride-04028
Thestride
member ofpMissShaderBindingTable
must be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR
::shaderGroupHandleSize
-
VUID-vkCmdTraceRaysIndirectKHR-stride-04029
Thestride
member ofpMissShaderBindingTable
must be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR
::maxShaderGroupStride
-
VUID-vkCmdTraceRaysIndirectKHR-pHitShaderBindingTable-04030
IfpHitShaderBindingTable->buffer
is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemory
object -
VUID-vkCmdTraceRaysIndirectKHR-offset-04031
Theoffset
member ofpHitShaderBindingTable
must be less than the size ofpHitShaderBindingTable->buffer
-
VUID-vkCmdTraceRaysIndirectKHR-offset-04032
Theoffset
member ofpHitShaderBindingTable
must be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR
::shaderGroupBaseAlignment
-
VUID-vkCmdTraceRaysIndirectKHR-pHitShaderBindingTable-04033
pHitShaderBindingTable->offset
+pHitShaderBindingTable->size
must be less than or equal to the size ofpHitShaderBindingTable->buffer
-
VUID-vkCmdTraceRaysIndirectKHR-stride-04034
Thestride
member ofpHitShaderBindingTable
must be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR
::shaderGroupHandleSize
-
VUID-vkCmdTraceRaysIndirectKHR-stride-04035
Thestride
member ofpHitShaderBindingTable
must be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR
::maxShaderGroupStride
-
VUID-vkCmdTraceRaysIndirectKHR-pCallableShaderBindingTable-04036
IfpCallableShaderBindingTable->buffer
is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemory
object -
VUID-vkCmdTraceRaysIndirectKHR-offset-04037
Theoffset
member ofpCallableShaderBindingTable
must be less than the size ofpCallableShaderBindingTable->buffer
-
VUID-vkCmdTraceRaysIndirectKHR-offset-04038
Theoffset
member ofpCallableShaderBindingTable
must be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR
::shaderGroupBaseAlignment
-
VUID-vkCmdTraceRaysIndirectKHR-pCallableShaderBindingTable-04039
pCallableShaderBindingTable->offset
+pCallableShaderBindingTable->size
must be less than or equal to the size ofpCallableShaderBindingTable->buffer
-
VUID-vkCmdTraceRaysIndirectKHR-stride-04040
Thestride
member ofpCallableShaderBindingTable
must be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR
::shaderGroupHandleSize
-
VUID-vkCmdTraceRaysIndirectKHR-stride-04041
Thestride
member ofpCallableShaderBindingTable
must be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR
::maxShaderGroupStride
-
VUID-vkCmdTraceRaysIndirectKHR-flags-03508
If the currently bound ray tracing pipeline was created withflags
that includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
, thebuffer
member ofpHitShaderBindingTable
must not be VK_NULL_HANDLE -
VUID-vkCmdTraceRaysIndirectKHR-flags-03509
If the currently bound ray tracing pipeline was created withflags
that includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
, thebuffer
member ofpHitShaderBindingTable
must not be VK_NULL_HANDLE -
VUID-vkCmdTraceRaysIndirectKHR-flags-03510
If the currently bound ray tracing pipeline was created withflags
that includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
, thebuffer
member ofpHitShaderBindingTable
must not be VK_NULL_HANDLE -
VUID-vkCmdTraceRaysIndirectKHR-flags-03511
If the currently bound ray tracing pipeline was created withflags
that includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR
, the shader group handle identified bypMissShaderBindingTable
must contain a valid miss shader -
VUID-vkCmdTraceRaysIndirectKHR-flags-03512
If the currently bound ray tracing pipeline was created withflags
that includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
, entries inpHitShaderBindingTable
accessed as a result of this command in order to execute an any hit shader must not be set to zero -
VUID-vkCmdTraceRaysIndirectKHR-flags-03513
If the currently bound ray tracing pipeline was created withflags
that includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
, entries inpHitShaderBindingTable
accessed as a result of this command in order to execute a closest hit shader must not be set to zero -
VUID-vkCmdTraceRaysIndirectKHR-flags-03514
If the currently bound ray tracing pipeline was created withflags
that includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
, entries inpHitShaderBindingTable
accessed as a result of this command in order to execute an intersection shader must not be set to zero
-
VUID-vkCmdTraceRaysIndirectKHR-buffer-02708
Ifbuffer
is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemory
object -
VUID-vkCmdTraceRaysIndirectKHR-buffer-02709
buffer
must have been created with theVK_BUFFER_USAGE_INDIRECT_BUFFER_BIT
bit set -
VUID-vkCmdTraceRaysIndirectKHR-offset-02710
offset
must be a multiple of4
-
VUID-vkCmdTraceRaysIndirectKHR-commandBuffer-02711
commandBuffer
must not be a protected command buffer -
VUID-vkCmdTraceRaysIndirectKHR-offset-03517
(offset
+sizeof
(VkTraceRaysIndirectCommandKHR
)) must be less than or equal to the size ofbuffer
-
VUID-vkCmdTraceRaysIndirectKHR-rayTracingIndirectTraceRays-03518
theVkPhysicalDeviceRayTracingFeaturesKHR
::rayTracingIndirectTraceRays
feature must be enabled
-
VUID-vkCmdTraceRaysIndirectKHR-commandBuffer-parameter
commandBuffer
must be a valid VkCommandBuffer handle -
VUID-vkCmdTraceRaysIndirectKHR-pRaygenShaderBindingTable-parameter
pRaygenShaderBindingTable
must be a valid pointer to a valid VkStridedBufferRegionKHR structure -
VUID-vkCmdTraceRaysIndirectKHR-pMissShaderBindingTable-parameter
pMissShaderBindingTable
must be a valid pointer to a valid VkStridedBufferRegionKHR structure -
VUID-vkCmdTraceRaysIndirectKHR-pHitShaderBindingTable-parameter
pHitShaderBindingTable
must be a valid pointer to a valid VkStridedBufferRegionKHR structure -
VUID-vkCmdTraceRaysIndirectKHR-pCallableShaderBindingTable-parameter
pCallableShaderBindingTable
must be a valid pointer to a valid VkStridedBufferRegionKHR structure -
VUID-vkCmdTraceRaysIndirectKHR-buffer-parameter
buffer
must be a valid VkBuffer handle -
VUID-vkCmdTraceRaysIndirectKHR-commandBuffer-recording
commandBuffer
must be in the recording state -
VUID-vkCmdTraceRaysIndirectKHR-commandBuffer-cmdpool
TheVkCommandPool
thatcommandBuffer
was allocated from must support compute operations -
VUID-vkCmdTraceRaysIndirectKHR-renderpass
This command must only be called outside of a render pass instance -
VUID-vkCmdTraceRaysIndirectKHR-commonparent
Both ofbuffer
, andcommandBuffer
must have been created, allocated, or retrieved from the same VkDevice
-
Host access to
commandBuffer
must be externally synchronized -
Host access to the
VkCommandPool
thatcommandBuffer
was allocated from must be externally synchronized
Command Buffer Levels | Render Pass Scope | Supported Queue Types | Pipeline Type |
---|---|---|---|
Primary |
Outside |
Compute |
See Also
VkBuffer, VkCommandBuffer, VkDeviceSize
, VkStridedBufferRegionKHR
Document Notes
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.