vkCmdTraceRaysIndirect2KHR - Initialize an indirect ray tracing dispatch with indirect shader binding tables

Description

cmdTraceRaysIndirect2KHR behaves similarly to cmdTraceRaysIndirectKHR except that shader binding table parameters as well as dispatch dimensions are read by the device from indirectDeviceAddress during execution.

Valid Usage

• If a Sampler created with magFilter or minFilter equal to FILTER_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

• If a Sampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a ImageView is sampled with depth comparison, the image view’s format features must contain FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_BIT
• If a ImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER descriptor is accessed using atomic operations as a result of this command, then the storage texel buffer’s format features must contain FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT
• If a ImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• If the VK_EXT_filter_cubic extension is not enabled and any ImageView is sampled with FILTER_CUBIC_EXT as a result of this command, it must not have a ImageViewType of IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, or IMAGE_VIEW_TYPE_CUBE_ARRAY
• Any ImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a ImageViewType and format that supports cubic filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by getPhysicalDeviceImageFormatProperties2
• Any ImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a ImageViewType and format that supports cubic filtering together with minmax filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by getPhysicalDeviceImageFormatProperties2
• If the cubicRangeClamp feature is not enabled, then any ImageView being sampled with FILTER_CUBIC_EXT as a result of this command must not have a SamplerReductionModeCreateInfo::reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_RANGECLAMP_QCOM
• Any ImageView being sampled with a SamplerReductionModeCreateInfo::reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_RANGECLAMP_QCOM as a result of this command must sample with FILTER_CUBIC_EXT
• If the selectableCubicWeights feature is not enabled, then any ImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have SamplerCubicWeightsCreateInfoQCOM::cubicWeights equal to CUBIC_FILTER_WEIGHTS_CATMULL_ROM_QCOM
• Any Image created with a ImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a SamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• For any ImageView being written as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• For any ImageView being read as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For any BufferView being written as a storage texel buffer where the image format field of the OpTypeImage is Unknown, the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• Any BufferView being read as a storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For each set n that is statically used by a bound shader, a descriptor set must have been bound to n at the same pipeline bind point, with a PipelineLayout that is compatible for set n, with the PipelineLayout or DescriptorSetLayout array that was used to create the current Pipeline or ShaderEXT, as described in ???
• For each push constant that is statically used by a bound shader, a push constant value must have been set for the same pipeline bind point, with a PipelineLayout that is compatible for push constants, with the PipelineLayout or DescriptorSetLayout and PushConstantRange arrays used to create the current Pipeline or ShaderEXT, as described in ???
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by a bound shader, a push constant value must have been set for the same pipeline bind point, with a PipelineLayout that is compatible for push constants, with the PipelineLayout or DescriptorSetLayout and PushConstantRange arrays used to create the current Pipeline or ShaderEXT, as described in ???
• Descriptors in each bound descriptor set, specified via cmdBindDescriptorSets, must be valid if they are statically used by the Pipeline bound to the pipeline bind point used by this command and the bound Pipeline was not created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the descriptors used by the Pipeline bound to the pipeline bind point were specified via cmdBindDescriptorSets, the bound Pipeline must have been created without PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via cmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by the Pipeline bound to the pipeline bind point used by this command and the bound Pipeline was created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via cmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by any ShaderEXT bound to a stage corresponding to the pipeline bind point used by this command
• If the descriptors used by the Pipeline bound to the pipeline bind point were specified via cmdSetDescriptorBufferOffsetsEXT, the bound Pipeline must have been created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If a descriptor is dynamically used with a Pipeline created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• If a descriptor is dynamically used with a ShaderEXT created with a DescriptorSetLayout that was created with DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• If the shaderObject feature is not enabled, a valid pipeline must be bound to the pipeline bind point used by this command
• If the shaderObject is enabled, either a valid pipeline must be bound to the pipeline bind point used by this command, or a valid combination of valid and NULL_HANDLE shader objects must be bound to every supported shader stage corresponding to the pipeline bind point used by this command
• If a pipeline is bound to the pipeline bind point used by this command, there must not have been any calls to dynamic state setting commands for any state not specified as dynamic in the Pipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the Pipeline object bound to the pipeline bind point used by this command or any ShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used to sample from any Image with a ImageView of the type IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command or any ShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command or any ShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values, in any shader stage
• If any stage of the Pipeline object bound to the pipeline bind point used by this command accesses a uniform buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_EXT or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2_EXT for uniformBuffers, and the robustBufferAccess feature 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
• If the robustBufferAccess feature is not enabled, and any ShaderEXT bound to a stage corresponding 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 any stage of the Pipeline object bound to the pipeline bind point used by this command accesses a storage buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_EXT or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2_EXT for storageBuffers, and the robustBufferAccess feature 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
• If the robustBufferAccess feature is not enabled, and any ShaderEXT bound to a stage corresponding 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 commandBuffer is an unprotected command buffer and protectedNoFault is not supported, any resource accessed by bound shaders must not be a protected resource
• If a bound shader accesses a Sampler or ImageView object that enables sampler Y′CBCR conversion, that object must only be used with OpImageSample* or OpImageSparseSample* instructions
• If a bound shader accesses a Sampler or ImageView object that enables sampler Y′CBCR conversion, that object must not use the ConstOffset and Offset operands
• If a ImageView is accessed as a result of this command, then the image view’s viewType must match the Dim operand of the OpTypeImage as described in ???
• If a ImageView is accessed as a result of this command, then the numeric type of the image view’s format and the Sampled Type operand of the OpTypeImage must match
• If a ImageView created with a format other than FORMAT_A8_UNORM_KHR is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the image view’s format
• If a ImageView created with the format FORMAT_A8_UNORM_KHR is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have four components
• If a BufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format
• If a ImageView with a Format that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a ImageView with a Format that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If a BufferView with a Format that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a BufferView with a Format that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If the sparseImageInt64Atomics feature is not enabled, Image objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If the sparseImageInt64Atomics feature is not enabled, Buffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If OpImageWeightedSampleQCOM is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_SAMPLED_IMAGE_BIT_QCOM
• If OpImageWeightedSampleQCOM uses a ImageView as a sample weight image as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_IMAGE_BIT_QCOM
• If OpImageBoxFilterQCOM is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BOX_FILTER_SAMPLED_BIT_QCOM
• If OpImageBlockMatchSSDQCOM is used to read from an ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM is used to read from an ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM or OpImageBlockMatchSSDQCOM is used to read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• If OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchWindowSSDQCOM, OpImageBlockMatchWindowSADQCOM, OpImageBlockMatchGatherSSDQCOM, OpImageBlockMatchGatherSADQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a Sampler as a result of this command, then the sampler must have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If any command other than OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchWindowSSDQCOM, OpImageBlockMatchWindowSADQCOM, OpImageBlockMatchGatherSSDQCOM, OpImageBlockMatchGatherSADQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a Sampler as a result of this command, then the sampler must not have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM instruction is used to read from an ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM instruction is used to read from an ImageView as a result of this command, then the image view’s format must be a single-component format.
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• Any shader invocation executed by this command must terminate
• Any shader group handle referenced by this call must have been queried from the currently bound ray tracing 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 maxPipelineRayRecursionDepth used to create the bound ray tracing pipeline
• commandBuffer must not be a protected command buffer
• If the buffer from which indirectDeviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which indirectDeviceAddress was queried must have been created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
• indirectDeviceAddress must be a multiple of 4
• All device addresses between indirectDeviceAddress and indirectDeviceAddress + sizeof(TraceRaysIndirectCommand2KHR) - 1 must be in the buffer device address range of the same buffer
• The rayTracingPipelineTraceRaysIndirect2 feature must be enabled
• If the bound ray tracing pipeline was created with PIPELINE_CREATE_RAY_TRACING_ALLOW_MOTION_BIT_NV PhysicalDeviceRayTracingMotionBlurFeaturesNV::rayTracingMotionBlurPipelineTraceRaysIndirect feature must be enabled

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance
• 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

