vkCopyImageToImage(3)

Name

vkCopyImageToImage - Copy image data using the host

C Specification

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

// Provided by VK_VERSION_1_4VkResult vkCopyImageToImage(    VkDevice                                    device,    const VkCopyImageToImageInfo*               pCopyImageToImageInfo);

// Provided by VK_EXT_host_image_copy// Equivalent to vkCopyImageToImageVkResult vkCopyImageToImageEXT(    VkDevice                                    device,    const VkCopyImageToImageInfo*               pCopyImageToImageInfo);

Parameters

device is the device which ownspCopyImageToImageInfo->srcImage andpCopyImageToImageInfo->dstImage.
pCopyImageToImageInfo is a pointer to aVkCopyImageToImageInfo structure describing the copy parameters.

Description

This command is functionally similar tovkCmdCopyImage2, except it isexecuted on the host.The memory ofpCopyImageToImageInfo->srcImage andpCopyImageToImageInfo->dstImage is accessed by the host as ifcoherent.

If the device has written to the memory ofpCopyImageToImageInfo->srcImage, it is not automatically madeavailable to the host.Before this copy command can be called, a memory barrier for this imagemust have been issued on the device with the secondsynchronization scope includingVK_PIPELINE_STAGE_HOST_BIT andVK_ACCESS_HOST_READ_BIT.

Because queue submissionsautomatically make host memory visible to the device, there would not be aneed for a memory barrier before using the results of this copy operation inpCopyMemoryToImageInfo->dstImage on the device.

Valid Usage (Implicit)

VUID-vkCopyImageToImage-device-parameter
devicemust be a validVkDevice handle
VUID-vkCopyImageToImage-pCopyImageToImageInfo-parameter
pCopyImageToImageInfomust be a valid pointer to a validVkCopyImageToImageInfo structure

Return Codes

Success

VK_SUCCESS

Failure

Document Notes

For more information, see theVulkan Specification.

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

Movatterモバイル変換