Package org.lwjgl.vulkan

Class KHRAccelerationStructure

java.lang.Object

org.lwjgl.vulkan.KHRAccelerationStructure

public class KHRAccelerationStructure
extends java.lang.Object

In order to be efficient, rendering techniques such as ray tracing need a quick way to identify which primitives may be intersected by a ray traversing the geometries. Acceleration structures are the most common way to represent the geometry spatially sorted, in order to quickly identify such potential intersections.

This extension adds new functionalities:

• Acceleration structure objects and build commands
• Structures to describe geometry inputs to acceleration structure builds
• Acceleration structure copy commands

VK_KHR_acceleration_structure

Name String

VK_KHR_acceleration_structure

Extension Type

Device extension

Registered Extension Number

151

Revision

13

Extension and Version Dependencies

• Requires Vulkan 1.1
• Requires VK_EXT_descriptor_indexing
• Requires VK_KHR_buffer_device_address
• Requires VK_KHR_deferred_host_operations

Contact

• Daniel Koch dgkoch

Other Extension Metadata

Last Modified Date

2021-09-30

Contributors

• Samuel Bourasseau, Adobe
• Matthäus Chajdas, AMD
• Greg Grebe, AMD
• Nicolai Hähnle, AMD
• Tobias Hector, AMD
• Dave Oldcorn, AMD
• Skyler Saleh, AMD
• Mathieu Robart, Arm
• Marius Bjorge, Arm
• Tom Olson, Arm
• Sebastian Tafuri, EA
• Henrik Rydgard, Embark
• Juan Cañada, Epic Games
• Patrick Kelly, Epic Games
• Yuriy O’Donnell, Epic Games
• Michael Doggett, Facebook/Oculus
• Ricardo Garcia, Igalia
• Andrew Garrard, Imagination
• Don Scorgie, Imagination
• Dae Kim, Imagination
• Joshua Barczak, Intel
• Slawek Grajewski, Intel
• Jeff Bolz, NVIDIA
• Pascal Gautron, NVIDIA
• Daniel Koch, NVIDIA
• Christoph Kubisch, NVIDIA
• Ashwin Lele, NVIDIA
• Robert Stepinski, NVIDIA
• Martin Stich, NVIDIA
• Nuno Subtil, NVIDIA
• Eric Werness, NVIDIA
• Jon Leech, Khronos
• Jeroen van Schijndel, OTOY
• Juul Joosten, OTOY
• Alex Bourd, Qualcomm
• Roman Larionov, Qualcomm
• David McAllister, Qualcomm
• Lewis Gordon, Samsung
• Ralph Potter, Samsung
• Jasper Bekkers, Traverse Research
• Jesse Barker, Unity
• Baldur Karlsson, Valve

Field Summary

Fields

Modifier and Type	Field	Description
static int	VK_ACCELERATION_STRUCTURE_BUILD_TYPE_DEVICE_KHR VK_ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_KHR VK_ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR	VkAccelerationStructureBuildTypeKHR - Acceleration structure build type
static int	VK_ACCELERATION_STRUCTURE_COMPATIBILITY_COMPATIBLE_KHR VK_ACCELERATION_STRUCTURE_COMPATIBILITY_INCOMPATIBLE_KHR	VkAccelerationStructureCompatibilityKHR - Acceleration structure compatibility
static int	VK_ACCELERATION_STRUCTURE_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR	VkAccelerationStructureCreateFlagBitsKHR - Bitmask specifying additional creation parameters for acceleration structure
static int	VK_ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR VK_ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR VK_ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR	VkAccelerationStructureTypeKHR - Type of acceleration structure
static int	VK_ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR VK_ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR	Extends VkAccessFlagBits.
static int	VK_BUFFER_USAGE_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR VK_BUFFER_USAGE_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR	Extends VkBufferUsageFlagBits.
static int	VK_BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR VK_BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR VK_BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR	VkBuildAccelerationStructureFlagBitsKHR - Bitmask specifying additional parameters for acceleration structure builds
static int	VK_BUILD_ACCELERATION_STRUCTURE_MODE_BUILD_KHR VK_BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR	VkBuildAccelerationStructureModeKHR - Enum specifying the type of build operation to perform
static int	VK_BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR VK_BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR	VkBuildAccelerationStructureFlagBitsKHR - Bitmask specifying additional parameters for acceleration structure builds
static int	VK_COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR VK_COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR VK_COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR VK_COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR	VkCopyAccelerationStructureModeKHR - Acceleration structure copy mode
static int	VK_DEBUG_REPORT_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR_EXT	Extends VkDebugReportObjectTypeEXT.
static int	VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR	Extends VkDescriptorType.
static long	VK_FORMAT_FEATURE_2_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR	Extends VkFormatFeatureFlagBits2.
static int	VK_FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR	Extends VkFormatFeatureFlagBits.
static int	VK_GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR VK_GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR VK_GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR VK_GEOMETRY_INSTANCE_TRIANGLE_FLIP_FACING_BIT_KHR VK_GEOMETRY_INSTANCE_TRIANGLE_FRONT_COUNTERCLOCKWISE_BIT_KHR	VkGeometryInstanceFlagBitsKHR - Instance flag bits
static int	VK_GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT_KHR VK_GEOMETRY_OPAQUE_BIT_KHR	VkGeometryFlagBitsKHR - Bitmask specifying additional parameters for a geometry
static int	VK_GEOMETRY_TYPE_AABBS_KHR VK_GEOMETRY_TYPE_INSTANCES_KHR VK_GEOMETRY_TYPE_TRIANGLES_KHR	VkGeometryTypeKHR - Enum specifying which type of geometry is provided
static int	VK_INDEX_TYPE_NONE_KHR	Extends VkIndexType.
static java.lang.String	VK_KHR_ACCELERATION_STRUCTURE_EXTENSION_NAME	The extension name.
static int	VK_KHR_ACCELERATION_STRUCTURE_SPEC_VERSION	The extension specification version.
static int	VK_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR	Extends VkObjectType.
static int	VK_PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR	Extends VkPipelineStageFlagBits.
static int	VK_QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR VK_QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR	Extends VkQueryType.
static int	VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_GEOMETRY_INFO_KHR VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_SIZES_INFO_KHR VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_KHR VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_DEVICE_ADDRESS_INFO_KHR VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_AABBS_DATA_KHR VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_KHR VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_TRIANGLES_DATA_KHR VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_VERSION_INFO_KHR VK_STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_INFO_KHR VK_STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR VK_STRUCTURE_TYPE_COPY_MEMORY_TO_ACCELERATION_STRUCTURE_INFO_KHR VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ACCELERATION_STRUCTURE_FEATURES_KHR VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ACCELERATION_STRUCTURE_PROPERTIES_KHR VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkBuildAccelerationStructuresKHR(org.lwjgl.vulkan.VkDevice device, long deferredOperation, int infoCount, long pInfos, long ppBuildRangeInfos)	Unsafe version of: BuildAccelerationStructuresKHR
static void	nvkCmdBuildAccelerationStructuresIndirectKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int infoCount, long pInfos, long pIndirectDeviceAddresses, long pIndirectStrides, long ppMaxPrimitiveCounts)	Unsafe version of: CmdBuildAccelerationStructuresIndirectKHR
static void	nvkCmdBuildAccelerationStructuresKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int infoCount, long pInfos, long ppBuildRangeInfos)	Unsafe version of: CmdBuildAccelerationStructuresKHR
static void	nvkCmdCopyAccelerationStructureKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pInfo)	Unsafe version of: CmdCopyAccelerationStructureKHR
static void	nvkCmdCopyAccelerationStructureToMemoryKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pInfo)	Unsafe version of: CmdCopyAccelerationStructureToMemoryKHR
static void	nvkCmdCopyMemoryToAccelerationStructureKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pInfo)	Unsafe version of: CmdCopyMemoryToAccelerationStructureKHR
static void	nvkCmdWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int accelerationStructureCount, long pAccelerationStructures, int queryType, long queryPool, int firstQuery)	Unsafe version of: CmdWriteAccelerationStructuresPropertiesKHR
static int	nvkCopyAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, long deferredOperation, long pInfo)	Unsafe version of: CopyAccelerationStructureKHR
static int	nvkCopyAccelerationStructureToMemoryKHR(org.lwjgl.vulkan.VkDevice device, long deferredOperation, long pInfo)	Unsafe version of: CopyAccelerationStructureToMemoryKHR
static int	nvkCopyMemoryToAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, long deferredOperation, long pInfo)	Unsafe version of: CopyMemoryToAccelerationStructureKHR
static int	nvkCreateAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, long pCreateInfo, long pAllocator, long pAccelerationStructure)	Unsafe version of: CreateAccelerationStructureKHR
static void	nvkDestroyAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, long accelerationStructure, long pAllocator)	Unsafe version of: DestroyAccelerationStructureKHR
static void	nvkGetAccelerationStructureBuildSizesKHR(org.lwjgl.vulkan.VkDevice device, int buildType, long pBuildInfo, long pMaxPrimitiveCounts, long pSizeInfo)	Unsafe version of: GetAccelerationStructureBuildSizesKHR
static long	nvkGetAccelerationStructureDeviceAddressKHR(org.lwjgl.vulkan.VkDevice device, long pInfo)	Unsafe version of: GetAccelerationStructureDeviceAddressKHR
static void	nvkGetDeviceAccelerationStructureCompatibilityKHR(org.lwjgl.vulkan.VkDevice device, long pVersionInfo, long pCompatibility)	Unsafe version of: GetDeviceAccelerationStructureCompatibilityKHR
static int	nvkWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkDevice device, int accelerationStructureCount, long pAccelerationStructures, int queryType, long dataSize, long pData, long stride)	Unsafe version of: WriteAccelerationStructuresPropertiesKHR
static int	vkBuildAccelerationStructuresKHR(org.lwjgl.vulkan.VkDevice device, long deferredOperation, VkAccelerationStructureBuildGeometryInfoKHR.Buffer pInfos, org.lwjgl.PointerBuffer ppBuildRangeInfos)	Build an acceleration structure on the host.
static void	vkCmdBuildAccelerationStructuresIndirectKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkAccelerationStructureBuildGeometryInfoKHR.Buffer pInfos, long[] pIndirectDeviceAddresses, int[] pIndirectStrides, org.lwjgl.PointerBuffer ppMaxPrimitiveCounts)	Array version of: CmdBuildAccelerationStructuresIndirectKHR
static void	vkCmdBuildAccelerationStructuresIndirectKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkAccelerationStructureBuildGeometryInfoKHR.Buffer pInfos, java.nio.LongBuffer pIndirectDeviceAddresses, java.nio.IntBuffer pIndirectStrides, org.lwjgl.PointerBuffer ppMaxPrimitiveCounts)	Build an acceleration structure with some parameters provided on the device.
static void	vkCmdBuildAccelerationStructuresKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkAccelerationStructureBuildGeometryInfoKHR.Buffer pInfos, org.lwjgl.PointerBuffer ppBuildRangeInfos)	Build an acceleration structure.
static void	vkCmdCopyAccelerationStructureKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkCopyAccelerationStructureInfoKHR pInfo)	Copy an acceleration structure.
static void	vkCmdCopyAccelerationStructureToMemoryKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkCopyAccelerationStructureToMemoryInfoKHR pInfo)	Copy an acceleration structure to device memory.
static void	vkCmdCopyMemoryToAccelerationStructureKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkCopyMemoryToAccelerationStructureInfoKHR pInfo)	Copy device memory to an acceleration structure.
static void	vkCmdWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long[] pAccelerationStructures, int queryType, long queryPool, int firstQuery)	Array version of: CmdWriteAccelerationStructuresPropertiesKHR
static void	vkCmdWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, java.nio.LongBuffer pAccelerationStructures, int queryType, long queryPool, int firstQuery)	Write acceleration structure result parameters to query results.
static int	vkCopyAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, long deferredOperation, VkCopyAccelerationStructureInfoKHR pInfo)	Copy an acceleration structure on the host.
static int	vkCopyAccelerationStructureToMemoryKHR(org.lwjgl.vulkan.VkDevice device, long deferredOperation, VkCopyAccelerationStructureToMemoryInfoKHR pInfo)	Serialize an acceleration structure on the host.
static int	vkCopyMemoryToAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, long deferredOperation, VkCopyMemoryToAccelerationStructureInfoKHR pInfo)	Deserialize an acceleration structure on the host.
static int	vkCreateAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, VkAccelerationStructureCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pAccelerationStructure)	Array version of: CreateAccelerationStructureKHR
static int	vkCreateAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, VkAccelerationStructureCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pAccelerationStructure)	Create a new acceleration structure object.
static void	vkDestroyAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device, long accelerationStructure, VkAllocationCallbacks pAllocator)	Destroy an acceleration structure object.
static void	vkGetAccelerationStructureBuildSizesKHR(org.lwjgl.vulkan.VkDevice device, int buildType, VkAccelerationStructureBuildGeometryInfoKHR pBuildInfo, int[] pMaxPrimitiveCounts, VkAccelerationStructureBuildSizesInfoKHR pSizeInfo)	Array version of: GetAccelerationStructureBuildSizesKHR
static void	vkGetAccelerationStructureBuildSizesKHR(org.lwjgl.vulkan.VkDevice device, int buildType, VkAccelerationStructureBuildGeometryInfoKHR pBuildInfo, java.nio.IntBuffer pMaxPrimitiveCounts, VkAccelerationStructureBuildSizesInfoKHR pSizeInfo)	Retrieve the required size for an acceleration structure.
static long	vkGetAccelerationStructureDeviceAddressKHR(org.lwjgl.vulkan.VkDevice device, VkAccelerationStructureDeviceAddressInfoKHR pInfo)	Query an address of a acceleration structure.
static void	vkGetDeviceAccelerationStructureCompatibilityKHR(org.lwjgl.vulkan.VkDevice device, VkAccelerationStructureVersionInfoKHR pVersionInfo, int[] pCompatibility)	Array version of: GetDeviceAccelerationStructureCompatibilityKHR
static void	vkGetDeviceAccelerationStructureCompatibilityKHR(org.lwjgl.vulkan.VkDevice device, VkAccelerationStructureVersionInfoKHR pVersionInfo, java.nio.IntBuffer pCompatibility)	Check if a serialized acceleration structure is compatible with the current device.
static int	vkWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkDevice device, long[] pAccelerationStructures, int queryType, java.nio.ByteBuffer pData, long stride)	Array version of: WriteAccelerationStructuresPropertiesKHR
static int	vkWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkDevice device, java.nio.LongBuffer pAccelerationStructures, int queryType, java.nio.ByteBuffer pData, long stride)	Query acceleration structure meta-data on the host.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_KHR_ACCELERATION_STRUCTURE_SPEC_VERSION