'

See Also

VK_KHR_ray_tracing_maintenance1, VK_KHR_ray_tracing_pipeline, CommandBuffer, DeviceAddress

VkTraceRaysIndirectCommand2KHR - Structure specifying the parameters of an indirect trace ray command with indirect shader binding tables

Description

The members of TraceRaysIndirectCommand2KHR have the same meaning as the similarly named parameters of cmdTraceRaysKHR.

Indirect shader binding table buffer parameters must satisfy the same memory alignment and binding requirements as their counterparts in cmdTraceRaysIndirectKHR and cmdTraceRaysKHR.

Valid Usage

• If the buffer from which raygenShaderRecordAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object

• The buffer from which the raygenShaderRecordAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• raygenShaderRecordAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• If the buffer from which missShaderBindingTableAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the missShaderBindingTableAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• missShaderBindingTableAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• missShaderBindingTableStride must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• missShaderBindingTableStride must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the buffer from which hitShaderBindingTableAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the hitShaderBindingTableAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• hitShaderBindingTableAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• hitShaderBindingTableStride must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• hitShaderBindingTableStride must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the buffer from which callableShaderBindingTableAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the callableShaderBindingTableAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• callableShaderBindingTableAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• callableShaderBindingTableStride must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• callableShaderBindingTableStride must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, hitShaderBindingTableAddress must not be zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, hitShaderBindingTableAddress must not be zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR, the shader group handle identified by missShaderBindingTableAddress must not be set to zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, entries in the table identified by hitShaderBindingTableAddress accessed 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 flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, entries in the table identified by hitShaderBindingTableAddress accessed 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 flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, entries in the table identified by hitShaderBindingTableAddress accessed as a result of this command in order to execute an intersection shader must not be set to zero
• Any non-zero hit shader group entries in the table identified by hitShaderBindingTableAddress accessed by this call from a geometry with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR must have been created with RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR
• Any non-zero hit shader group entries in the table identified by hitShaderBindingTableAddress accessed by this call from a geometry with a geometryType of GEOMETRY_TYPE_AABBS_KHR must have been created with RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR
• width must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[0] × PhysicalDeviceLimits::maxComputeWorkGroupSize[0]
• height must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[1] × PhysicalDeviceLimits::maxComputeWorkGroupSize[1]
• depth must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[2] × PhysicalDeviceLimits::maxComputeWorkGroupSize[2]
• width × height × depth must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayDispatchInvocationCount

See Also

VK_KHR_ray_tracing_maintenance1, VK_KHR_ray_tracing_pipeline, DeviceAddress, DeviceSize

VkPhysicalDeviceRayTracingMaintenance1FeaturesKHR - Structure describing the ray tracing maintenance features that can be supported by an implementation

Members

This structure describes the following features:

Description

If the PhysicalDeviceRayTracingMaintenance1FeaturesKHR 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. PhysicalDeviceRayTracingMaintenance1FeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_ray_tracing_maintenance1, Bool32, StructureType