VkCopyAccelerationStructureToMemoryInfoKHR(3)

Name

VkCopyAccelerationStructureToMemoryInfoKHR - Parameters for serializing an acceleration structure

C Specification

// Provided by VK_KHR_acceleration_structure
typedef struct VkCopyAccelerationStructureToMemoryInfoKHR {
    VkStructureType                       sType;
    const void*                           pNext;
    VkAccelerationStructureKHR            src;
    VkDeviceOrHostAddressKHR              dst;
    VkCopyAccelerationStructureModeKHR    mode;
} VkCopyAccelerationStructureToMemoryInfoKHR;

Members

  • sType is a VkStructureType value identifying this structure.

  • pNext is NULL or a pointer to a structure extending this structure.

  • src is the source acceleration structure for the copy.

  • dst is the device or host address of memory which is the target for the copy.

  • mode is a VkCopyAccelerationStructureModeKHR value specifying additional operations to perform during the copy.

Description

Valid Usage

  • VUID-VkCopyAccelerationStructureToMemoryInfoKHR-src-04959
    The source acceleration structure src must have been constructed prior to the execution of this command

  • VUID-VkCopyAccelerationStructureToMemoryInfoKHR-src-11582
    If the source acceleration structure src was constructed through deserialization, all micromap arrays the acceleration structure references that were not replaced by an acceleration structure update command must have been deserialized using the serialized data of the corresponding micromaps used to originally build the acceleration structure prior to the execution of this command

  • VUID-VkCopyAccelerationStructureToMemoryInfoKHR-dst-03561
    The memory pointed to by dst must be at least as large as the serialization size of src, as reported by vkWriteAccelerationStructuresPropertiesKHR or vkCmdWriteAccelerationStructuresPropertiesKHR with a query type of VK_QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR

  • VUID-VkCopyAccelerationStructureToMemoryInfoKHR-mode-03412
    mode must be VK_COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR

  • VUID-VkCopyAccelerationStructureToMemoryInfoKHR-mode-11714
    The range of src accessed by this command must be fully backed by physical memory

  • VUID-VkCopyAccelerationStructureToMemoryInfoKHR-mode-11715
    The range of dst accessed by this command must be fully backed by physical memory

Valid Usage (Implicit)

See Also

VK_KHR_acceleration_structure, VkAccelerationStructureKHR, VkCopyAccelerationStructureModeKHR, VkDeviceOrHostAddressKHR, VkStructureType, vkCmdCopyAccelerationStructureToMemoryKHR, vkCopyAccelerationStructureToMemoryKHR

Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.