The extension specification version.

VK_KHR_ACCELERATION_STRUCTURE_EXTENSION_NAME

The extension name.

VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_GEOMETRY_INFO_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_DEVICE_ADDRESS_INFO_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_AABBS_DATA_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_TRIANGLES_DATA_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_VERSION_INFO_KHR, VK_STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_INFO_KHR, VK_STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR, VK_STRUCTURE_TYPE_COPY_MEMORY_TO_ACCELERATION_STRUCTURE_INFO_KHR, VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ACCELERATION_STRUCTURE_FEATURES_KHR, VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ACCELERATION_STRUCTURE_PROPERTIES_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_KHR, VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_SIZES_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_GEOMETRY_INFO_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_DEVICE_ADDRESS_INFO_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_AABBS_DATA_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_TRIANGLES_DATA_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_VERSION_INFO_KHR
• STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_INFO_KHR
• STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR
• STRUCTURE_TYPE_COPY_MEMORY_TO_ACCELERATION_STRUCTURE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_ACCELERATION_STRUCTURE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_ACCELERATION_STRUCTURE_PROPERTIES_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_KHR
• STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_SIZES_INFO_KHR

VK_PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR

Extends VkPipelineStageFlagBits.

VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR

Extends VkDescriptorType.

VK_ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR, VK_ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR

Extends VkAccessFlagBits.

Enum values:

• ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR
• ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR

VK_QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR, VK_QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR

Extends VkQueryType.

Enum values:

• QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR
• QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR

VK_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR

Extends VkObjectType.

VK_DEBUG_REPORT_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR_EXT

Extends VkDebugReportObjectTypeEXT.

VK_INDEX_TYPE_NONE_KHR

Extends VkIndexType.

VK_FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR

Extends VkFormatFeatureFlagBits.

VK_BUFFER_USAGE_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR, VK_BUFFER_USAGE_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR

Extends VkBufferUsageFlagBits.

Enum values:

• BUFFER_USAGE_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR
• BUFFER_USAGE_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR

VK_FORMAT_FEATURE_2_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR

Extends VkFormatFeatureFlagBits2.

VK_ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR, VK_ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR, VK_ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR

VkAccelerationStructureTypeKHR - Type of acceleration structure

Description

• ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR is a top-level acceleration structure containing instance data referring to bottom-level acceleration structures.
• ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR is a bottom-level acceleration structure containing the AABBs or geometry to be intersected.
• ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR is an acceleration structure whose type is determined at build time used for special circumstances.

See Also

VkAccelerationStructureBuildGeometryInfoKHR, VkAccelerationStructureCreateInfoKHR, VkAccelerationStructureInfoNV

VK_BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR, VK_BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR, VK_BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR, VK_BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR, VK_BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR

VkBuildAccelerationStructureFlagBitsKHR - Bitmask specifying additional parameters for acceleration structure builds

Description

• BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR indicates that the specified acceleration structure can be updated with a mode of BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR in VkAccelerationStructureBuildGeometryInfoKHR or an update of TRUE in CmdBuildAccelerationStructureNV .
• BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR indicates that the specified acceleration structure can act as the source for a copy acceleration structure command with mode of COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR to produce a compacted acceleration structure.
• BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR indicates that the given acceleration structure build should prioritize trace performance over build time.
• BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR indicates that the given acceleration structure build should prioritize build time over trace performance.
• BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR indicates that this acceleration structure should minimize the size of the scratch memory and the final result acceleration structure, potentially at the expense of build time or trace performance.

Note

BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR and BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR may take more time and memory than a normal build, and so should only be used when those features are needed.

VK_BUILD_ACCELERATION_STRUCTURE_MODE_BUILD_KHR, VK_BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR

VkBuildAccelerationStructureModeKHR - Enum specifying the type of build operation to perform

Description

• BUILD_ACCELERATION_STRUCTURE_MODE_BUILD_KHR specifies that the destination acceleration structure will be built using the specified geometries.
• BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR specifies that the destination acceleration structure will be built using data in a source acceleration structure, updated by the specified geometries.

See Also

VkAccelerationStructureBuildGeometryInfoKHR

VK_GEOMETRY_TYPE_TRIANGLES_KHR, VK_GEOMETRY_TYPE_AABBS_KHR, VK_GEOMETRY_TYPE_INSTANCES_KHR

VkGeometryTypeKHR - Enum specifying which type of geometry is provided

Description

• GEOMETRY_TYPE_TRIANGLES_KHR specifies a geometry type consisting of triangles.
• GEOMETRY_TYPE_AABBS_KHR specifies a geometry type consisting of axis-aligned bounding boxes.
• GEOMETRY_TYPE_INSTANCES_KHR specifies a geometry type consisting of acceleration structure instances.

See Also

VkAccelerationStructureGeometryKHR, VkGeometryNV

VK_GEOMETRY_OPAQUE_BIT_KHR, VK_GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT_KHR

VkGeometryFlagBitsKHR - Bitmask specifying additional parameters for a geometry

Description

• GEOMETRY_OPAQUE_BIT_KHR indicates that this geometry does not invoke the any-hit shaders even if present in a hit group.
• GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT_KHR indicates that the implementation must only call the any-hit shader a single time for each primitive in this geometry. If this bit is absent an implementation may invoke the any-hit shader more than once for this geometry.

VK_ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_KHR, VK_ACCELERATION_STRUCTURE_BUILD_TYPE_DEVICE_KHR, VK_ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR

VkAccelerationStructureBuildTypeKHR - Acceleration structure build type

Description

• ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_KHR requests the memory requirement for operations performed by the host.
• ACCELERATION_STRUCTURE_BUILD_TYPE_DEVICE_KHR requests the memory requirement for operations performed by the device.
• ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR requests the memory requirement for operations performed by either the host, or the device.

See Also

GetAccelerationStructureBuildSizesKHR

VK_GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR, VK_GEOMETRY_INSTANCE_TRIANGLE_FLIP_FACING_BIT_KHR, VK_GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR, VK_GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR, VK_GEOMETRY_INSTANCE_TRIANGLE_FRONT_COUNTERCLOCKWISE_BIT_KHR

VkGeometryInstanceFlagBitsKHR - Instance flag bits

Description

• GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR disables face culling for this instance.
• GEOMETRY_INSTANCE_TRIANGLE_FLIP_FACING_BIT_KHR indicates that the facing determination for geometry in this instance is inverted. Because the facing is determined in object space, an instance transform does not change the winding, but a geometry transform does.
• GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR causes this instance to act as though GEOMETRY_OPAQUE_BIT_KHR were specified on all geometries referenced by this instance. This behavior can be overridden by the SPIR-V NoOpaqueKHR ray flag.
• GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR causes this instance to act as though GEOMETRY_OPAQUE_BIT_KHR were not specified on all geometries referenced by this instance. This behavior can be overridden by the SPIR-V OpaqueKHR ray flag.

GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR and GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR must not be used in the same flag.

Enum values:

• GEOMETRY_INSTANCE_TRIANGLE_FRONT_COUNTERCLOCKWISE_BIT_KHR

VK_ACCELERATION_STRUCTURE_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR

