vkCompileDeferredNV - Deferred compilation of shaders

Parameters

• device is the logical device containing the ray tracing pipeline.

• pipeline is the ray tracing pipeline object containing the shaders.
• shader is the index of the shader to compile.

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, Pipeline

vkCreateAccelerationStructureNV - Create a new acceleration structure object

Parameters

• device is the logical device that creates the buffer object.

• pCreateInfo is a pointer to a AccelerationStructureCreateInfoNV structure containing parameters affecting creation of the acceleration structure.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pAccelerationStructure is a pointer to a AccelerationStructureNV handle in which the resulting acceleration structure object is returned.

Description

Similar to other objects in Vulkan, the acceleration structure creation merely creates an object with a specific “shape” as specified by the information in AccelerationStructureInfoNV and compactedSize in pCreateInfo. Populating the data in the object after allocating and binding memory is done with cmdBuildAccelerationStructureNV and cmdCopyAccelerationStructureNV.

Acceleration structure creation uses the count and type information from the geometries, but does not use the data references in the structures.

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid AccelerationStructureCreateInfoNV structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pAccelerationStructure must be a valid pointer to a AccelerationStructureNV handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

See Also

AccelerationStructureCreateInfoNV, AccelerationStructureNV, AllocationCallbacks, Device

vkGetAccelerationStructureMemoryRequirementsNV - Get acceleration structure memory requirements

Parameters

• device is the logical device on which the acceleration structure was created.

• pInfo specifies the acceleration structure to get memory requirements for.
• pMemoryRequirements returns the requested acceleration structure memory requirements.

Valid Usage (Implicit)

See Also

AccelerationStructureMemoryRequirementsInfoNV, Device, MemoryRequirements2KHR

vkCmdCopyAccelerationStructureNV - Copy an acceleration structure

Parameters

• commandBuffer is the command buffer into which the command will be recorded.

• dst is a pointer to the target acceleration structure for the copy.
• src is a pointer to the source acceleration structure for the copy.
• mode is a CopyAccelerationStructureModeKHR value specifying additional operations to perform during the copy.

Valid Usage

• mode must be COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR or COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR

• src must have been built with BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if mode is COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• dst must be a valid AccelerationStructureKHR handle
• src must be a valid AccelerationStructureKHR handle
• mode must be a valid CopyAccelerationStructureModeKHR value
• 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
• Each of commandBuffer, dst, and src must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

AccelerationStructureKHR, CommandBuffer, CopyAccelerationStructureModeKHR

vkCmdBuildAccelerationStructureNV - Build an acceleration structure

Parameters

• commandBuffer is the command buffer into which the command will be recorded.

• pInfo contains the shared information for the acceleration structure’s structure.
• instanceData is the buffer containing an array of AccelerationStructureInstanceKHR structures defining acceleration structures. This parameter must be NULL for bottom level acceleration structures.
• instanceOffset is the offset in bytes (relative to the start of instanceData) at which the instance data is located.
• update specifies whether to update the dst acceleration structure with the data in src.
• dst is a pointer to the target acceleration structure for the build.
• src is a pointer to an existing acceleration structure that is to be used to update the dst acceleration structure.
• scratch is the Buffer that will be used as scratch memory for the build.
• scratchOffset is the offset in bytes relative to the start of scratch that will be used as a scratch memory.

Valid Usage

• geometryCount must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxGeometryCount

• dst must have been created with compatible AccelerationStructureInfoNV where AccelerationStructureInfoNV::type and AccelerationStructureInfoNV::flags are identical, AccelerationStructureInfoNV::instanceCount and AccelerationStructureInfoNV::geometryCount for dst are greater than or equal to the build size and each geometry in AccelerationStructureInfoNV::pGeometries for dst has greater than or equal to the number of vertices, indices, and AABBs
• If update is TRUE, src must not be NULL_HANDLE
• If update is TRUE, src must have been built before with BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_NV set in AccelerationStructureInfoNV::flags
• If update is FALSE, the size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsNV with AccelerationStructureMemoryRequirementsInfoNV::accelerationStructure set to dst and AccelerationStructureMemoryRequirementsInfoNV::type set to ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_NV must be less than or equal to the size of scratch minus scratchOffset
• If update is TRUE, the size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsNV with AccelerationStructureMemoryRequirementsInfoNV::accelerationStructure set to dst and AccelerationStructureMemoryRequirementsInfoNV::type set to ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_NV must be less than or equal to the size of scratch minus scratchOffset
• scratch must have been created with BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
• If instanceData is not NULL_HANDLE, instanceData must have been created with BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
• If update is TRUE, then objects that were previously active must not be made inactive as per https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#acceleration-structure-inactive-prims
• If update is TRUE, then objects that were previously inactive must not be made active as per https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#acceleration-structure-inactive-prims
• If update is TRUE, the src and dst objects must either be the same object or not have any memory aliasing

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pInfo must be a valid pointer to a valid AccelerationStructureInfoNV structure
• If instanceData is not NULL_HANDLE, instanceData must be a valid Buffer handle
• dst must be a valid AccelerationStructureKHR handle
• If src is not NULL_HANDLE, src must be a valid AccelerationStructureKHR handle
• scratch must be a valid Buffer 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
• Each of commandBuffer, dst, instanceData, scratch, and src that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

AccelerationStructureInfoNV, AccelerationStructureKHR, Bool32, Buffer, CommandBuffer, DeviceSize

vkCmdTraceRaysNV - Initialize a ray tracing dispatch

Parameters

• commandBuffer is the command buffer into which the command will be recorded.

• raygenShaderBindingTableBuffer is the buffer object that holds the shader binding table data for the ray generation shader stage.
• raygenShaderBindingOffset is the offset in bytes (relative to raygenShaderBindingTableBuffer) of the ray generation shader being used for the trace.
• missShaderBindingTableBuffer is the buffer object that holds the shader binding table data for the miss shader stage.
• missShaderBindingOffset is the offset in bytes (relative to missShaderBindingTableBuffer) of the miss shader being used for the trace.
• missShaderBindingStride is the size in bytes of each shader binding table record in missShaderBindingTableBuffer.
• hitShaderBindingTableBuffer is the buffer object that holds the shader binding table data for the hit shader stages.
• hitShaderBindingOffset is the offset in bytes (relative to hitShaderBindingTableBuffer) of the hit shader group being used for the trace.
• hitShaderBindingStride is the size in bytes of each shader binding table record in hitShaderBindingTableBuffer.
• callableShaderBindingTableBuffer is the buffer object that holds the shader binding table data for the callable shader stage.
• callableShaderBindingOffset is the offset in bytes (relative to callableShaderBindingTableBuffer) of the callable shader being used for the trace.
• callableShaderBindingStride is the size in bytes of each shader binding table record in callableShaderBindingTableBuffer.
• width is the width of the ray trace query dimensions.
• height is height of the ray trace query dimensions.
• depth is depth of the ray trace query dimensions.

Description

When the command is executed, a ray generation group of width × height × depth rays is assembled.

Valid Usage

