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.
-
If a
VkImageViewis sampled withVK_FILTER_LINEARas a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT -
If a
VkImageViewis 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 -
If a
VkImageViewis 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 -
Any VkImageView being sampled with
VK_FILTER_CUBIC_EXTas a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified byVkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicreturned byvkGetPhysicalDeviceImageFormatProperties2 -
Any VkImageView being sampled with
VK_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 -
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 -
For each set n that is statically used by the
VkPipelinebound 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] -
For each push constant that is statically used by the
VkPipelinebound 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] -
Descriptors in each bound descriptor set, specified via
vkCmdBindDescriptorSets, must be valid if they are statically used by theVkPipelinebound to the pipeline bind point used by this command -
A valid pipeline must be bound to the pipeline bind point used by this command
-
If the
VkPipelineobject 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 -
There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in the
VkPipelineobject bound to the pipeline bind point used by this command, since that pipeline was bound -
If the
VkPipelineobject 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 -
If the
VkPipelineobject 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 -
If the
VkPipelineobject 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 -
If the robust buffer access feature is not enabled, and if the
VkPipelineobject 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 -
If the robust buffer access feature is not enabled, and if the
VkPipelineobject 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 -
If
commandBufferis 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 -
If a
VkImageViewis 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. -
Any shader group handle referenced by this call must have been queried from the currently bound ray tracing shader pipeline
-
This command must not cause a shader call instruction to be executed from a shader invocation with a recursion depth greater than the value of
maxRecursionDepthused to create the bound ray tracing pipeline
-
If
pRayGenShaderBindingTable->bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
The
offsetmember ofpRayGenShaderBindingTablemust be less than the size of thepRayGenShaderBindingTable->buffer -
pRayGenShaderBindingTable->offsetmust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment -
pRayGenShaderBindingTable->offset+pRayGenShaderBindingTable->sizemust be less than or equal to the size ofpRayGenShaderBindingTable->buffer -
The
sizemember ofpRayGenShaderBindingTablemust be equal to itsstridemember -
If
pMissShaderBindingTable->bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
The
offsetmember ofpMissShaderBindingTablemust be less than the size ofpMissShaderBindingTable->buffer -
The
offsetmember ofpMissShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment -
pMissShaderBindingTable->offset+pMissShaderBindingTable->sizemust be less than or equal to the size ofpMissShaderBindingTable->buffer -
The
stridemember ofpMissShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize -
The
stridemember ofpMissShaderBindingTablemust be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride -
If
pHitShaderBindingTable->bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
The
offsetmember ofpHitShaderBindingTablemust be less than the size ofpHitShaderBindingTable->buffer -
The
offsetmember ofpHitShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment -
pHitShaderBindingTable->offset+pHitShaderBindingTable->sizemust be less than or equal to the size ofpHitShaderBindingTable->buffer -
The
stridemember ofpHitShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize -
The
stridemember ofpHitShaderBindingTablemust be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride -
If
pCallableShaderBindingTable->bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
The
offsetmember ofpCallableShaderBindingTablemust be less than the size ofpCallableShaderBindingTable->buffer -
The
offsetmember ofpCallableShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment -
pCallableShaderBindingTable->offset+pCallableShaderBindingTable->sizemust be less than or equal to the size ofpCallableShaderBindingTable->buffer -
The
stridemember ofpCallableShaderBindingTablemust be a multiple ofVkPhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize -
The
stridemember ofpCallableShaderBindingTablemust be less than or equal toVkPhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride -
If the currently bound ray tracing pipeline was created with
flagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, thebuffermember ofpHitShaderBindingTablemust not be VK_NULL_HANDLE -
If the currently bound ray tracing pipeline was created with
flagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, thebuffermember ofpHitShaderBindingTablemust not be VK_NULL_HANDLE -
If the currently bound ray tracing pipeline was created with
flagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, thebuffermember ofpHitShaderBindingTablemust not be VK_NULL_HANDLE -
If the currently bound ray tracing pipeline was created with
flagsthat includedVK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR, the shader group handle identified bypMissShaderBindingTablemust contain a valid miss shader -
If the currently bound ray tracing pipeline was created with
flagsthat 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 -
If the currently bound ray tracing pipeline was created with
flagsthat 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 -
If the currently bound ray tracing pipeline was created with
flagsthat 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
-
If
commandBufferis 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 -
If
commandBufferis 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 -
widthmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[0] -
heightmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[1] -
depthmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[2]
-
commandBuffermust be a valid VkCommandBuffer handle -
pRaygenShaderBindingTablemust be a valid pointer to a valid VkStridedBufferRegionKHR structure -
pMissShaderBindingTablemust be a valid pointer to a valid VkStridedBufferRegionKHR structure -
pHitShaderBindingTablemust be a valid pointer to a valid VkStridedBufferRegionKHR structure -
pCallableShaderBindingTablemust be a valid pointer to a valid VkStridedBufferRegionKHR structure -
commandBuffermust be in the recording state -
The
VkCommandPoolthatcommandBufferwas allocated from must support compute operations -
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.