C Specification
To dispatch ray tracing use:
// Provided by VK_KHR_ray_tracing_pipeline
void vkCmdTraceRaysKHR(
VkCommandBuffer commandBuffer,
const VkStridedDeviceAddressRegionKHR* pRaygenShaderBindingTable,
const VkStridedDeviceAddressRegionKHR* pMissShaderBindingTable,
const VkStridedDeviceAddressRegionKHR* pHitShaderBindingTable,
const VkStridedDeviceAddressRegionKHR* pCallableShaderBindingTable,
uint32_t width,
uint32_t height,
uint32_t depth);
Parameters
-
commandBufferis the command buffer into which the command will be recorded. -
pRaygenShaderBindingTableis a VkStridedDeviceAddressRegionKHR that holds the shader binding table data for the ray generation shader stage. -
pMissShaderBindingTableis a VkStridedDeviceAddressRegionKHR that holds the shader binding table data for the miss shader stage. -
pHitShaderBindingTableis a VkStridedDeviceAddressRegionKHR that holds the shader binding table data for the hit shader stage. -
pCallableShaderBindingTableis a VkStridedDeviceAddressRegionKHR 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-mipmapMode-04770
If a VkSampler created withmipmapModeequal toVK_SAMPLER_MIPMAP_MODE_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-06479
If a VkImageView is sampled with depth comparison, the image view’s format features must containVK_FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_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-OpTypeImage-06423
Any VkImageView or VkBufferView being written as a storage image or storage texel buffer where the image format field of theOpTypeImageisUnknownthen the view’s format feature must containVK_FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT -
VUID-vkCmdTraceRaysKHR-OpTypeImage-06424
Any VkImageView or VkBufferView being read as a storage image or storage texel buffer where the image format field of theOpTypeImageisUnknownthen the view’s format feature must containVK_FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT -
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-maintenance4-06425
If themaintenance4feature is not enabled, then 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 or inherited (if theVK_NV_inherited_viewport_scissorextension is enabled) 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-uniformBuffers-06935
If any stage of theVkPipelineobject bound to the pipeline bind point used by this command accesses a uniform buffer, and that stage was created without enabling eitherVK_PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_EXTorVK_PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2_EXTforuniformBuffers, and therobustBufferAccessfeature is not enabled, that stage 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-storageBuffers-06936
If any stage of theVkPipelineobject bound to the pipeline bind point used by this command accesses a storage buffer, and that stage was created without enabling eitherVK_PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_EXTorVK_PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2_EXTforstorageBuffers, and therobustBufferAccessfeature is not enabled, that stage 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 andprotectedNoFaultis not supported, any resource accessed by the VkPipeline object bound to the pipeline bind point used by this command must not be a protected resource -
VUID-vkCmdTraceRaysKHR-None-06550
If theVkPipelineobject bound to the pipeline bind point used by this command accesses aVkSamplerorVkImageViewobject that enables sampler Y′CBCR conversion, that object must only be used withOpImageSample*orOpImageSparseSample*instructions -
VUID-vkCmdTraceRaysKHR-ConstOffset-06551
If theVkPipelineobject bound to the pipeline bind point used by this command accesses aVkSamplerorVkImageViewobject that enables sampler Y′CBCR conversion, that object must not use theConstOffsetandOffsetoperands -
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 buffer view’s format -
VUID-vkCmdTraceRaysKHR-SampledType-04470
If a VkImageView with a VkFormat that has a 64-bit component 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 component 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 component 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 component 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 pipeline
-
VUID-vkCmdTraceRaysKHR-maxPipelineRayRecursionDepth-03679
This command must not cause a shader call instruction to be executed from a shader invocation with a recursion depth greater than the value ofmaxPipelineRayRecursionDepthused to create the bound ray tracing pipeline -
VUID-vkCmdTraceRaysKHR-commandBuffer-03635
commandBuffermust not be a protected command buffer
-
VUID-vkCmdTraceRaysKHR-pRayGenShaderBindingTable-03680
If the buffer from whichpRayGenShaderBindingTable->deviceAddresswas queried is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-vkCmdTraceRaysKHR-pRayGenShaderBindingTable-03681
The buffer from which thepRayGenShaderBindingTable->deviceAddressis queried must have been created with theVK_BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHRusage flag -
VUID-vkCmdTraceRaysKHR-pRayGenShaderBindingTable-03682
pRayGenShaderBindingTable->deviceAddressmust be a multiple ofVkPhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment -
VUID-vkCmdTraceRaysKHR-pMissShaderBindingTable-03683
If the buffer from whichpMissShaderBindingTable->deviceAddresswas queried is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-vkCmdTraceRaysKHR-pMissShaderBindingTable-03684
The buffer from which thepMissShaderBindingTable->deviceAddressis queried must have been created with theVK_BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHRusage flag -
VUID-vkCmdTraceRaysKHR-pMissShaderBindingTable-03685
pMissShaderBindingTable->deviceAddressmust be a multiple ofVkPhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment -
VUID-vkCmdTraceRaysKHR-stride-03686
pMissShaderBindingTable->stridemust be a multiple ofVkPhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment -
VUID-vkCmdTraceRaysKHR-stride-04029
pMissShaderBindingTable->stridemust be less than or equal toVkPhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-03687
If the buffer from whichpHitShaderBindingTable->deviceAddresswas queried is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-03688
The buffer from which thepHitShaderBindingTable->deviceAddressis queried must have been created with theVK_BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHRusage flag -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-03689
pHitShaderBindingTable->deviceAddressmust be a multiple ofVkPhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment -
VUID-vkCmdTraceRaysKHR-stride-03690
pHitShaderBindingTable->stridemust be a multiple ofVkPhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment -
VUID-vkCmdTraceRaysKHR-stride-04035
pHitShaderBindingTable->stridemust be less than or equal toVkPhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride -
VUID-vkCmdTraceRaysKHR-pCallableShaderBindingTable-03691
If the buffer from whichpCallableShaderBindingTable->deviceAddresswas queried is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-vkCmdTraceRaysKHR-pCallableShaderBindingTable-03692
The buffer from which thepCallableShaderBindingTable->deviceAddressis queried must have been created with theVK_BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHRusage flag -
VUID-vkCmdTraceRaysKHR-pCallableShaderBindingTable-03693
pCallableShaderBindingTable->deviceAddressmust be a multiple ofVkPhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment -
VUID-vkCmdTraceRaysKHR-stride-03694
pCallableShaderBindingTable->stridemust be a multiple ofVkPhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment -
VUID-vkCmdTraceRaysKHR-stride-04041
pCallableShaderBindingTable->stridemust be less than or equal toVkPhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride -
VUID-vkCmdTraceRaysKHR-flags-03696
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR,pHitShaderBindingTable->deviceAddressmust not be zero -
VUID-vkCmdTraceRaysKHR-flags-03697
If the currently bound ray tracing pipeline was created withflagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR,pHitShaderBindingTable->deviceAddressmust not be zero -
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 bypMissShaderBindingTable->deviceAddressmust not be set to zero -
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 in the table identified bypHitShaderBindingTable->deviceAddressaccessed 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 in the table identified bypHitShaderBindingTable->deviceAddressaccessed 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 in the table identified bypHitShaderBindingTable->deviceAddressaccessed as a result of this command in order to execute an intersection shader must not be set to zero -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-04735
Any non-zero hit shader group entries in the table identified bypHitShaderBindingTable->deviceAddressaccessed by this call from a geometry with ageometryTypeofVK_GEOMETRY_TYPE_TRIANGLES_KHRmust have been created withVK_RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-04736
Any non-zero hit shader group entries in the table identified bypHitShaderBindingTable->deviceAddressaccessed by this call from a geometry with ageometryTypeofVK_GEOMETRY_TYPE_AABBS_KHRmust have been created withVK_RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR
-
VUID-vkCmdTraceRaysKHR-width-03638
widthmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[0] ×VkPhysicalDeviceLimits::maxComputeWorkGroupSize[0] -
VUID-vkCmdTraceRaysKHR-height-03639
heightmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[1] ×VkPhysicalDeviceLimits::maxComputeWorkGroupSize[1] -
VUID-vkCmdTraceRaysKHR-depth-03640
depthmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[2] ×VkPhysicalDeviceLimits::maxComputeWorkGroupSize[2] -
VUID-vkCmdTraceRaysKHR-width-03641
width×height×depthmust be less than or equal toVkPhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayDispatchInvocationCount
-
VUID-vkCmdTraceRaysKHR-commandBuffer-parameter
commandBuffermust be a valid VkCommandBuffer handle -
VUID-vkCmdTraceRaysKHR-pRaygenShaderBindingTable-parameter
pRaygenShaderBindingTablemust be a valid pointer to a valid VkStridedDeviceAddressRegionKHR structure -
VUID-vkCmdTraceRaysKHR-pMissShaderBindingTable-parameter
pMissShaderBindingTablemust be a valid pointer to a valid VkStridedDeviceAddressRegionKHR structure -
VUID-vkCmdTraceRaysKHR-pHitShaderBindingTable-parameter
pHitShaderBindingTablemust be a valid pointer to a valid VkStridedDeviceAddressRegionKHR structure -
VUID-vkCmdTraceRaysKHR-pCallableShaderBindingTable-parameter
pCallableShaderBindingTablemust be a valid pointer to a valid VkStridedDeviceAddressRegionKHR 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 |
|---|---|---|
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.