vkCopyImageToImageEXT(3)

# vkCopyImageToImageEXT(3) Manual Page

## Name

vkCopyImageToImageEXT - Copy image data using the host

Loading… please wait.

## C Specification

To copy data from an image object to another image object using the host, call:

    // Provided by VK_EXT_host_image_copy
    VkResult vkCopyImageToImageEXT(
        VkDevice                                    device,
        const VkCopyImageToImageInfoEXT*            pCopyImageToImageInfo);

## Parameters

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

- `pCopyImageToImageInfo` is a pointer to a VkCopyImageToImageInfoEXT structure describing the copy parameters.

## Description

This command is functionally similar to vkCmdCopyImage2, except it is executed on the host.

Valid Usage

- VUID-vkCopyImageToImageEXT-hostImageCopy-09068
  The `hostImageCopy` feature must be enabled

Valid Usage (Implicit)

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

- VUID-vkCopyImageToImageEXT-pCopyImageToImageInfo-parameter
  `pCopyImageToImageInfo` must be a valid pointer to a valid VkCopyImageToImageInfoEXT 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, VkCopyImageToImageInfoEXT, 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