VkAccelerationStructureCreateFlagBitsKHR - Bitmask specifying additional creation parameters for acceleration structure

Description

• ACCELERATION_STRUCTURE_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR specifies that the acceleration structure’s address can be saved and reused on a subsequent run.

VK_COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR, VK_COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR, VK_COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR, VK_COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR

VkCopyAccelerationStructureModeKHR - Acceleration structure copy mode

Description

• COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR creates a direct copy of the acceleration structure specified in src into the one specified by dst. The dst acceleration structure must have been created with the same parameters as src. If src contains references to other acceleration structures, dst will reference the same acceleration structures.
• COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR creates a more compact version of an acceleration structure src into dst. The acceleration structure dst must have been created with a size at least as large as that returned by CmdWriteAccelerationStructuresPropertiesKHR or WriteAccelerationStructuresPropertiesKHR after the build of the acceleration structure specified by src. If src contains references to other acceleration structures, dst will reference the same acceleration structures.
• COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR serializes the acceleration structure to a semi-opaque format which can be reloaded on a compatible implementation.
• COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR deserializes the semi-opaque serialization format in the buffer to the acceleration structure.

See Also

VkCopyAccelerationStructureInfoKHR, VkCopyAccelerationStructureToMemoryInfoKHR, VkCopyMemoryToAccelerationStructureInfoKHR, CmdCopyAccelerationStructureNV

VK_ACCELERATION_STRUCTURE_COMPATIBILITY_COMPATIBLE_KHR, VK_ACCELERATION_STRUCTURE_COMPATIBILITY_INCOMPATIBLE_KHR

VkAccelerationStructureCompatibilityKHR - Acceleration structure compatibility

Description

• ACCELERATION_STRUCTURE_COMPATIBILITY_COMPATIBLE_KHR if the pVersionData version acceleration structure is compatible with device.
• ACCELERATION_STRUCTURE_COMPATIBILITY_INCOMPATIBLE_KHR if the pVersionData version acceleration structure is not compatible with device.

See Also

GetDeviceAccelerationStructureCompatibilityKHR

Method Detail

nvkCreateAccelerationStructureKHR

public static int nvkCreateAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                    long pCreateInfo,
                                                    long pAllocator,
                                                    long pAccelerationStructure)

Unsafe version of: CreateAccelerationStructureKHR

vkCreateAccelerationStructureKHR

public static int vkCreateAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                   VkAccelerationStructureCreateInfoKHR pCreateInfo,
                                                   @Nullable
                                                   VkAllocationCallbacks pAllocator,
                                                   java.nio.LongBuffer pAccelerationStructure)

Create a new acceleration structure object.

C Specification

To create an acceleration structure, call:

 VkResult vkCreateAccelerationStructureKHR(
     VkDevice                                    device,
     const VkAccelerationStructureCreateInfoKHR* pCreateInfo,
     const VkAllocationCallbacks*                pAllocator,
     VkAccelerationStructureKHR*                 pAccelerationStructure);

Description

Similar to other objects in Vulkan, the acceleration structure creation merely creates an object with a specific “shape”. The type and quantity of geometry that can be built into an acceleration structure is determined by the parameters of VkAccelerationStructureCreateInfoKHR.

Populating the data in the object after allocating and binding memory is done with commands such as CmdBuildAccelerationStructuresKHR, BuildAccelerationStructuresKHR, CmdCopyAccelerationStructureKHR, and CopyAccelerationStructureKHR.

The input buffers passed to acceleration structure build commands will be referenced by the implementation for the duration of the command. After the command completes, the acceleration structure may hold a reference to any acceleration structure specified by an active instance contained therein. Apart from this referencing, acceleration structures must be fully self-contained. The application may re-use or free any memory which was used by the command as an input or as scratch without affecting the results of ray traversal.

Valid Usage

• The accelerationStructure feature must be enabled
• If VkAccelerationStructureCreateInfoKHR::deviceAddress is not zero, the accelerationStructureCaptureReplay feature must be enabled
• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCreateInfo must be a valid pointer to a valid VkAccelerationStructureCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pAccelerationStructure must be a valid pointer to a VkAccelerationStructureKHR handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

See Also

VkAccelerationStructureCreateInfoKHR, VkAllocationCallbacks

Parameters:

device - the logical device that creates the acceleration structure object.

pCreateInfo - a pointer to a VkAccelerationStructureCreateInfoKHR structure containing parameters affecting creation of the acceleration structure.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

pAccelerationStructure - a pointer to a VkAccelerationStructureKHR handle in which the resulting acceleration structure object is returned.

nvkDestroyAccelerationStructureKHR

public static void nvkDestroyAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                      long accelerationStructure,
                                                      long pAllocator)

Unsafe version of: DestroyAccelerationStructureKHR

vkDestroyAccelerationStructureKHR

public static void vkDestroyAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                     long accelerationStructure,
                                                     @Nullable
                                                     VkAllocationCallbacks pAllocator)

Destroy an acceleration structure object.

C Specification

To destroy an acceleration structure, call:

 void vkDestroyAccelerationStructureKHR(
     VkDevice                                    device,
     VkAccelerationStructureKHR                  accelerationStructure,
     const VkAllocationCallbacks*                pAllocator);

Valid Usage

• All submitted commands that refer to accelerationStructure must have completed execution
• If VkAllocationCallbacks were provided when accelerationStructure was created, a compatible set of callbacks must be provided here
• If no VkAllocationCallbacks were provided when accelerationStructure was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If accelerationStructure is not NULL_HANDLE, accelerationStructure must be a valid VkAccelerationStructureKHR handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks 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

VkAllocationCallbacks

Parameters:

device - the logical device that destroys the acceleration structure.

accelerationStructure - the acceleration structure to destroy.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

nvkCmdBuildAccelerationStructuresKHR

public static void nvkCmdBuildAccelerationStructuresKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                        int infoCount,
                                                        long pInfos,
                                                        long ppBuildRangeInfos)

Unsafe version of: CmdBuildAccelerationStructuresKHR

Parameters:

infoCount - the number of acceleration structures to build. It specifies the number of the pInfos structures and ppBuildRangeInfos pointers that must be provided.

vkCmdBuildAccelerationStructuresKHR

public static void vkCmdBuildAccelerationStructuresKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                       VkAccelerationStructureBuildGeometryInfoKHR.Buffer pInfos,
                                                       org.lwjgl.PointerBuffer ppBuildRangeInfos)

Build an acceleration structure.

C Specification

To build acceleration structures call:

 void vkCmdBuildAccelerationStructuresKHR(
     VkCommandBuffer                             commandBuffer,
     uint32_t                                    infoCount,
     const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
     const VkAccelerationStructureBuildRangeInfoKHR* const* ppBuildRangeInfos);

Description

The vkCmdBuildAccelerationStructuresKHR command provides the ability to initiate multiple acceleration structures builds, however there is no ordering or synchronization implied between any of the individual acceleration structure builds.

Note

This means that an application cannot build a top-level acceleration structure in the same CmdBuildAccelerationStructuresKHR call as the associated bottom-level or instance acceleration structures are being built. There also cannot be any memory aliasing between any acceleration structure memories or scratch memories being used by any of the builds.

Accesses to the acceleration structure scratch buffers as identified by the VkAccelerationStructureBuildGeometryInfoKHR::scratchData buffer device addresses must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR or ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR. Similarly for accesses to each VkAccelerationStructureBuildGeometryInfoKHR::srcAccelerationStructure and VkAccelerationStructureBuildGeometryInfoKHR::dstAccelerationStructure.

Accesses to other input buffers as identified by any used values of VkAccelerationStructureGeometryMotionTrianglesDataNV::vertexData, VkAccelerationStructureGeometryTrianglesDataKHR::vertexData, VkAccelerationStructureGeometryTrianglesDataKHR::indexData, VkAccelerationStructureGeometryTrianglesDataKHR::transformData, VkAccelerationStructureGeometryAabbsDataKHR::data, and VkAccelerationStructureGeometryInstancesDataKHR::data must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_SHADER_READ_BIT.

Valid Usage

• The mode member of each element of pInfos must be a valid VkBuildAccelerationStructureModeKHR value
• If the srcAccelerationStructure member of any element of pInfos is not NULL_HANDLE, the srcAccelerationStructure member must be a valid VkAccelerationStructureKHR handle
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure member must not be NULL_HANDLE
• The srcAccelerationStructure member of any element of pInfos must not be the same acceleration structure as the dstAccelerationStructure member of any other element of pInfos
• The dstAccelerationStructure member of any element of pInfos must not be the same acceleration structure as the dstAccelerationStructure member of any other element of pInfos
• The dstAccelerationStructure member of any element of pInfos must be a valid VkAccelerationStructureKHR handle
• For each element of pInfos, if its type member is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR, its dstAccelerationStructure member must have been created with a value of VkAccelerationStructureCreateInfoKHR::type equal to either ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR or ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR
• For each element of pInfos, if its type member is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR, its dstAccelerationStructure member must have been created with a value of VkAccelerationStructureCreateInfoKHR::type equal to either ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR or ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, inactive primitives in its srcAccelerationStructure member must not be made active
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, active primitives in its srcAccelerationStructure member must not be made inactive
• The dstAccelerationStructure member of any element of pInfos must not be referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR in any other element of pInfos
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the srcAccelerationStructure member of any other element of pInfos with a mode equal to BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the dstAccelerationStructure member of any other element of pInfos, which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any element of pInfos (including the same element), which is accessed by this command
• The range of memory backing the scratchData member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any other element of pInfos, which is accessed by this command
• The range of memory backing the scratchData member of any element of pInfos that is accessed by this command must not overlap the memory backing the srcAccelerationStructure member of any element of pInfos with a mode equal to BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR (including the same element), which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing any acceleration structure referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR in any other element of pInfos, which is accessed by this command
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure member must have previously been constructed with BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR set in VkAccelerationStructureBuildGeometryInfoKHR::flags in the build
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure and dstAccelerationStructure members must either be the same VkAccelerationStructureKHR, or not have any memory aliasing
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its geometryCount member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its flags member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its type member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, its geometryType member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, its flags member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.vertexFormat member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.maxVertex member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.indexType member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, if its geometry.triangles.transformData address was NULL when srcAccelerationStructure was last built, then it must be NULL
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, if its geometry.triangles.transformData address was not NULL when srcAccelerationStructure was last built, then it must not be NULL
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, and geometry.triangles.indexType is not INDEX_TYPE_NONE_KHR, then the value of each index referenced must be the same as the corresponding index value when srcAccelerationStructure was last built
• For each VkAccelerationStructureBuildRangeInfoKHR referenced by this command, its primitiveCount member must have the same value which was specified when srcAccelerationStructure was last built
• For each VkAccelerationStructureBuildRangeInfoKHR referenced by this command, if the corresponding geometry uses indices, its firstVertex member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, the corresponding ppBuildRangeInfos[i][j].primitiveCount must be less than or equal to VkPhysicalDeviceAccelerationStructurePropertiesKHR::maxInstanceCount

