C Specification
To dispatch ray tracing use:
// Provided by VK_KHR_ray_tracing
void vkCmdTraceRaysKHR(
VkCommandBuffer commandBuffer,
const VkStridedBufferRegionKHR* pRaygenShaderBindingTable,
const VkStridedBufferRegionKHR* pMissShaderBindingTable,
const VkStridedBufferRegionKHR* pHitShaderBindingTable,
const VkStridedBufferRegionKHR* pCallableShaderBindingTable,
uint32_t width,
uint32_t height,
uint32_t depth);
Parameters
-
commandBufferis the command buffer into which the command will be recorded. -
pRaygenShaderBindingTableis a VkStridedBufferRegionKHR that holds the shader binding table data for the ray generation shader stage. -
pMissShaderBindingTableis a VkStridedBufferRegionKHR that holds the shader binding table data for the miss shader stage. -
pHitShaderBindingTableis a VkStridedBufferRegionKHR that holds the shader binding table data for the hit shader stage. -
pCallableShaderBindingTableis a VkStridedBufferRegionKHR that holds the shader binding table data for the callable shader stage. -
widthis the width of the ray trace query dimensions. -
heightis height of the ray trace query dimensions. -
depthis depth of the ray trace query dimensions.
Description
When the command is executed, a ray generation group of width
× height × depth rays is assembled.
-
VUID-vkCmdTraceRaysKHR-magFilter-04553
If a VkSampler created withmagFilterorminFilterequal toVK_FILTER_LINEARandcompareEnableequal toVK_FALSEis used to sample a VkImageView as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT -
VUID-vkCmdTraceRaysKHR-None-02691
If aVkImageViewis 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-vkCmdTraceRaysKHR-None-02692
If aVkImageViewis sampled withVK_FILTER_CUBIC_EXTas a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT -
VUID-vkCmdTraceRaysKHR-filterCubic-02694
Any VkImageView being sampled withVK_FILTER_CUBIC_EXTas a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified byVkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicreturned byvkGetPhysicalDeviceImageFormatProperties2 -
VUID-vkCmdTraceRaysKHR-filterCubicMinmax-02695
Any VkImageView being sampled withVK_FILTER_CUBIC_EXTwith a reduction mode of eitherVK_SAMPLER_REDUCTION_MODE_MINorVK_SAMPLER_REDUCTION_MODE_MAXas a result of this command must have a VkImageViewType and format that supports cubic filtering together with minmax filtering, as specified byVkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmaxreturned byvkGetPhysicalDeviceImageFormatProperties2 -
VUID-vkCmdTraceRaysKHR-flags-02696
Any VkImage created with a VkImageCreateInfo::flagscontainingVK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NVsampled as a result of this command must only be sampled using a VkSamplerAddressMode ofVK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE -
VUID-vkCmdTraceRaysKHR-None-02697
For each set n that is statically used by theVkPipelinebound 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 aVkPipelineLayoutthat is compatible for set n, with theVkPipelineLayoutused to create the currentVkPipeline, as described in [descriptorsets-compatibility] -
VUID-vkCmdTraceRaysKHR-None-02698
For each push constant that is statically used by theVkPipelinebound to the pipeline bind point used by this command, a push constant value must have been set for the same pipeline bind point, with aVkPipelineLayoutthat is compatible for push constants, with theVkPipelineLayoutused to create the currentVkPipeline, as described in [descriptorsets-compatibility] -
VUID-vkCmdTraceRaysKHR-None-02699
Descriptors in each bound descriptor set, specified viavkCmdBindDescriptorSets, must be valid if they are statically used by theVkPipelinebound to the pipeline bind point used by this command -
VUID-vkCmdTraceRaysKHR-None-02700
A valid pipeline must be bound to the pipeline bind point used by this command -
VUID-vkCmdTraceRaysKHR-commandBuffer-02701
If theVkPipelineobject 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-vkCmdTraceRaysKHR-None-02859
There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in theVkPipelineobject bound to the pipeline bind point used by this command, since that pipeline was bound -
VUID-vkCmdTraceRaysKHR-None-02702
If theVkPipelineobject bound to the pipeline bind point used by this command accesses aVkSamplerobject that uses unnormalized coordinates, that sampler must not be used to sample from anyVkImagewith aVkImageViewof the typeVK_IMAGE_VIEW_TYPE_3D,VK_IMAGE_VIEW_TYPE_CUBE,VK_IMAGE_VIEW_TYPE_1D_ARRAY,VK_IMAGE_VIEW_TYPE_2D_ARRAYorVK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage -
VUID-vkCmdTraceRaysKHR-None-02703
If theVkPipelineobject bound to the pipeline bind point used by this command accesses aVkSamplerobject that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-VOpImageSample*orOpImageSparseSample*instructions withImplicitLod,DreforProjin their name, in any shader stage -
VUID-vkCmdTraceRaysKHR-None-02704
If theVkPipelineobject bound to the pipeline bind point used by this command accesses aVkSamplerobject 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-vkCmdTraceRaysKHR-None-02705
If the robust buffer access feature is not enabled, and if theVkPipelineobject 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-vkCmdTraceRaysKHR-None-02706
If the robust buffer access feature is not enabled, and if theVkPipelineobject 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-vkCmdTraceRaysKHR-commandBuffer-02707
IfcommandBufferis an unprotected command buffer, any resource accessed by theVkPipelineobject bound to the pipeline bind point used by this command must not be a protected resource -
VUID-vkCmdTraceRaysKHR-None-04115
If a VkImageView is accessed usingOpImageWriteas a result of this command, then theTypeof theTexeloperand of that instruction must have at least as many components as the image view’s format. -
VUID-vkCmdTraceRaysKHR-OpImageWrite-04469
If a VkBufferView is accessed usingOpImageWriteas a result of this command, then theTypeof theTexeloperand of that instruction must have at least as many components as the image view’s format. -
VUID-vkCmdTraceRaysKHR-SampledType-04470
If a VkImageView with a VkFormat that has a 64-bit channel width is accessed as a result of this command, theSampledTypeof theOpTypeImageoperand of that instruction must have aWidthof 64. -
VUID-vkCmdTraceRaysKHR-SampledType-04471
If a VkImageView with a VkFormat that has a channel width less than 64-bit is accessed as a result of this command, theSampledTypeof theOpTypeImageoperand of that instruction must have aWidthof 32. -
VUID-vkCmdTraceRaysKHR-SampledType-04472
If a VkBufferView with a VkFormat that has a 64-bit channel width is accessed as a result of this command, theSampledTypeof theOpTypeImageoperand of that instruction must have aWidthof 64. -
VUID-vkCmdTraceRaysKHR-SampledType-04473
If a VkBufferView with a VkFormat that has a channel width less than 64-bit is accessed as a result of this command, theSampledTypeof theOpTypeImageoperand of that instruction must have aWidthof 32. -
VUID-vkCmdTraceRaysKHR-sparseImageInt64Atomics-04474
If thesparseImageInt64Atomicsfeature is not enabled, VkImage objects created with theVK_IMAGE_CREATE_SPARSE_RESIDENCY_BITflag must not be accessed by atomic instructions through anOpTypeImagewith aSampledTypewith aWidthof 64 by this command. -
VUID-vkCmdTraceRaysKHR-sparseImageInt64Atomics-04475
If thesparseImageInt64Atomicsfeature is not enabled, VkBuffer objects created with theVK_BUFFER_CREATE_SPARSE_RESIDENCY_BITflag must not be accessed by atomic instructions through anOpTypeImagewith aSampledTypewith aWidthof 64 by this command. -
VUID-vkCmdTraceRaysKHR-None-03429
Any shader group handle referenced by this call must have been queried from the currently bound ray tracing shader pipeline -
VUID-vkCmdTraceRaysKHR-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 ofmaxRecursionDepthused to create the bound ray tracing pipeline
-
VUID-vkCmdTraceRaysKHR-pRayGenShaderBindingTable-04019
IfpRayGenShaderBindingTable->bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-vkCmdTraceRaysKHR-offset-04020
Theoffsetmember ofpRayGenShaderBindingTablemust be less than the size of thepRayGenShaderBindingTable->buffer -
VUID-vkCmdTraceRaysKHR-pRayGenShaderBindingTable-04021
pRayGenShaderBindingTable->offsetmust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment -
VUID-vkCmdTraceRaysKHR-pRayGenShaderBindingTable-04022
pRayGenShaderBindingTable->offset+pRayGenShaderBindingTable->sizemust be less than or equal to the size ofpRayGenShaderBindingTable->buffer -
VUID-vkCmdTraceRaysKHR-size-04023
Thesizemember ofpRayGenShaderBindingTablemust be equal to itsstridemember -
VUID-vkCmdTraceRaysKHR-pMissShaderBindingTable-04024
IfpMissShaderBindingTable->bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-vkCmdTraceRaysKHR-offset-04025
Theoffsetmember ofpMissShaderBindingTablemust be less than the size ofpMissShaderBindingTable->buffer -
VUID-vkCmdTraceRaysKHR-offset-04026
Theoffsetmember ofpMissShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment -
VUID-vkCmdTraceRaysKHR-pMissShaderBindingTable-04027
pMissShaderBindingTable->offset+pMissShaderBindingTable->sizemust be less than or equal to the size ofpMissShaderBindingTable->buffer -
VUID-vkCmdTraceRaysKHR-stride-04028
Thestridemember ofpMissShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize -
VUID-vkCmdTraceRaysKHR-stride-04029
Thestridemember ofpMissShaderBindingTablemust be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-04030
IfpHitShaderBindingTable->bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-vkCmdTraceRaysKHR-offset-04031
Theoffsetmember ofpHitShaderBindingTablemust be less than the size ofpHitShaderBindingTable->buffer -
VUID-vkCmdTraceRaysKHR-offset-04032
Theoffsetmember ofpHitShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-04033
pHitShaderBindingTable->offset+pHitShaderBindingTable->sizemust be less than or equal to the size ofpHitShaderBindingTable->buffer -
VUID-vkCmdTraceRaysKHR-stride-04034
Thestridemember ofpHitShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize -
VUID-vkCmdTraceRaysKHR-stride-04035
Thestridemember ofpHitShaderBindingTablemust be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride -
VUID-vkCmdTraceRaysKHR-pCallableShaderBindingTable-04036
IfpCallableShaderBindingTable->bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-vkCmdTraceRaysKHR-offset-04037
Theoffsetmember ofpCallableShaderBindingTablemust be less than the size ofpCallableShaderBindingTable->buffer -
VUID-vkCmdTraceRaysKHR-offset-04038
Theoffsetmember ofpCallableShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment -
VUID-vkCmdTraceRaysKHR-pCallableShaderBindingTable-04039
pCallableShaderBindingTable->offset+pCallableShaderBindingTable->sizemust be less than or equal to the size ofpCallableShaderBindingTable->buffer -
VUID-vkCmdTraceRaysKHR-stride-04040
Thestridemember ofpCallableShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize -
VUID-vkCmdTraceRaysKHR-stride-04041
Thestridemember ofpCallableShaderBindingTablemust be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride -
VUID-vkCmdTraceRaysKHR-flags-03508
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, thebuffermember ofpHitShaderBindingTablemust not be VK_NULL_HANDLE -
VUID-vkCmdTraceRaysKHR-flags-03509
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, thebuffermember ofpHitShaderBindingTablemust not be VK_NULL_HANDLE -
VUID-vkCmdTraceRaysKHR-flags-03510
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, thebuffermember ofpHitShaderBindingTablemust not be VK_NULL_HANDLE -
VUID-vkCmdTraceRaysKHR-flags-03511
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR, the shader group handle identified bypMissShaderBindingTablemust contain a valid miss shader -
VUID-vkCmdTraceRaysKHR-flags-03512
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, entries inpHitShaderBindingTableaccessed as a result of this command in order to execute an any hit shader must not be set to zero -
VUID-vkCmdTraceRaysKHR-flags-03513
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, entries inpHitShaderBindingTableaccessed as a result of this command in order to execute a closest hit shader must not be set to zero -
VUID-vkCmdTraceRaysKHR-flags-03514
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, entries inpHitShaderBindingTableaccessed as a result of this command in order to execute an intersection shader must not be set to zero
-
VUID-vkCmdTraceRaysKHR-commandBuffer-02712
IfcommandBufferis a protected command buffer, any resource written to by theVkPipelineobject bound to the pipeline bind point used by this command must not be an unprotected resource -
VUID-vkCmdTraceRaysKHR-commandBuffer-02713
IfcommandBufferis a protected command buffer, pipeline stages other than the framebuffer-space and compute stages in theVkPipelineobject bound to the pipeline bind point must not write to any resource -
VUID-vkCmdTraceRaysKHR-width-03505
widthmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[0] -
VUID-vkCmdTraceRaysKHR-height-03506
heightmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[1] -
VUID-vkCmdTraceRaysKHR-depth-03507
depthmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[2]
-
VUID-vkCmdTraceRaysKHR-commandBuffer-parameter
commandBuffermust be a valid VkCommandBuffer handle -
VUID-vkCmdTraceRaysKHR-pRaygenShaderBindingTable-parameter
pRaygenShaderBindingTablemust be a valid pointer to a valid VkStridedBufferRegionKHR structure -
VUID-vkCmdTraceRaysKHR-pMissShaderBindingTable-parameter
pMissShaderBindingTablemust be a valid pointer to a valid VkStridedBufferRegionKHR structure -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-parameter
pHitShaderBindingTablemust be a valid pointer to a valid VkStridedBufferRegionKHR structure -
VUID-vkCmdTraceRaysKHR-pCallableShaderBindingTable-parameter
pCallableShaderBindingTablemust be a valid pointer to a valid VkStridedBufferRegionKHR structure -
VUID-vkCmdTraceRaysKHR-commandBuffer-recording
commandBuffermust be in the recording state -
VUID-vkCmdTraceRaysKHR-commandBuffer-cmdpool
TheVkCommandPoolthatcommandBufferwas allocated from must support compute operations -
VUID-vkCmdTraceRaysKHR-renderpass
This command must only be called outside of a render pass instance
-
Host access to
commandBuffermust be externally synchronized -
Host access to the
VkCommandPoolthatcommandBufferwas allocated from must be externally synchronized
| Command Buffer Levels | Render Pass Scope | Supported Queue Types | Pipeline Type |
|---|---|---|---|
Primary |
Outside |
Compute |
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.