• If a ImageView is sampled with FILTER_LINEAR 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 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 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
• 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
• 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 each set n that is statically used by the Pipeline 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 a PipelineLayout that is compatible for set n, with the PipelineLayout used to create the current Pipeline, as described in ???
• For each push constant that is statically used by the Pipeline 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 a PipelineLayout that is compatible for push constants, with the PipelineLayout used to create the current Pipeline, 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
• A valid pipeline must be bound to the pipeline bind point used by this command
• If the Pipeline object bound to the pipeline bind point used by this command requires any dynamic state, that state must have been set for commandBuffer, 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 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 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 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 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 the robust buffer access feature is not enabled, and if the Pipeline 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
• If the robust buffer access feature is not enabled, and if the Pipeline 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
• If commandBuffer is an unprotected command buffer, any resource accessed by the Pipeline object bound to the pipeline bind point used by this command must not be a protected resource
• 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 maxRecursionDepth used to create the bound ray tracing pipeline
• If commandBuffer is a protected command buffer, any resource written to by the Pipeline object bound to the pipeline bind point used by this command must not be an unprotected resource
• If commandBuffer is a protected command buffer, pipeline stages other than the framebuffer-space and compute stages in the Pipeline object bound to the pipeline bind point must not write to any resource
• If raygenShaderBindingTableBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• raygenShaderBindingOffset must be less than the size of raygenShaderBindingTableBuffer
• raygenShaderBindingOffset must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupBaseAlignment
• If missShaderBindingTableBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• missShaderBindingOffset must be less than the size of missShaderBindingTableBuffer
• missShaderBindingOffset must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupBaseAlignment
• If hitShaderBindingTableBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• hitShaderBindingOffset must be less than the size of hitShaderBindingTableBuffer
• hitShaderBindingOffset must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupBaseAlignment
• If callableShaderBindingTableBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• callableShaderBindingOffset must be less than the size of callableShaderBindingTableBuffer
• callableShaderBindingOffset must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupBaseAlignment
• missShaderBindingStride must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupHandleSize
• hitShaderBindingStride must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupHandleSize
• callableShaderBindingStride must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupHandleSize
• missShaderBindingStride must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxShaderGroupStride
• hitShaderBindingStride must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxShaderGroupStride
• callableShaderBindingStride must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxShaderGroupStride
• width must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[0]
• height must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[1]
• depth must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[2]

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• raygenShaderBindingTableBuffer must be a valid Buffer handle
• If missShaderBindingTableBuffer is not NULL_HANDLE, missShaderBindingTableBuffer must be a valid Buffer handle
• If hitShaderBindingTableBuffer is not NULL_HANDLE, hitShaderBindingTableBuffer must be a valid Buffer handle
• If callableShaderBindingTableBuffer is not NULL_HANDLE, callableShaderBindingTableBuffer must be a valid Buffer 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
• Each of callableShaderBindingTableBuffer, commandBuffer, hitShaderBindingTableBuffer, missShaderBindingTableBuffer, and raygenShaderBindingTableBuffer that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

Buffer, CommandBuffer, DeviceSize

vkGetAccelerationStructureHandleNV - Get opaque acceleration structure handle

Parameters

• device is the logical device that owns the acceleration structures.

• accelerationStructure is the acceleration structure.
• dataSize is the size in bytes of the buffer pointed to by pData.
• pData is a pointer to a user-allocated buffer where the results will be written.

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AccelerationStructureKHR, Device

vkCreateRayTracingPipelinesNV - Creates a new ray tracing pipeline object

Parameters

• device is the logical device that creates the ray tracing pipelines.

• pipelineCache is either NULL_HANDLE, indicating that pipeline caching is disabled, or the handle of a valid pipeline cache object, in which case use of that cache is enabled for the duration of the command.
• createInfoCount is the length of the pCreateInfos and pPipelines arrays.
• pCreateInfos is a pointer to an array of RayTracingPipelineCreateInfoNV structures.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pPipelines is a pointer to an array in which the resulting ray tracing pipeline objects are returned.

Valid Usage

• If the flags member of any element of pCreateInfos contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and the basePipelineIndex member of that same element is not -1, basePipelineIndex must be less than the index into pCreateInfos that corresponds to that element

• If the flags member of any element of pCreateInfos contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline must have been created with the PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set
• If pipelineCache was created with PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT, host access to pipelineCache must be externally synchronized

Valid Usage (Implicit)

• device must be a valid Device handle

• If pipelineCache is not NULL_HANDLE, pipelineCache must be a valid PipelineCache handle
• pCreateInfos must be a valid pointer to an array of createInfoCount valid RayTracingPipelineCreateInfoNV structures
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pPipelines must be a valid pointer to an array of createInfoCount Pipeline handles
• createInfoCount must be greater than 0
• If pipelineCache is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS
• PIPELINE_COMPILE_REQUIRED_EXT

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_SHADER_NV

See Also

AllocationCallbacks, Device, Pipeline, PipelineCache, RayTracingPipelineCreateInfoNV

VkRayTracingShaderGroupCreateInfoNV - Structure specifying shaders in a shader group

Valid Usage

• If type is RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV then generalShader must be a valid index into RayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_RAYGEN_BIT_NV, SHADER_STAGE_MISS_BIT_NV, or SHADER_STAGE_CALLABLE_BIT_NV

• If type is RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV then closestHitShader, anyHitShader, and intersectionShader must be SHADER_UNUSED_NV
• If type is RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV then intersectionShader must be a valid index into RayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_INTERSECTION_BIT_NV
• If type is RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV then intersectionShader must be SHADER_UNUSED_NV
• closestHitShader must be either SHADER_UNUSED_NV or a valid index into RayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_CLOSEST_HIT_BIT_NV
• anyHitShader must be either SHADER_UNUSED_NV or a valid index into RayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_ANY_HIT_BIT_NV

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_NV