• For each element of pInfos, the buffer used to create its dstAccelerationStructure member must be bound to device memory
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR the buffer used to create its srcAccelerationStructure member must be bound to device memory
• For each element of pInfos, the buffer used to create each acceleration structure referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR must be bound to device memory
• If pInfos[i].mode is BUILD_ACCELERATION_STRUCTURE_MODE_BUILD_KHR, all addresses between pInfos[i].scratchData.deviceAddress and pInfos[i].scratchData.deviceAddress + N - 1 must be in the buffer device address range of the same buffer, where N is given by the buildScratchSize member of the VkAccelerationStructureBuildSizesInfoKHR structure returned from a call to GetAccelerationStructureBuildSizesKHR with an identical VkAccelerationStructureBuildGeometryInfoKHR structure and primitive count
• If pInfos[i].mode is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, all addresses between pInfos[i].scratchData.deviceAddress and pInfos[i].scratchData.deviceAddress + N - 1 must be in the buffer device address range of the same buffer, where N is given by the updateScratchSize member of the VkAccelerationStructureBuildSizesInfoKHR structure returned from a call to GetAccelerationStructureBuildSizesKHR with an identical VkAccelerationStructureBuildGeometryInfoKHR structure and primitive count
• The buffers from which the buffer device addresses for all of the geometry.triangles.vertexData, geometry.triangles.indexData, geometry.triangles.transformData, geometry.aabbs.data, and geometry.instances.data members of all pInfos[i].pGeometries and pInfos[i].ppGeometries are queried must have been created with the BUFFER_USAGE_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR usage flag
• The buffer from which the buffer device address pInfos[i].scratchData.deviceAddress is queried must have been created with BUFFER_USAGE_STORAGE_BUFFER_BIT usage flag
• For each element of pInfos, its scratchData.deviceAddress member must be a valid device address obtained from GetBufferDeviceAddress
• For each element of pInfos, if scratchData.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For each element of pInfos, its scratchData.deviceAddress member must be a multiple of VkPhysicalDeviceAccelerationStructurePropertiesKHR::minAccelerationStructureScratchOffsetAlignment
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, geometry.triangles.vertexData.deviceAddress must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.vertexData.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, geometry.triangles.vertexData.deviceAddress must be aligned to the size in bytes of the smallest component of the format in vertexFormat
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.indexType is not INDEX_TYPE_NONE_KHR, geometry.triangles.indexData.deviceAddress must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.indexType is not INDEX_TYPE_NONE_KHR, if geometry.triangles.indexData.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, and with geometry.triangles.indexType not equal to INDEX_TYPE_NONE_KHR, geometry.triangles.indexData.deviceAddress must be aligned to the size in bytes of the type in indexType
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.transformData.deviceAddress is not 0, it must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.transformData.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.transformData.deviceAddress is not 0, it must be aligned to 16 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_AABBS_KHR, geometry.aabbs.data.deviceAddress must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_AABBS_KHR, if geometry.aabbs.data.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_AABBS_KHR, geometry.aabbs.data.deviceAddress must be aligned to 8 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, if geometry.arrayOfPointers is FALSE, geometry.instances.data.deviceAddress must be aligned to 16 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, if geometry.arrayOfPointers is TRUE, geometry.instances.data.deviceAddress must be aligned to 8 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, if geometry.arrayOfPointers is TRUE, each element of geometry.instances.data.deviceAddress in device memory must be aligned to 16 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, geometry.instances.data.deviceAddress must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, if geometry.instances.data.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, each VkAccelerationStructureInstanceKHR::accelerationStructureReference value in geometry.instances.data.deviceAddress must be a valid device address containing a value obtained from GetAccelerationStructureDeviceAddressKHR

• For each pInfos[i], dstAccelerationStructure must have been created with a value of VkAccelerationStructureCreateInfoKHR::size greater than or equal to the memory size required by the build operation, as returned by GetAccelerationStructureBuildSizesKHR with pBuildInfo = pInfos[i] and with each element of the pMaxPrimitiveCounts array greater than or equal to the equivalent ppBuildRangeInfos[i][j].primitiveCount values for j in [0,pInfos[i].geometryCount)
• Each element of ppBuildRangeInfos[i] must be a valid pointer to an array of pInfos[i].geometryCount VkAccelerationStructureBuildRangeInfoKHR structures

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pInfos must be a valid pointer to an array of infoCount valid VkAccelerationStructureBuildGeometryInfoKHR structures
• ppBuildRangeInfos must be a valid pointer to an array of infoCount VkAccelerationStructureBuildRangeInfoKHR structures
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance
• infoCount must be greater than 0

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Compute

See Also

VkAccelerationStructureBuildGeometryInfoKHR, VkAccelerationStructureBuildRangeInfoKHR

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pInfos - a pointer to an array of infoCount VkAccelerationStructureBuildGeometryInfoKHR structures defining the geometry used to build each acceleration structure.

ppBuildRangeInfos - a pointer to an array of infoCount pointers to arrays of VkAccelerationStructureBuildRangeInfoKHR structures. Each ppBuildRangeInfos[i] is a pointer to an array of pInfos[i].geometryCount VkAccelerationStructureBuildRangeInfoKHR structures defining dynamic offsets to the addresses where geometry data is stored, as defined by pInfos[i].

nvkCmdBuildAccelerationStructuresIndirectKHR

public static void nvkCmdBuildAccelerationStructuresIndirectKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                                int infoCount,
                                                                long pInfos,
                                                                long pIndirectDeviceAddresses,
                                                                long pIndirectStrides,
                                                                long ppMaxPrimitiveCounts)

Unsafe version of: CmdBuildAccelerationStructuresIndirectKHR

Parameters:

infoCount - the number of acceleration structures to build.

vkCmdBuildAccelerationStructuresIndirectKHR

public static void vkCmdBuildAccelerationStructuresIndirectKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                               VkAccelerationStructureBuildGeometryInfoKHR.Buffer pInfos,
                                                               java.nio.LongBuffer pIndirectDeviceAddresses,
                                                               java.nio.IntBuffer pIndirectStrides,
                                                               org.lwjgl.PointerBuffer ppMaxPrimitiveCounts)

Build an acceleration structure with some parameters provided on the device.

C Specification

To build acceleration structures with some parameters sourced on the device call:

 void vkCmdBuildAccelerationStructuresIndirectKHR(
     VkCommandBuffer                             commandBuffer,
     uint32_t                                    infoCount,
     const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
     const VkDeviceAddress*                      pIndirectDeviceAddresses,
     const uint32_t*                             pIndirectStrides,
     const uint32_t* const*                      ppMaxPrimitiveCounts);

Description

Accesses to acceleration structures, scratch buffers, vertex buffers, index buffers, and instance buffers must be synchronized as with vkCmdBuildAccelerationStructuresKHR.

Accesses to any element of pIndirectDeviceAddresses must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_INDIRECT_COMMAND_READ_BIT.

Valid Usage

• The mode member of each element of pInfos must be a valid VkBuildAccelerationStructureModeKHR value
• If the srcAccelerationStructure member of any element of pInfos is not NULL_HANDLE, the srcAccelerationStructure member must be a valid VkAccelerationStructureKHR handle
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure member must not be NULL_HANDLE
• The srcAccelerationStructure member of any element of pInfos must not be the same acceleration structure as the dstAccelerationStructure member of any other element of pInfos
• The dstAccelerationStructure member of any element of pInfos must not be the same acceleration structure as the dstAccelerationStructure member of any other element of pInfos
• The dstAccelerationStructure member of any element of pInfos must be a valid VkAccelerationStructureKHR handle
• For each element of pInfos, if its type member is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR, its dstAccelerationStructure member must have been created with a value of VkAccelerationStructureCreateInfoKHR::type equal to either ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR or ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR
• For each element of pInfos, if its type member is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR, its dstAccelerationStructure member must have been created with a value of VkAccelerationStructureCreateInfoKHR::type equal to either ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR or ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, inactive primitives in its srcAccelerationStructure member must not be made active
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, active primitives in its srcAccelerationStructure member must not be made inactive
• The dstAccelerationStructure member of any element of pInfos must not be referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR in any other element of pInfos
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the srcAccelerationStructure member of any other element of pInfos with a mode equal to BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the dstAccelerationStructure member of any other element of pInfos, which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any element of pInfos (including the same element), which is accessed by this command
• The range of memory backing the scratchData member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any other element of pInfos, which is accessed by this command
• The range of memory backing the scratchData member of any element of pInfos that is accessed by this command must not overlap the memory backing the srcAccelerationStructure member of any element of pInfos with a mode equal to BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR (including the same element), which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing any acceleration structure referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR in any other element of pInfos, which is accessed by this command
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure member must have previously been constructed with BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR set in VkAccelerationStructureBuildGeometryInfoKHR::flags in the build
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure and dstAccelerationStructure members must either be the same VkAccelerationStructureKHR, or not have any memory aliasing
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its geometryCount member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its flags member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its type member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, its geometryType member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, its flags member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.vertexFormat member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.maxVertex member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.indexType member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, if its geometry.triangles.transformData address was NULL when srcAccelerationStructure was last built, then it must be NULL
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, if its geometry.triangles.transformData address was not NULL when srcAccelerationStructure was last built, then it must not be NULL
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, and geometry.triangles.indexType is not INDEX_TYPE_NONE_KHR, then the value of each index referenced must be the same as the corresponding index value when srcAccelerationStructure was last built
• For each VkAccelerationStructureBuildRangeInfoKHR referenced by this command, its primitiveCount member must have the same value which was specified when srcAccelerationStructure was last built
• For each VkAccelerationStructureBuildRangeInfoKHR referenced by this command, if the corresponding geometry uses indices, its firstVertex member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, the corresponding ppMaxPrimitiveCounts[i][j] must be less than or equal to VkPhysicalDeviceAccelerationStructurePropertiesKHR::maxInstanceCount

