vkCopyImageToMemoryEXT(3)

# vkCopyImageToMemoryEXT(3) Manual Page

## Name

vkCopyImageToMemoryEXT - Copy image data into host memory

Loading… please wait.

## C Specification

To copy data from an image object to host memory, call:

    // Provided by VK_EXT_host_image_copy
    VkResult vkCopyImageToMemoryEXT(
        VkDevice                                    device,
        const VkCopyImageToMemoryInfoEXT*           pCopyImageToMemoryInfo);

## Parameters

- `device` is the device which owns `pCopyImageToMemoryInfo->srcImage`.

- `pCopyImageToMemoryInfo` is a pointer to a VkCopyImageToMemoryInfoEXT structure describing the copy parameters.

## Description

This command is functionally similar to vkCmdCopyImageToBuffer2, except it is executed on the host and writes to host memory instead of a buffer.

Valid Usage

- VUID-vkCopyImageToMemoryEXT-hostImageCopy-09063
  The `hostImageCopy` feature must be enabled

Valid Usage (Implicit)

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

- VUID-vkCopyImageToMemoryEXT-pCopyImageToMemoryInfo-parameter
  `pCopyImageToMemoryInfo` must be a valid pointer to a valid VkCopyImageToMemoryInfoEXT structure

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_INITIALIZATION_FAILED`

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_OUT_OF_DEVICE_MEMORY`

  - `VK_ERROR_MEMORY_MAP_FAILED`

## See Also

VK_EXT_host_image_copy, VkCopyImageToMemoryInfoEXT, 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