• pNext must be NULL
• type must be a valid RayTracingShaderGroupTypeKHR value

See Also

RayTracingPipelineCreateInfoNV, RayTracingShaderGroupTypeKHR, StructureType

VkRayTracingPipelineCreateInfoNV - Structure specifying parameters of a newly created ray tracing pipeline

Description

The parameters basePipelineHandle and basePipelineIndex are described in more detail in Pipeline Derivatives.

Valid Usage

• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineIndex is -1, basePipelineHandle must be a valid handle to a ray tracing Pipeline

• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineHandle is NULL_HANDLE, basePipelineIndex must be a valid index into the calling command’s pCreateInfos parameter
• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineIndex is not -1, basePipelineHandle must be NULL_HANDLE
• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineHandle is not NULL_HANDLE, basePipelineIndex must be -1
• The stage member of at least one element of pStages must be SHADER_STAGE_RAYGEN_BIT_KHR
• The shader code for the entry points identified by pStages, and the rest of the state identified by this structure must adhere to the pipeline linking rules described in the Shader Interfaces chapter
• layout must be consistent with all shaders specified in pStages
• The number of resources in layout accessible to each shader stage that is used by the pipeline must be less than or equal to PhysicalDeviceLimits::maxPerStageResources
• flags must not include PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
• If the pipelineCreationCacheControl feature is not enabled, flags must not include PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT or PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT
• flags must not include PIPELINE_CREATE_LIBRARY_BIT_KHR
• maxRecursionDepth must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxRecursionDepth
• flags must not include PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
• flags must not include both PIPELINE_CREATE_DEFER_COMPILE_BIT_NV and PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT at the same time

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_NV

• pNext must be NULL or a pointer to a valid instance of PipelineCreationFeedbackCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of PipelineCreateFlagBits values
• pStages must be a valid pointer to an array of stageCount valid PipelineShaderStageCreateInfo structures
• pGroups must be a valid pointer to an array of groupCount valid RayTracingShaderGroupCreateInfoNV structures
• layout must be a valid PipelineLayout handle
• stageCount must be greater than 0
• groupCount must be greater than 0
• Both of basePipelineHandle, and layout that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

Pipeline, PipelineCreateFlags, PipelineLayout, PipelineShaderStageCreateInfo, RayTracingShaderGroupCreateInfoNV, StructureType, createRayTracingPipelinesNV

VkGeometryTrianglesNV - Structure specifying a triangle geometry in a bottom-level acceleration structure

Description

If indexType is INDEX_TYPE_NONE_NV, then this structure describes a set of triangles determined by vertexCount. Otherwise, this structure describes a set of indexed triangles determined by indexCount.

Valid Usage

• vertexOffset must be less than the size of vertexData

• vertexOffset must be a multiple of the component size of vertexFormat
• vertexFormat must be one of FORMAT_R32G32B32_SFLOAT, FORMAT_R32G32_SFLOAT, FORMAT_R16G16B16_SFLOAT, FORMAT_R16G16_SFLOAT, FORMAT_R16G16_SNORM, or FORMAT_R16G16B16_SNORM
• indexOffset must be less than the size of indexData
• indexOffset must be a multiple of the element size of indexType
• indexType must be INDEX_TYPE_UINT16, INDEX_TYPE_UINT32, or INDEX_TYPE_NONE_NV
• indexData must be NULL_HANDLE if indexType is INDEX_TYPE_NONE_NV
• indexData must be a valid Buffer handle if indexType is not INDEX_TYPE_NONE_NV
• indexCount must be 0 if indexType is INDEX_TYPE_NONE_NV
• transformOffset must be less than the size of transformData
• transformOffset must be a multiple of 16

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_GEOMETRY_TRIANGLES_NV

• pNext must be NULL
• If vertexData is not NULL_HANDLE, vertexData must be a valid Buffer handle
• vertexFormat must be a valid Format value
• If indexData is not NULL_HANDLE, indexData must be a valid Buffer handle
• indexType must be a valid IndexType value
• If transformData is not NULL_HANDLE, transformData must be a valid Buffer handle
• Each of indexData, transformData, and vertexData that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

Buffer, DeviceSize, Format, GeometryDataNV, IndexType, StructureType