• For each element of pInfos, the buffer used to create its dstAccelerationStructure member must be bound to device memory
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR the buffer used to create its srcAccelerationStructure member must be bound to device memory
• For each element of pInfos, the buffer used to create each acceleration structure referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR must be bound to device memory
• If pInfos[i].mode is BUILD_ACCELERATION_STRUCTURE_MODE_BUILD_KHR, all addresses between pInfos[i].scratchData.deviceAddress and pInfos[i].scratchData.deviceAddress + N - 1 must be in the buffer device address range of the same buffer, where N is given by the buildScratchSize member of the VkAccelerationStructureBuildSizesInfoKHR structure returned from a call to GetAccelerationStructureBuildSizesKHR with an identical VkAccelerationStructureBuildGeometryInfoKHR structure and primitive count
• If pInfos[i].mode is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, all addresses between pInfos[i].scratchData.deviceAddress and pInfos[i].scratchData.deviceAddress + N - 1 must be in the buffer device address range of the same buffer, where N is given by the updateScratchSize member of the VkAccelerationStructureBuildSizesInfoKHR structure returned from a call to GetAccelerationStructureBuildSizesKHR with an identical VkAccelerationStructureBuildGeometryInfoKHR structure and primitive count
• The buffers from which the buffer device addresses for all of the geometry.triangles.vertexData, geometry.triangles.indexData, geometry.triangles.transformData, geometry.aabbs.data, and geometry.instances.data members of all pInfos[i].pGeometries and pInfos[i].ppGeometries are queried must have been created with the BUFFER_USAGE_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR usage flag
• The buffer from which the buffer device address pInfos[i].scratchData.deviceAddress is queried must have been created with BUFFER_USAGE_STORAGE_BUFFER_BIT usage flag
• For each element of pInfos, its scratchData.deviceAddress member must be a valid device address obtained from GetBufferDeviceAddress
• For each element of pInfos, if scratchData.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For each element of pInfos, its scratchData.deviceAddress member must be a multiple of VkPhysicalDeviceAccelerationStructurePropertiesKHR::minAccelerationStructureScratchOffsetAlignment
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, geometry.triangles.vertexData.deviceAddress must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.vertexData.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, geometry.triangles.vertexData.deviceAddress must be aligned to the size in bytes of the smallest component of the format in vertexFormat
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.indexType is not INDEX_TYPE_NONE_KHR, geometry.triangles.indexData.deviceAddress must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.indexType is not INDEX_TYPE_NONE_KHR, if geometry.triangles.indexData.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, and with geometry.triangles.indexType not equal to INDEX_TYPE_NONE_KHR, geometry.triangles.indexData.deviceAddress must be aligned to the size in bytes of the type in indexType
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.transformData.deviceAddress is not 0, it must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.transformData.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.transformData.deviceAddress is not 0, it must be aligned to 16 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_AABBS_KHR, geometry.aabbs.data.deviceAddress must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_AABBS_KHR, if geometry.aabbs.data.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_AABBS_KHR, geometry.aabbs.data.deviceAddress must be aligned to 8 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, if geometry.arrayOfPointers is FALSE, geometry.instances.data.deviceAddress must be aligned to 16 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, if geometry.arrayOfPointers is TRUE, geometry.instances.data.deviceAddress must be aligned to 8 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, if geometry.arrayOfPointers is TRUE, each element of geometry.instances.data.deviceAddress in device memory must be aligned to 16 bytes
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, geometry.instances.data.deviceAddress must be a valid device address obtained from GetBufferDeviceAddress
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, if geometry.instances.data.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, each VkAccelerationStructureInstanceKHR::accelerationStructureReference value in geometry.instances.data.deviceAddress must be a valid device address containing a value obtained from GetAccelerationStructureDeviceAddressKHR
• For any element of pIndirectDeviceAddresses, if the buffer from which it was queried is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
• For any element of pIndirectDeviceAddresses[i], all device addresses between pIndirectDeviceAddresses[i] and pIndirectDeviceAddresses[i] + (pInfos[i].geometryCount × pIndirectStrides[i]) - 1 must be in the buffer device address range of the same buffer
• For any element of pIndirectDeviceAddresses, the buffer from which it was queried must have been created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
• Each element of pIndirectDeviceAddresses must be a multiple of 4
• Each element of pIndirectStrides must be a multiple of 4
• commandBuffer must not be a protected command buffer
• The VkPhysicalDeviceAccelerationStructureFeaturesKHR::accelerationStructureIndirectBuild feature must be enabled
• Each VkAccelerationStructureBuildRangeInfoKHR structure referenced by any element of pIndirectDeviceAddresses must be a valid VkAccelerationStructureBuildRangeInfoKHR structure
• pInfos[i].dstAccelerationStructure must have been created with a value of VkAccelerationStructureCreateInfoKHR::size greater than or equal to the memory size required by the build operation, as returned by GetAccelerationStructureBuildSizesKHR with pBuildInfo = pInfos[i] and pMaxPrimitiveCounts = ppMaxPrimitiveCounts[i]
• Each ppMaxPrimitiveCounts[i][j] must be greater than or equal to the the primitiveCount value specified by the VkAccelerationStructureBuildRangeInfoKHR structure located at pIndirectDeviceAddresses[i] + (j × pIndirectStrides[i])

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pInfos must be a valid pointer to an array of infoCount valid VkAccelerationStructureBuildGeometryInfoKHR structures
• pIndirectDeviceAddresses must be a valid pointer to an array of infoCount VkDeviceAddress values
• pIndirectStrides must be a valid pointer to an array of infoCount uint32_t values
• ppMaxPrimitiveCounts must be a valid pointer to an array of infoCount uint32_t values
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance
• infoCount must be greater than 0

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Compute

See Also

VkAccelerationStructureBuildGeometryInfoKHR

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pInfos - a pointer to an array of infoCount VkAccelerationStructureBuildGeometryInfoKHR structures defining the geometry used to build each acceleration structure.

pIndirectDeviceAddresses - a pointer to an array of infoCount buffer device addresses which point to pInfos[i].geometryCount VkAccelerationStructureBuildRangeInfoKHR structures defining dynamic offsets to the addresses where geometry data is stored, as defined by pInfos[i].

pIndirectStrides - a pointer to an array of infoCount byte strides between elements of pIndirectDeviceAddresses.

ppMaxPrimitiveCounts - a pointer to an array of infoCount pointers to arrays of pInfos[i].geometryCount values indicating the maximum number of primitives that will be built by this command for each geometry.

nvkBuildAccelerationStructuresKHR

public static int nvkBuildAccelerationStructuresKHR(org.lwjgl.vulkan.VkDevice device,
                                                    long deferredOperation,
                                                    int infoCount,
                                                    long pInfos,
                                                    long ppBuildRangeInfos)

Unsafe version of: BuildAccelerationStructuresKHR

Parameters:

infoCount - the number of acceleration structures to build. It specifies the number of the pInfos structures and ppBuildRangeInfos pointers that must be provided.

vkBuildAccelerationStructuresKHR

public static int vkBuildAccelerationStructuresKHR(org.lwjgl.vulkan.VkDevice device,
                                                   long deferredOperation,
                                                   VkAccelerationStructureBuildGeometryInfoKHR.Buffer pInfos,
                                                   org.lwjgl.PointerBuffer ppBuildRangeInfos)

Build an acceleration structure on the host.

C Specification

To build acceleration structures on the host, call:

 VkResult vkBuildAccelerationStructuresKHR(
     VkDevice                                    device,
     VkDeferredOperationKHR                      deferredOperation,
     uint32_t                                    infoCount,
     const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
     const VkAccelerationStructureBuildRangeInfoKHR* const* ppBuildRangeInfos);

Description

This command fulfills the same task as CmdBuildAccelerationStructuresKHR but is executed by the host.

The vkBuildAccelerationStructuresKHR command provides the ability to initiate multiple acceleration structures builds, however there is no ordering or synchronization implied between any of the individual acceleration structure builds.

Note

This means that an application cannot build a top-level acceleration structure in the same BuildAccelerationStructuresKHR call as the associated bottom-level or instance acceleration structures are being built. There also cannot be any memory aliasing between any acceleration structure memories or scratch memories being used by any of the builds.

Valid Usage

• The mode member of each element of pInfos must be a valid VkBuildAccelerationStructureModeKHR value
• If the srcAccelerationStructure member of any element of pInfos is not NULL_HANDLE, the srcAccelerationStructure member must be a valid VkAccelerationStructureKHR handle
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure member must not be NULL_HANDLE
• The srcAccelerationStructure member of any element of pInfos must not be the same acceleration structure as the dstAccelerationStructure member of any other element of pInfos
• The dstAccelerationStructure member of any element of pInfos must not be the same acceleration structure as the dstAccelerationStructure member of any other element of pInfos
• The dstAccelerationStructure member of any element of pInfos must be a valid VkAccelerationStructureKHR handle
• For each element of pInfos, if its type member is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR, its dstAccelerationStructure member must have been created with a value of VkAccelerationStructureCreateInfoKHR::type equal to either ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR or ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR
• For each element of pInfos, if its type member is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR, its dstAccelerationStructure member must have been created with a value of VkAccelerationStructureCreateInfoKHR::type equal to either ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR or ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, inactive primitives in its srcAccelerationStructure member must not be made active
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, active primitives in its srcAccelerationStructure member must not be made inactive
• The dstAccelerationStructure member of any element of pInfos must not be referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR in any other element of pInfos
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the srcAccelerationStructure member of any other element of pInfos with a mode equal to BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the dstAccelerationStructure member of any other element of pInfos, which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any element of pInfos (including the same element), which is accessed by this command
• The range of memory backing the scratchData member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any other element of pInfos, which is accessed by this command
• The range of memory backing the scratchData member of any element of pInfos that is accessed by this command must not overlap the memory backing the srcAccelerationStructure member of any element of pInfos with a mode equal to BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR (including the same element), which is accessed by this command
• The range of memory backing the dstAccelerationStructure member of any element of pInfos that is accessed by this command must not overlap the memory backing any acceleration structure referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR in any other element of pInfos, which is accessed by this command
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure member must have previously been constructed with BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR set in VkAccelerationStructureBuildGeometryInfoKHR::flags in the build
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its srcAccelerationStructure and dstAccelerationStructure members must either be the same VkAccelerationStructureKHR, or not have any memory aliasing
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its geometryCount member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its flags member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, its type member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, its geometryType member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, its flags member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.vertexFormat member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.maxVertex member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, its geometry.triangles.indexType member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, if its geometry.triangles.transformData address was NULL when srcAccelerationStructure was last built, then it must be NULL
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, if its geometry.triangles.transformData address was not NULL when srcAccelerationStructure was last built, then it must not be NULL
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, then for each VkAccelerationStructureGeometryKHR structure referred to by its pGeometries or ppGeometries members, if geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, and geometry.triangles.indexType is not INDEX_TYPE_NONE_KHR, then the value of each index referenced must be the same as the corresponding index value when srcAccelerationStructure was last built
• For each VkAccelerationStructureBuildRangeInfoKHR referenced by this command, its primitiveCount member must have the same value which was specified when srcAccelerationStructure was last built
• For each VkAccelerationStructureBuildRangeInfoKHR referenced by this command, if the corresponding geometry uses indices, its firstVertex member must have the same value which was specified when srcAccelerationStructure was last built
• For each element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, the corresponding ppBuildRangeInfos[i][j].primitiveCount must be less than or equal to VkPhysicalDeviceAccelerationStructurePropertiesKHR::maxInstanceCount

• For each pInfos[i], dstAccelerationStructure must have been created with a value of VkAccelerationStructureCreateInfoKHR::size greater than or equal to the memory size required by the build operation, as returned by GetAccelerationStructureBuildSizesKHR with pBuildInfo = pInfos[i] and with each element of the pMaxPrimitiveCounts array greater than or equal to the equivalent ppBuildRangeInfos[i][j].primitiveCount values for j in [0,pInfos[i].geometryCount)
• Each element of ppBuildRangeInfos[i] must be a valid pointer to an array of pInfos[i].geometryCount VkAccelerationStructureBuildRangeInfoKHR structures

