vkGetImageOpaqueCaptureDescriptorDataEXT(3)

# vkGetImageOpaqueCaptureDescriptorDataEXT(3) Manual Page

## Name

vkGetImageOpaqueCaptureDescriptorDataEXT - Get image opaque capture descriptor data

Loading… please wait.

## C Specification

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

    // Provided by VK_EXT_descriptor_buffer
    VkResult vkGetImageOpaqueCaptureDescriptorDataEXT(
        VkDevice                                    device,
        const VkImageCaptureDescriptorDataInfoEXT*  pInfo,
        void*                                       pData);

## Parameters

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

- `pInfo` is a pointer to a VkImageCaptureDescriptorDataInfoEXT structure specifying the image.

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

## Description

Valid Usage

- VUID-vkGetImageOpaqueCaptureDescriptorDataEXT-None-08076
  The descriptorBufferCaptureReplay feature must be enabled

- VUID-vkGetImageOpaqueCaptureDescriptorDataEXT-pData-08077
  `pData` must point to a buffer that is at least VkPhysicalDeviceDescriptorBufferPropertiesEXT::`imageCaptureReplayDescriptorDataSize` bytes in size

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

Valid Usage (Implicit)

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

- VUID-vkGetImageOpaqueCaptureDescriptorDataEXT-pInfo-parameter
  `pInfo` must be a valid pointer to a valid VkImageCaptureDescriptorDataInfoEXT structure

- VUID-vkGetImageOpaqueCaptureDescriptorDataEXT-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, VkDevice, VkImageCaptureDescriptorDataInfoEXT

## 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-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0