vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT(3)

# vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT(3) Manual Page

## Name

vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT - Get acceleration structure opaque capture descriptor data

Loading… please wait.

## C Specification

To get the opaque capture descriptor data for an acceleration structure, call:

    // Provided by VK_EXT_descriptor_buffer with VK_KHR_acceleration_structure or VK_NV_ray_tracing
    VkResult vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT(
        VkDevice                                    device,
        const VkAccelerationStructureCaptureDescriptorDataInfoEXT* pInfo,
        void*                                       pData);

## Parameters

- `device` is the logical device that gets the data.

- `pInfo` is a pointer to a VkAccelerationStructureCaptureDescriptorDataInfoEXT structure specifying the acceleration structure.

- `pData` is a pointer to a user-allocated buffer where the data will be written.

## Description

Valid Usage

- VUID-vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT-None-08088
  The `descriptorBufferCaptureReplay` feature must be enabled

- VUID-vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT-pData-08089
  `pData` must point to a buffer that is at least VkPhysicalDeviceDescriptorBufferPropertiesEXT::`accelerationStructureCaptureReplayDescriptorDataSize` bytes in size

- VUID-vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT-device-08090
  If `device` was created with multiple physical devices, then the `bufferDeviceAddressMultiDevice` feature must be enabled

Valid Usage (Implicit)

- VUID-vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT-pInfo-parameter
  `pInfo` must be a valid pointer to a valid VkAccelerationStructureCaptureDescriptorDataInfoEXT structure

- VUID-vkGetAccelerationStructureOpaqueCaptureDescriptorDataEXT-pData-parameter
  `pData` must be a pointer value

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_OUT_OF_DEVICE_MEMORY`

## See Also

VK_EXT_descriptor_buffer, VK_KHR_acceleration_structure, VK_NV_ray_tracing, VkAccelerationStructureCaptureDescriptorDataInfoEXT, VkDevice

## 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.

## Copyright

Copyright 2014-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0