• If deferredOperation is not NULL_HANDLE, it must be a valid VkDeferredOperationKHR object
• Any previous deferred operation that was associated with deferredOperation must be complete
• For each element of pInfos, the buffer used to create its dstAccelerationStructure member must be bound to host-visible device memory
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR the buffer used to create its srcAccelerationStructure member must be bound to host-visible device memory
• For each element of pInfos, the buffer used to create each acceleration structure referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR must be bound to host-visible device memory
• The VkPhysicalDeviceAccelerationStructureFeaturesKHR::accelerationStructureHostCommands feature must be enabled
• If pInfos[i].mode is BUILD_ACCELERATION_STRUCTURE_MODE_BUILD_KHR, all addresses between pInfos[i].scratchData.hostAddress and pInfos[i].scratchData.hostAddress + N - 1 must be valid host memory, where N is given by the buildScratchSize member of the VkAccelerationStructureBuildSizesInfoKHR structure returned from a call to GetAccelerationStructureBuildSizesKHR with an identical VkAccelerationStructureBuildGeometryInfoKHR structure and primitive count
• If pInfos[i].mode is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR, all addresses between pInfos[i].scratchData.hostAddress and pInfos[i].scratchData.hostAddress + N - 1 must be valid host memory, where N is given by the updateScratchSize member of the VkAccelerationStructureBuildSizesInfoKHR structure returned from a call to GetAccelerationStructureBuildSizesKHR with an identical VkAccelerationStructureBuildGeometryInfoKHR structure and primitive count
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, geometry.triangles.vertexData.hostAddress must be a valid host address
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.indexType is not INDEX_TYPE_NONE_KHR, geometry.triangles.indexData.hostAddress must be a valid host address
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR, if geometry.triangles.transformData.hostAddress is not 0, it must be a valid host address
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_AABBS_KHR, geometry.aabbs.data.hostAddress must be a valid host address
• For each element of pInfos, the buffer used to create its dstAccelerationStructure member must be bound to memory that was not allocated with multiple instances
• For each element of pInfos, if its mode member is BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR the buffer used to create its srcAccelerationStructure member must be bound to memory that was not allocated with multiple instances
• For each element of pInfos, the buffer used to create each acceleration structure referenced by the geometry.instances.data member of any element of pGeometries or ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR must be bound to memory that was not allocated with multiple instances
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, geometry.instances.data.hostAddress must be a valid host address
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, each VkAccelerationStructureInstanceKHR::accelerationStructureReference value in geometry.instances.data.hostAddress must be a valid VkAccelerationStructureKHR object
• For any element of pInfos[i].pGeometries or pInfos[i].ppGeometries with a geometryType of GEOMETRY_TYPE_INSTANCES_KHR with BUILD_ACCELERATION_STRUCTURE_MOTION_BIT_NV set, each accelerationStructureReference in any structure in VkAccelerationStructureMotionInstanceNV value in geometry.instances.data.hostAddress must be a valid VkAccelerationStructureKHR object

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid VkDeferredOperationKHR handle
• pInfos must be a valid pointer to an array of infoCount valid VkAccelerationStructureBuildGeometryInfoKHR structures
• ppBuildRangeInfos must be a valid pointer to an array of infoCount VkAccelerationStructureBuildRangeInfoKHR structures
• infoCount must be greater than 0
• If deferredOperation is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkAccelerationStructureBuildGeometryInfoKHR, VkAccelerationStructureBuildRangeInfoKHR

Parameters:

device - the VkDevice for which the acceleration structures are being built.

deferredOperation - an optional VkDeferredOperationKHR to request deferral for this command.

pInfos - a pointer to an array of infoCount VkAccelerationStructureBuildGeometryInfoKHR structures defining the geometry used to build each acceleration structure.

ppBuildRangeInfos - a pointer to an array of infoCount pointers to arrays of VkAccelerationStructureBuildRangeInfoKHR structures. Each ppBuildRangeInfos[i] is a pointer to an array of pInfos[i].geometryCount VkAccelerationStructureBuildRangeInfoKHR structures defining dynamic offsets to the addresses where geometry data is stored, as defined by pInfos[i].

nvkCopyAccelerationStructureKHR

public static int nvkCopyAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                  long deferredOperation,
                                                  long pInfo)

Unsafe version of: CopyAccelerationStructureKHR

vkCopyAccelerationStructureKHR

public static int vkCopyAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                 long deferredOperation,
                                                 VkCopyAccelerationStructureInfoKHR pInfo)

Copy an acceleration structure on the host.

C Specification

To copy or compact an acceleration structure on the host, call:

 VkResult vkCopyAccelerationStructureKHR(
     VkDevice                                    device,
     VkDeferredOperationKHR                      deferredOperation,
     const VkCopyAccelerationStructureInfoKHR*   pInfo);

Description

This command fulfills the same task as CmdCopyAccelerationStructureKHR but is executed by the host.

Valid Usage

• If deferredOperation is not NULL_HANDLE, it must be a valid VkDeferredOperationKHR object
• Any previous deferred operation that was associated with deferredOperation must be complete
• The buffer used to create pInfo\u2192src must be bound to host-visible device memory
• The buffer used to create pInfo\u2192dst must be bound to host-visible device memory
• The VkPhysicalDeviceAccelerationStructureFeaturesKHR::accelerationStructureHostCommands feature must be enabled
• The buffer used to create pInfo\u2192src must be bound to memory that was not allocated with multiple instances
• The buffer used to create pInfo\u2192dst must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid VkDeferredOperationKHR handle
• pInfo must be a valid pointer to a valid VkCopyAccelerationStructureInfoKHR structure
• If deferredOperation is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkCopyAccelerationStructureInfoKHR

Parameters:

device - the device which owns the acceleration structures.

deferredOperation - an optional VkDeferredOperationKHR to request deferral for this command.

pInfo - a pointer to a VkCopyAccelerationStructureInfoKHR structure defining the copy operation.

nvkCopyAccelerationStructureToMemoryKHR

public static int nvkCopyAccelerationStructureToMemoryKHR(org.lwjgl.vulkan.VkDevice device,
                                                          long deferredOperation,
                                                          long pInfo)

Unsafe version of: CopyAccelerationStructureToMemoryKHR

vkCopyAccelerationStructureToMemoryKHR

public static int vkCopyAccelerationStructureToMemoryKHR(org.lwjgl.vulkan.VkDevice device,
                                                         long deferredOperation,
                                                         VkCopyAccelerationStructureToMemoryInfoKHR pInfo)

Serialize an acceleration structure on the host.

C Specification

To copy an acceleration structure to host accessible memory, call:

 VkResult vkCopyAccelerationStructureToMemoryKHR(
     VkDevice                                    device,
     VkDeferredOperationKHR                      deferredOperation,
     const VkCopyAccelerationStructureToMemoryInfoKHR* pInfo);

Description

This command fulfills the same task as CmdCopyAccelerationStructureToMemoryKHR but is executed by the host.

This command produces the same results as CmdCopyAccelerationStructureToMemoryKHR, but writes its result directly to a host pointer, and is executed on the host rather than the device. The output may not necessarily be bit-for-bit identical, but it can be equally used by either CmdCopyMemoryToAccelerationStructureKHR or CopyMemoryToAccelerationStructureKHR.

Valid Usage

• If deferredOperation is not NULL_HANDLE, it must be a valid VkDeferredOperationKHR object
• Any previous deferred operation that was associated with deferredOperation must be complete
• The buffer used to create pInfo\u2192src must be bound to host-visible device memory
• pInfo\u2192dst.hostAddress must be a valid host pointer
• pInfo\u2192dst.hostAddress must be aligned to 16 bytes
• The VkPhysicalDeviceAccelerationStructureFeaturesKHR::accelerationStructureHostCommands feature must be enabled
• The buffer used to create pInfo\u2192src must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid VkDeferredOperationKHR handle
• pInfo must be a valid pointer to a valid VkCopyAccelerationStructureToMemoryInfoKHR structure
• If deferredOperation is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkCopyAccelerationStructureToMemoryInfoKHR

Parameters:

device - the device which owns pInfo\u2192src.

deferredOperation - an optional VkDeferredOperationKHR to request deferral for this command.

pInfo - a pointer to a VkCopyAccelerationStructureToMemoryInfoKHR structure defining the copy operation.

nvkCopyMemoryToAccelerationStructureKHR

public static int nvkCopyMemoryToAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                          long deferredOperation,
                                                          long pInfo)

Unsafe version of: CopyMemoryToAccelerationStructureKHR

vkCopyMemoryToAccelerationStructureKHR

public static int vkCopyMemoryToAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                         long deferredOperation,
                                                         VkCopyMemoryToAccelerationStructureInfoKHR pInfo)

Deserialize an acceleration structure on the host.

C Specification

To copy host accessible memory to an acceleration structure, call:

 VkResult vkCopyMemoryToAccelerationStructureKHR(
     VkDevice                                    device,
     VkDeferredOperationKHR                      deferredOperation,
     const VkCopyMemoryToAccelerationStructureInfoKHR* pInfo);

Description

This command fulfills the same task as CmdCopyMemoryToAccelerationStructureKHR but is executed by the host.

This command can accept acceleration structures produced by either CmdCopyAccelerationStructureToMemoryKHR or CopyAccelerationStructureToMemoryKHR.

Valid Usage

• If deferredOperation is not NULL_HANDLE, it must be a valid VkDeferredOperationKHR object
• Any previous deferred operation that was associated with deferredOperation must be complete
• pInfo\u2192src.hostAddress must be a valid host pointer
• pInfo\u2192src.hostAddress must be aligned to 16 bytes
• The buffer used to create pInfo\u2192dst must be bound to host-visible device memory
• The VkPhysicalDeviceAccelerationStructureFeaturesKHR::accelerationStructureHostCommands feature must be enabled
• The buffer used to create pInfo\u2192dst must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid VkDeferredOperationKHR handle
• pInfo must be a valid pointer to a valid VkCopyMemoryToAccelerationStructureInfoKHR structure
• If deferredOperation is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkCopyMemoryToAccelerationStructureInfoKHR

Parameters:

device - the device which owns pInfo\u2192dst.

deferredOperation - an optional VkDeferredOperationKHR to request deferral for this command.

pInfo - a pointer to a VkCopyMemoryToAccelerationStructureInfoKHR structure defining the copy operation.

nvkWriteAccelerationStructuresPropertiesKHR

public static int nvkWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkDevice device,
                                                              int accelerationStructureCount,
                                                              long pAccelerationStructures,
                                                              int queryType,
                                                              long dataSize,
                                                              long pData,
                                                              long stride)

Unsafe version of: WriteAccelerationStructuresPropertiesKHR

Parameters:

accelerationStructureCount - the count of acceleration structures for which to query the property.

dataSize - the size in bytes of the buffer pointed to by pData.