VkGeometryAABBNV - Structure specifying axis-aligned bounding box geometry in a bottom-level acceleration structure

Description

The AABB data in memory is six 32-bit floats consisting of the minimum x, y, and z values followed by the maximum x, y, and z values.

Valid Usage

• offset must be less than the size of aabbData

• offset must be a multiple of 8
• stride must be a multiple of 8

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_GEOMETRY_AABB_NV

• pNext must be NULL
• If aabbData is not NULL_HANDLE, aabbData must be a valid Buffer handle

See Also

Buffer, DeviceSize, GeometryDataNV, StructureType

VkGeometryDataNV - Structure specifying geometry in a bottom-level acceleration structure

Valid Usage (Implicit)

See Also

GeometryAABBNV, GeometryNV, GeometryTrianglesNV

VkGeometryNV - Structure specifying a geometry in a bottom-level acceleration structure

Valid Usage (Implicit)

See Also

AccelerationStructureInfoNV, GeometryDataNV, GeometryFlagsKHR, GeometryTypeKHR, StructureType

VkAccelerationStructureInfoNV - Structure specifying the parameters of acceleration structure object

Description

AccelerationStructureInfoNV contains information that is used both for acceleration structure creation with createAccelerationStructureNV and in combination with the actual geometric data to build the acceleration structure with cmdBuildAccelerationStructureNV.

Valid Usage

• geometryCount must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxGeometryCount

• instanceCount must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxInstanceCount
• The total number of triangles in all geometries must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxTriangleCount
• If type is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_NV then geometryCount must be 0
• If type is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV then instanceCount must be 0
• If type is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV then the geometryType member of each geometry in pGeometries must be the same
• flags must be a valid combination of BuildAccelerationStructureFlagBitsNV values
• If flags has the BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_NV bit set, then it must not have the BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_NV bit set
• scratch must have been created with BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
• If instanceData is not NULL_HANDLE, instanceData must have been created with BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_INFO_NV

• pNext must be NULL
• type must be a valid AccelerationStructureTypeNV value
• flags must be 0
• If geometryCount is not 0, pGeometries must be a valid pointer to an array of geometryCount valid GeometryNV structures

See Also

AccelerationStructureCreateInfoNV, AccelerationStructureTypeNV, BuildAccelerationStructureFlagsNV, GeometryNV, StructureType, cmdBuildAccelerationStructureNV

VkAccelerationStructureCreateInfoNV - Structure specifying the parameters of a newly created acceleration structure object

Valid Usage

• If compactedSize is not 0 then both info.geometryCount and info.instanceCount must be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_NV

• pNext must be NULL
• info must be a valid AccelerationStructureInfoNV structure

See Also

AccelerationStructureInfoNV, DeviceSize, StructureType, createAccelerationStructureNV

VkAccelerationStructureMemoryRequirementsInfoNV - Structure specifying acceleration to query for memory requirements

Valid Usage (Implicit)

See Also

AccelerationStructureMemoryRequirementsTypeNV, AccelerationStructureNV, StructureType, getAccelerationStructureMemoryRequirementsNV

VkPhysicalDeviceRayTracingPropertiesNV - Properties of the physical device for ray tracing

Description

If the PhysicalDeviceRayTracingPropertiesNV structure is included in the pNext chain of PhysicalDeviceProperties2, it is filled with the implementation-dependent limits.

Limits specified by this structure must match those specified with the same name in PhysicalDeviceRayTracingPropertiesKHR.

Valid Usage (Implicit)

See Also

StructureType

VkAccelerationStructureKHR - Opaque handle to an acceleration structure object

See Also

AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureDeviceAddressInfoKHR, AccelerationStructureMemoryRequirementsInfoKHR, BindAccelerationStructureMemoryInfoKHR, CopyAccelerationStructureInfoKHR, CopyAccelerationStructureToMemoryInfoKHR, CopyMemoryToAccelerationStructureInfoKHR, WriteDescriptorSetAccelerationStructureKHR, cmdBuildAccelerationStructureNV, cmdCopyAccelerationStructureNV, cmdWriteAccelerationStructuresPropertiesKHR, cmdWriteAccelerationStructuresPropertiesNV, createAccelerationStructureKHR, destroyAccelerationStructureKHR, destroyAccelerationStructureNV, getAccelerationStructureHandleNV, writeAccelerationStructuresPropertiesKHR