vkWriteAccelerationStructuresPropertiesKHR

public static int vkWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkDevice device,
                                                             java.nio.LongBuffer pAccelerationStructures,
                                                             int queryType,
                                                             java.nio.ByteBuffer pData,
                                                             long stride)

Query acceleration structure meta-data on the host.

C Specification

To query acceleration structure size parameters on the host, call:

 VkResult vkWriteAccelerationStructuresPropertiesKHR(
     VkDevice                                    device,
     uint32_t                                    accelerationStructureCount,
     const VkAccelerationStructureKHR*           pAccelerationStructures,
     VkQueryType                                 queryType,
     size_t                                      dataSize,
     void*                                       pData,
     size_t                                      stride);

Description

This command fulfills the same task as CmdWriteAccelerationStructuresPropertiesKHR but is executed by the host.

Valid Usage

• All acceleration structures in pAccelerationStructures must have been built prior to the execution of this command
• All acceleration structures in pAccelerationStructures 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
• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR, then stride must be a multiple of the size of VkDeviceSize
• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR, then data must point to a VkDeviceSize
• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR, then stride must be a multiple of the size of VkDeviceSize
• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR, then data must point to a VkDeviceSize
• dataSize must be greater than or equal to accelerationStructureCount*stride
• The buffer used to create each acceleration structure in pAccelerationStructures must be bound to host-visible device memory
• The VkPhysicalDeviceAccelerationStructureFeaturesKHR::accelerationStructureHostCommands feature must be enabled
• The buffer used to create each acceleration structure in pAccelerationStructures must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid VkAccelerationStructureKHR handles
• queryType must be a valid VkQueryType value
• pData must be a valid pointer to an array of dataSize bytes
• accelerationStructureCount must be greater than 0
• dataSize must be greater than 0
• Each element of pAccelerationStructures must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

Parameters:

device - the device which owns the acceleration structures in pAccelerationStructures.

pAccelerationStructures - a pointer to an array of existing previously built acceleration structures.

queryType - a VkQueryType value specifying the property to be queried.

pData - a pointer to a user-allocated buffer where the results will be written.

stride - the stride in bytes between results for individual queries within pData.

nvkCmdCopyAccelerationStructureKHR

public static void nvkCmdCopyAccelerationStructureKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                      long pInfo)

Unsafe version of: CmdCopyAccelerationStructureKHR

vkCmdCopyAccelerationStructureKHR

public static void vkCmdCopyAccelerationStructureKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                     VkCopyAccelerationStructureInfoKHR pInfo)

Copy an acceleration structure.

C Specification

To copy an acceleration structure call:

 void vkCmdCopyAccelerationStructureKHR(
     VkCommandBuffer                             commandBuffer,
     const VkCopyAccelerationStructureInfoKHR*   pInfo);

Description

This command copies the pInfo\u2192src acceleration structure to the pInfo\u2192dst acceleration structure in the manner specified by pInfo\u2192mode.

Accesses to pInfo\u2192src and pInfo\u2192dst must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR or ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR as appropriate.

Valid Usage

• The buffer used to create pInfo\u2192src must be bound to device memory
• The buffer used to create pInfo\u2192dst must be bound to device memory

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pInfo must be a valid pointer to a valid VkCopyAccelerationStructureInfoKHR structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Compute

See Also

VkCopyAccelerationStructureInfoKHR

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pInfo - a pointer to a VkCopyAccelerationStructureInfoKHR structure defining the copy operation.

nvkCmdCopyAccelerationStructureToMemoryKHR

public static void nvkCmdCopyAccelerationStructureToMemoryKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                              long pInfo)

Unsafe version of: CmdCopyAccelerationStructureToMemoryKHR

vkCmdCopyAccelerationStructureToMemoryKHR

public static void vkCmdCopyAccelerationStructureToMemoryKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                             VkCopyAccelerationStructureToMemoryInfoKHR pInfo)

Copy an acceleration structure to device memory.

C Specification

To copy an acceleration structure to device memory call:

 void vkCmdCopyAccelerationStructureToMemoryKHR(
     VkCommandBuffer                             commandBuffer,
     const VkCopyAccelerationStructureToMemoryInfoKHR* pInfo);

Description

Accesses to pInfo\u2192src must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR. Accesses to the buffer indicated by pInfo\u2192dst.deviceAddress must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_TRANSFER_WRITE_BIT.

This command produces the same results as CopyAccelerationStructureToMemoryKHR, but writes its result to a device address, and is executed on the device rather than the host. The output may not necessarily be bit-for-bit identical, but it can be equally used by either CmdCopyMemoryToAccelerationStructureKHR or CopyMemoryToAccelerationStructureKHR.

The defined header structure for the serialized data consists of:

• UUID_SIZE bytes of data matching VkPhysicalDeviceIDProperties::driverUUID
• UUID_SIZE bytes of data identifying the compatibility for comparison using GetDeviceAccelerationStructureCompatibilityKHR
• A 64-bit integer of the total size matching the value queried using QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR
• A 64-bit integer of the deserialized size to be passed in to VkAccelerationStructureCreateInfoKHR::size
• A 64-bit integer of the count of the number of acceleration structure handles following. This will be zero for a bottom-level acceleration structure. For top-level acceleration structures this number is implementation-dependent; the number of and ordering of the handles may not match the instance descriptions which were used to build the acceleration structure.

The corresponding handles matching the values returned by GetAccelerationStructureDeviceAddressKHR or GetAccelerationStructureHandleNV are tightly packed in the buffer following the count. The application is expected to store a mapping between those handles and the original application-generated bottom-level acceleration structures to provide when deserializing. The serialized data is written to the buffer (or read from the buffer) according to the host endianness.

Valid Usage

• pInfo\u2192dst.deviceAddress must be a valid device address for a buffer bound to device memory
• pInfo\u2192dst.deviceAddress must be aligned to 256 bytes
• If the buffer pointed to by pInfo\u2192dst.deviceAddress is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
• The buffer used to create pInfo\u2192src must be bound to device memory

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pInfo must be a valid pointer to a valid VkCopyAccelerationStructureToMemoryInfoKHR structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Compute

See Also

VkCopyAccelerationStructureToMemoryInfoKHR

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pInfo - an a pointer to a VkCopyAccelerationStructureToMemoryInfoKHR structure defining the copy operation.

nvkCmdCopyMemoryToAccelerationStructureKHR

public static void nvkCmdCopyMemoryToAccelerationStructureKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                              long pInfo)

Unsafe version of: CmdCopyMemoryToAccelerationStructureKHR

vkCmdCopyMemoryToAccelerationStructureKHR

public static void vkCmdCopyMemoryToAccelerationStructureKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                             VkCopyMemoryToAccelerationStructureInfoKHR pInfo)

Copy device memory to an acceleration structure.

C Specification

To copy device memory to an acceleration structure call:

 void vkCmdCopyMemoryToAccelerationStructureKHR(
     VkCommandBuffer                             commandBuffer,
     const VkCopyMemoryToAccelerationStructureInfoKHR* pInfo);

Description

Accesses to pInfo\u2192dst must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR. Accesses to the buffer indicated by pInfo\u2192src.deviceAddress must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_TRANSFER_READ_BIT.

This command can accept acceleration structures produced by either CmdCopyAccelerationStructureToMemoryKHR or CopyAccelerationStructureToMemoryKHR.

The structure provided as input to deserialize is as described in CmdCopyAccelerationStructureToMemoryKHR, with any acceleration structure handles filled in with the newly-queried handles to bottom level acceleration structures created before deserialization. These do not need to be built at deserialize time, but must be created.

Valid Usage

• pInfo\u2192src.deviceAddress must be a valid device address for a buffer bound to device memory
• pInfo\u2192src.deviceAddress must be aligned to 256 bytes
• If the buffer pointed to by pInfo\u2192src.deviceAddress is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
• The buffer used to create pInfo\u2192dst must be bound to device memory

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pInfo must be a valid pointer to a valid VkCopyMemoryToAccelerationStructureInfoKHR structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Compute

See Also

VkCopyMemoryToAccelerationStructureInfoKHR

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pInfo - a pointer to a VkCopyMemoryToAccelerationStructureInfoKHR structure defining the copy operation.

nvkGetAccelerationStructureDeviceAddressKHR

public static long nvkGetAccelerationStructureDeviceAddressKHR(org.lwjgl.vulkan.VkDevice device,
                                                               long pInfo)

Unsafe version of: GetAccelerationStructureDeviceAddressKHR

vkGetAccelerationStructureDeviceAddressKHR

public static long vkGetAccelerationStructureDeviceAddressKHR(org.lwjgl.vulkan.VkDevice device,
                                                              VkAccelerationStructureDeviceAddressInfoKHR pInfo)

Query an address of a acceleration structure.

C Specification

To query the 64-bit device address for an acceleration structure, call:

 VkDeviceAddress vkGetAccelerationStructureDeviceAddressKHR(
     VkDevice                                    device,
     const VkAccelerationStructureDeviceAddressInfoKHR* pInfo);

Description

The 64-bit return value is an address of the acceleration structure, which can be used for device and shader operations that involve acceleration structures, such as ray traversal and acceleration structure building.

If the acceleration structure was created with a non-zero value of VkAccelerationStructureCreateInfoKHR::deviceAddress, the return value will be the same address.

If the acceleration structure was created with a type of ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR, the returned address must be consistent with the relative offset to other acceleration structures with type ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR allocated with the same VkBuffer. That is, the difference in returned addresses between the two must be the same as the difference in offsets provided at acceleration structure creation.

Note

The acceleration structure device address may be different from the buffer device address corresponding to the acceleration structure’s start offset in its storage buffer for acceleration structure types other than ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR.

Valid Usage

• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pInfo must be a valid pointer to a valid VkAccelerationStructureDeviceAddressInfoKHR structure

See Also

VkAccelerationStructureDeviceAddressInfoKHR

Parameters:

device - the logical device that the acceleration structure was created on.

pInfo - a pointer to a VkAccelerationStructureDeviceAddressInfoKHR structure specifying the acceleration structure to retrieve an address for.

nvkCmdWriteAccelerationStructuresPropertiesKHR

public static void nvkCmdWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                                  int accelerationStructureCount,
                                                                  long pAccelerationStructures,
                                                                  int queryType,
                                                                  long queryPool,
                                                                  int firstQuery)

Unsafe version of: CmdWriteAccelerationStructuresPropertiesKHR

Parameters:

accelerationStructureCount - the count of acceleration structures for which to query the property.

vkCmdWriteAccelerationStructuresPropertiesKHR

public static void vkCmdWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                                 java.nio.LongBuffer pAccelerationStructures,
                                                                 int queryType,
                                                                 long queryPool,
                                                                 int firstQuery)

Write acceleration structure result parameters to query results.

C Specification

To query acceleration structure size parameters call:

 void vkCmdWriteAccelerationStructuresPropertiesKHR(
     VkCommandBuffer                             commandBuffer,
     uint32_t                                    accelerationStructureCount,
     const VkAccelerationStructureKHR*           pAccelerationStructures,
     VkQueryType                                 queryType,
     VkQueryPool                                 queryPool,
     uint32_t                                    firstQuery);

Description

Accesses to any of the acceleration structures listed in pAccelerationStructures must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR.

• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR, then the value written out is the number of bytes required by a compacted acceleration structure.
• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR, then the value written out is the number of bytes required by a serialized acceleration structure.

Valid Usage

• queryPool must have been created with a queryType matching queryType
• The queries identified by queryPool and firstQuery must be unavailable
• The buffer used to create each acceleration structure in pAccelerationStructures must be bound to device memory
• The sum of query plus accelerationStructureCount must be less than or equal to the number of queries in queryPool

• All acceleration structures in pAccelerationStructures must have been built prior to the execution of this command
• All acceleration structures in pAccelerationStructures 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 VkCommandBuffer handle
• pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid VkAccelerationStructureKHR handles
• queryType must be a valid VkQueryType value
• queryPool must be a valid VkQueryPool handle
• commandBuffer must be in the recording state
• The VkCommandPool 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 VkDevice

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Compute

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pAccelerationStructures - a pointer to an array of existing previously built acceleration structures.

queryType - a VkQueryType value specifying the type of queries managed by the pool.

queryPool - the query pool that will manage the results of the query.

firstQuery - the first query index within the query pool that will contain the accelerationStructureCount number of results.

nvkGetDeviceAccelerationStructureCompatibilityKHR

public static void nvkGetDeviceAccelerationStructureCompatibilityKHR(org.lwjgl.vulkan.VkDevice device,
                                                                     long pVersionInfo,
                                                                     long pCompatibility)

Unsafe version of: GetDeviceAccelerationStructureCompatibilityKHR

vkGetDeviceAccelerationStructureCompatibilityKHR

public static void vkGetDeviceAccelerationStructureCompatibilityKHR(org.lwjgl.vulkan.VkDevice device,
                                                                    VkAccelerationStructureVersionInfoKHR pVersionInfo,
                                                                    java.nio.IntBuffer pCompatibility)

Check if a serialized acceleration structure is compatible with the current device.

C Specification

To check if a serialized acceleration structure is compatible with the current device call:

 void vkGetDeviceAccelerationStructureCompatibilityKHR(
     VkDevice                                    device,
     const VkAccelerationStructureVersionInfoKHR* pVersionInfo,
     VkAccelerationStructureCompatibilityKHR*    pCompatibility);

Valid Usage

• The rayTracingPipeline or rayQuery feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pVersionInfo must be a valid pointer to a valid VkAccelerationStructureVersionInfoKHR structure
• pCompatibility must be a valid pointer to a VkAccelerationStructureCompatibilityKHR value

See Also

VkAccelerationStructureVersionInfoKHR

Parameters:

device - the device to check the version against.

pVersionInfo - a pointer to a VkAccelerationStructureVersionInfoKHR structure specifying version information to check against the device.

pCompatibility - a pointer to a VkAccelerationStructureCompatibilityKHR value in which compatibility information is returned.

nvkGetAccelerationStructureBuildSizesKHR

public static void nvkGetAccelerationStructureBuildSizesKHR(org.lwjgl.vulkan.VkDevice device,
                                                            int buildType,
                                                            long pBuildInfo,
                                                            long pMaxPrimitiveCounts,
                                                            long pSizeInfo)

Unsafe version of: GetAccelerationStructureBuildSizesKHR

vkGetAccelerationStructureBuildSizesKHR

public static void vkGetAccelerationStructureBuildSizesKHR(org.lwjgl.vulkan.VkDevice device,
                                                           int buildType,
                                                           VkAccelerationStructureBuildGeometryInfoKHR pBuildInfo,
                                                           @Nullable
                                                           java.nio.IntBuffer pMaxPrimitiveCounts,
                                                           VkAccelerationStructureBuildSizesInfoKHR pSizeInfo)

Retrieve the required size for an acceleration structure.

C Specification

To get the build sizes for an acceleration structure, call:

 void vkGetAccelerationStructureBuildSizesKHR(
     VkDevice                                    device,
     VkAccelerationStructureBuildTypeKHR         buildType,
     const VkAccelerationStructureBuildGeometryInfoKHR* pBuildInfo,
     const uint32_t*                             pMaxPrimitiveCounts,
     VkAccelerationStructureBuildSizesInfoKHR*   pSizeInfo);

Description

The srcAccelerationStructure, dstAccelerationStructure, and mode members of pBuildInfo are ignored. Any VkDeviceOrHostAddressKHR members of pBuildInfo are ignored by this command, except that the hostAddress member of VkAccelerationStructureGeometryTrianglesDataKHR::transformData will be examined to check if it is NULL.

An acceleration structure created with the accelerationStructureSize returned by this command supports any build or update with a VkAccelerationStructureBuildGeometryInfoKHR structure and array of VkAccelerationStructureBuildRangeInfoKHR structures subject to the following properties:

• The build command is a host build command, and buildType is ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_KHR or ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR
• The build command is a device build command, and buildType is ACCELERATION_STRUCTURE_BUILD_TYPE_DEVICE_KHR or ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR
• For VkAccelerationStructureBuildGeometryInfoKHR:
  • Its type, and flags members are equal to pBuildInfo\u2192type and pBuildInfo\u2192flags, respectively.
  • geometryCount is less than or equal to pBuildInfo\u2192geometryCount.
  • For each element of either pGeometries or ppGeometries at a given index, its geometryType member is equal to pBuildInfo\u2192geometryType.
  • For each element of either pGeometries or ppGeometries at a given index, with a geometryType member equal to GEOMETRY_TYPE_TRIANGLES_KHR, the vertexFormat and indexType members of geometry.triangles are equal to the corresponding members of the same element in pBuildInfo.
  • For each element of either pGeometries or ppGeometries at a given index, with a geometryType member equal to GEOMETRY_TYPE_TRIANGLES_KHR, the maxVertex member of geometry.triangles is less than or equal to the corresponding member of the same element in pBuildInfo.
  • For each element of either pGeometries or ppGeometries at a given index, with a geometryType member equal to GEOMETRY_TYPE_TRIANGLES_KHR, if the applicable address in the transformData member of geometry.triangles is not NULL, the corresponding transformData.hostAddress parameter in pBuildInfo is not NULL.
• For each VkAccelerationStructureBuildRangeInfoKHR corresponding to the VkAccelerationStructureBuildGeometryInfoKHR:
  • Its primitiveCount member is less than or equal to the corresponding element of pMaxPrimitiveCounts.

Similarly, the updateScratchSize value will support any build command specifying the BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR mode under the above conditions, and the buildScratchSize value will support any build command specifying the BUILD_ACCELERATION_STRUCTURE_MODE_BUILD_KHR mode under the above conditions.

Valid Usage

• The rayTracingPipeline or rayQuery feature must be enabled
• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled
• If pBuildInfo\u2192geometryCount is not 0, pMaxPrimitiveCounts must be a valid pointer to an array of pBuildInfo\u2192geometryCount uint32_t values
• If pBuildInfo\u2192pGeometries or pBuildInfo\u2192ppGeometries has a geometryType of GEOMETRY_TYPE_INSTANCES_KHR, each pMaxPrimitiveCounts[i] must be less than or equal to VkPhysicalDeviceAccelerationStructurePropertiesKHR::maxInstanceCount

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• buildType must be a valid VkAccelerationStructureBuildTypeKHR value
• pBuildInfo must be a valid pointer to a valid VkAccelerationStructureBuildGeometryInfoKHR structure
• If pMaxPrimitiveCounts is not NULL, pMaxPrimitiveCounts must be a valid pointer to an array of pBuildInfo\u2192geometryCount uint32_t values
• pSizeInfo must be a valid pointer to a VkAccelerationStructureBuildSizesInfoKHR structure

See Also

VkAccelerationStructureBuildGeometryInfoKHR, VkAccelerationStructureBuildSizesInfoKHR

Parameters:

device - the logical device that will be used for creating the acceleration structure.

buildType - defines whether host or device operations (or both) are being queried for.

pBuildInfo - a pointer to a VkAccelerationStructureBuildGeometryInfoKHR structure describing parameters of a build operation.

pMaxPrimitiveCounts - a pointer to an array of pBuildInfo\u2192geometryCount uint32_t values defining the number of primitives built into each geometry.

pSizeInfo - a pointer to a VkAccelerationStructureBuildSizesInfoKHR structure which returns the size required for an acceleration structure and the sizes required for the scratch buffers, given the build parameters.

vkCreateAccelerationStructureKHR

public static int vkCreateAccelerationStructureKHR(org.lwjgl.vulkan.VkDevice device,
                                                   VkAccelerationStructureCreateInfoKHR pCreateInfo,
                                                   @Nullable
                                                   VkAllocationCallbacks pAllocator,
                                                   long[] pAccelerationStructure)

Array version of: CreateAccelerationStructureKHR

vkCmdBuildAccelerationStructuresIndirectKHR

public static void vkCmdBuildAccelerationStructuresIndirectKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                               VkAccelerationStructureBuildGeometryInfoKHR.Buffer pInfos,
                                                               long[] pIndirectDeviceAddresses,
                                                               int[] pIndirectStrides,
                                                               org.lwjgl.PointerBuffer ppMaxPrimitiveCounts)

Array version of: CmdBuildAccelerationStructuresIndirectKHR

vkWriteAccelerationStructuresPropertiesKHR

public static int vkWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkDevice device,
                                                             long[] pAccelerationStructures,
                                                             int queryType,
                                                             java.nio.ByteBuffer pData,
                                                             long stride)

Array version of: WriteAccelerationStructuresPropertiesKHR

vkCmdWriteAccelerationStructuresPropertiesKHR

public static void vkCmdWriteAccelerationStructuresPropertiesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                                 long[] pAccelerationStructures,
                                                                 int queryType,
                                                                 long queryPool,
                                                                 int firstQuery)

Array version of: CmdWriteAccelerationStructuresPropertiesKHR

vkGetDeviceAccelerationStructureCompatibilityKHR

public static void vkGetDeviceAccelerationStructureCompatibilityKHR(org.lwjgl.vulkan.VkDevice device,
                                                                    VkAccelerationStructureVersionInfoKHR pVersionInfo,
                                                                    int[] pCompatibility)

Array version of: GetDeviceAccelerationStructureCompatibilityKHR

vkGetAccelerationStructureBuildSizesKHR

public static void vkGetAccelerationStructureBuildSizesKHR(org.lwjgl.vulkan.VkDevice device,
                                                           int buildType,
                                                           VkAccelerationStructureBuildGeometryInfoKHR pBuildInfo,
                                                           @Nullable
                                                           int[] pMaxPrimitiveCounts,
                                                           VkAccelerationStructureBuildSizesInfoKHR pSizeInfo)

Array version of: GetAccelerationStructureBuildSizesKHR