VkBindAccelerationStructureMemoryInfoKHR - Structure specifying acceleration structure memory binding

Valid Usage

• accelerationStructure must not already be backed by a memory object

• memoryOffset must be less than the size of memory
• memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsKHR with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR
• memoryOffset must be an integer multiple of the alignment member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsKHR with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR
• The size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsKHR with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR must be less than or equal to the size of memory minus memoryOffset

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_KHR

• pNext must be NULL
• accelerationStructure must be a valid AccelerationStructureKHR handle
• memory must be a valid DeviceMemory handle
• If deviceIndexCount is not 0, pDeviceIndices must be a valid pointer to an array of deviceIndexCount uint32_t values
• Both of accelerationStructure, and memory must have been created, allocated, or retrieved from the same Device

See Also

AccelerationStructureKHR, DeviceMemory, DeviceSize, StructureType, bindAccelerationStructureMemoryKHR, bindAccelerationStructureMemoryNV

VkWriteDescriptorSetAccelerationStructureKHR - Structure specifying acceleration structure descriptor info

Valid Usage

• accelerationStructureCount must be equal to descriptorCount in the extended structure

• Each acceleration structure in pAccelerationStructures must have been created with ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR

• pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid AccelerationStructureKHR handles
• accelerationStructureCount must be greater than 0

See Also

AccelerationStructureKHR, StructureType

VkAabbPositionsKHR - Structure specifying two opposing corners of an axis-aligned bounding box

Valid Usage

See Also

No cross-references are available

VkTransformMatrixKHR - Structure specifying a 3x4 affine transformation matrix

See Also

AccelerationStructureInstanceKHR

VkAccelerationStructureInstanceKHR - Structure specifying a single acceleration structure instance for building into an acceleration structure geometry

Description

The C language spec does not define the ordering of bit-fields, but in practice, this struct produces the correct layout with existing compilers. The intended bit pattern is for the following:

If a compiler produces code that diverges from that pattern, applications must employ another method to set values according to the correct bit pattern.

Valid Usage (Implicit)

See Also

GeometryInstanceFlagsKHR, TransformMatrixKHR

vkDestroyAccelerationStructureKHR - Destroy an acceleration structure object

Parameters

• device is the logical device that destroys the buffer.

• accelerationStructure is the acceleration structure to destroy.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.

Valid Usage

• All submitted commands that refer to accelerationStructure must have completed execution

• If AllocationCallbacks were provided when accelerationStructure was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when accelerationStructure was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If accelerationStructure is not NULL_HANDLE, accelerationStructure must be a valid AccelerationStructureKHR handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If accelerationStructure is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to accelerationStructure must be externally synchronized

See Also

AccelerationStructureKHR, AllocationCallbacks, Device

vkBindAccelerationStructureMemoryKHR - Bind acceleration structure memory

Parameters

• device is the logical device that owns the acceleration structures and memory.

• bindInfoCount is the number of elements in pBindInfos.
• pBindInfos is a pointer to an array of BindAccelerationStructureMemoryInfoKHR structures describing acceleration structures and memory to bind.

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

BindAccelerationStructureMemoryInfoKHR, Device

vkCmdWriteAccelerationStructuresPropertiesKHR - Write acceleration structure result parameters to query results.

Parameters

• commandBuffer is the command buffer into which the command will be recorded.

• accelerationStructureCount is the count of acceleration structures for which to query the property.
• pAccelerationStructures is a pointer to an array of existing previously built acceleration structures.
• queryType is a QueryType value specifying the type of queries managed by the pool.
• queryPool is the query pool that will manage the results of the query.
• firstQuery is the first query index within the query pool that will contain the accelerationStructureCount number of results.

Valid Usage

• queryPool must have been created with a queryType matching queryType

• The queries identified by queryPool and firstQuery must be unavailable
• All acceleration structures in accelerationStructures must have been built with BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR
• queryType must be QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR or QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid AccelerationStructureKHR handles
• queryType must be a valid QueryType value
• queryPool must be a valid QueryPool 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
• accelerationStructureCount must be greater than 0
• Each of commandBuffer, queryPool, and the elements of pAccelerationStructures must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

AccelerationStructureKHR, CommandBuffer, QueryPool, QueryType