vkCopyMemoryToImage - Copy data from host memory into an image

Description

This command is functionally similar to cmdCopyBufferToImage2, except it is executed on the host and reads from host memory instead of a buffer. The memory of pCopyMemoryToImageInfo->dstImage is accessed by the host as if coherent.

Because queue submissions automatically make host memory visible to the device, there would not be a need for a memory barrier before using the results of this copy operation on the device.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED
• ERROR_MEMORY_MAP_FAILED
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, CopyMemoryToImageInfo, Device

vkCopyImageToMemory - Copy image data into host memory

Description

This command is functionally similar to cmdCopyImageToBuffer2, except it is executed on the host and writes to host memory instead of a buffer. The memory of pCopyImageToMemoryInfo->srcImage is accessed by the host as if coherent.

If the device has written to the image memory, it is not automatically made available to the host. Before this copy command can be called, a memory barrier for this image must have been issued on the device with the second synchronization scope including PIPELINE_STAGE_HOST_BIT and ACCESS_HOST_READ_BIT.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED
• ERROR_MEMORY_MAP_FAILED
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, CopyImageToMemoryInfo, Device

vkCopyImageToImage - Copy image data using the host

Description

This command is functionally similar to cmdCopyImage2, except it is executed on the host. The memory of pCopyImageToImageInfo->srcImage and pCopyImageToImageInfo->dstImage is accessed by the host as if coherent.

If the device has written to the memory of pCopyImageToImageInfo->srcImage, it is not automatically made available to the host. Before this copy command can be called, a memory barrier for this image must have been issued on the device with the second synchronization scope including PIPELINE_STAGE_HOST_BIT and ACCESS_HOST_READ_BIT.

Because queue submissions automatically make host memory visible to the device, there would not be a need for a memory barrier before using the results of this copy operation in pCopyMemoryToImageInfo->dstImage on the device.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED
• ERROR_MEMORY_MAP_FAILED
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, CopyImageToImageInfo, Device

vkTransitionImageLayout - Perform an image layout transition on the host

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED
• ERROR_MEMORY_MAP_FAILED
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, Device, HostImageLayoutTransitionInfo

VkPhysicalDeviceHostImageCopyFeatures - Structure indicating support for copies to or from images from host memory

Members

This structure describes the following feature:

Description

If the PhysicalDeviceHostImageCopyFeatures structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceHostImageCopyFeatures, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Valid Usage (Implicit)

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, Bool32, StructureType

VkPhysicalDeviceHostImageCopyProperties - Structure enumerating image layouts supported by an implementation for host memory copies

Description

• copySrcLayoutCount is an integer related to the number of image layouts for host copies from images available or queried, as described below.

• pCopySrcLayouts is a pointer to an array of ImageLayout in which supported image layouts for use with host copy operations from images are returned.
• copyDstLayoutCount is an integer related to the number of image layouts for host copies to images available or queried, as described below.
• pCopyDstLayouts is a pointer to an array of ImageLayout in which supported image layouts for use with host copy operations to images are returned.
• optimalTilingLayoutUUID is an array of UUID_SIZE uint8_t values representing a universally unique identifier for the implementation’s swizzling layout of images created with IMAGE_TILING_OPTIMAL.
• identicalMemoryTypeRequirements indicates that specifying the IMAGE_USAGE_HOST_TRANSFER_BIT flag in ImageCreateInfo::usage does not affect the memory type requirements of the image.

If the PhysicalDeviceHostImageCopyProperties structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

If pCopyDstLayouts is NULL, then the number of image layouts that are supported in CopyMemoryToImageInfo::dstImageLayout and CopyImageToImageInfo::dstImageLayout is returned in copyDstLayoutCount. Otherwise, copyDstLayoutCount must be set by the application to the number of elements in the pCopyDstLayouts array, and on return is overwritten with the number of values actually written to pCopyDstLayouts. If the value of copyDstLayoutCount is less than the number of image layouts that are supported, at most copyDstLayoutCount values will be written to pCopyDstLayouts. The implementation must include the IMAGE_LAYOUT_GENERAL image layout in pCopyDstLayouts. If the unifiedImageLayouts feature is supported, the implementation must include all the image layouts that are interchangeable with IMAGE_LAYOUT_GENERAL in pCopyDstLayouts.

If pCopySrcLayouts is NULL, then the number of image layouts that are supported in CopyImageToMemoryInfo::srcImageLayout and CopyImageToImageInfo::srcImageLayout is returned in copySrcLayoutCount. Otherwise, copySrcLayoutCount must be set by the application to the number of elements in the pCopySrcLayouts array, and on return is overwritten with the number of values actually written to pCopySrcLayouts. If the value of copySrcLayoutCount is less than the number of image layouts that are supported, at most copySrcLayoutCount values will be written to pCopySrcLayouts. The implementation must include the IMAGE_LAYOUT_GENERAL image layout in pCopySrcLayouts. If the unifiedImageLayouts feature is supported, the implementation must include all the image layouts that are interchangeable with IMAGE_LAYOUT_GENERAL in pCopySrcLayouts.

The optimalTilingLayoutUUID value can be used to ensure compatible data layouts when using the HOST_IMAGE_COPY_MEMCPY_BIT flag in copyMemoryToImage and copyImageToMemory.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES

• If copySrcLayoutCount is not 0, and pCopySrcLayouts is not NULL, pCopySrcLayouts must be a valid pointer to an array of copySrcLayoutCount ImageLayout values
• If copyDstLayoutCount is not 0, and pCopyDstLayouts is not NULL, pCopyDstLayouts must be a valid pointer to an array of copyDstLayoutCount ImageLayout values

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, Bool32, ImageLayout, StructureType

VkMemoryToImageCopy - Structure specifying a host memory to image copy operation

Description

This structure is functionally similar to BufferImageCopy2, except it defines host memory as the source of copy instead of a buffer. In particular, the same data packing rules and restrictions as that structure apply here as well.

Valid Usage

• pHostPointer must point to memory that is large enough to contain all memory locations that are accessed according to Buffer and Image Addressing, for each element of pRegions

• The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory
• memoryRowLength must be 0, or greater than or equal to the width member of imageExtent
• memoryImageHeight must be 0, or greater than or equal to the height member of imageExtent
• The aspectMask member of imageSubresource must only have a single bit set
• imageExtent.width must not be 0
• imageExtent.height must not be 0
• imageExtent.depth must not be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY

• pNext must be NULL
• pHostPointer must be a pointer value
• imageSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, CopyMemoryToImageInfo, Extent3D, ImageSubresourceLayers, Offset3D, StructureType

VkImageToMemoryCopy - Structure specifying an image to host memory copy operation

Description

This structure is functionally similar to BufferImageCopy2, except it defines host memory as the target of copy instead of a buffer. In particular, the same data packing rules and restrictions as that structure apply here as well.

Valid Usage

• pHostPointer must point to memory that is large enough to contain all memory locations that are accessed according to Buffer and Image Addressing, for each element of pRegions

• The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory
• memoryRowLength must be 0, or greater than or equal to the width member of imageExtent
• memoryImageHeight must be 0, or greater than or equal to the height member of imageExtent
• The aspectMask member of imageSubresource must only have a single bit set
• imageExtent.width must not be 0
• imageExtent.height must not be 0
• imageExtent.depth must not be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY

• pNext must be NULL
• pHostPointer must be a pointer value
• imageSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, CopyImageToMemoryInfo, Extent3D, ImageSubresourceLayers, Offset3D, StructureType

VkCopyMemoryToImageInfo - Structure specifying parameters of host memory to image copy command

Description

copyMemoryToImage does not check whether the device memory associated with dstImage is currently in use before performing the copy. The application must guarantee that any previously submitted command that reads from or writes to the copy regions has completed before the host performs the copy.

Copy regions for the image must be aligned to a multiple of the texel block extent in each dimension, except at the edges of the image, where region extents must match the edge of the image.

Valid Usage

• If dstImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory

• If the stencil aspect of dstImage is accessed, and dstImage was not created with separate stencil usage, dstImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If the stencil aspect of dstImage is accessed, and dstImage was created with separate stencil usage, dstImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If non-stencil aspects of dstImage are accessed, dstImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If flags contains HOST_IMAGE_COPY_MEMCPY_BIT, the x, y, and z members of the imageOffset member of each element of pRegions must be 0
• If flags contains HOST_IMAGE_COPY_MEMCPY_BIT, the imageExtent member of each element of pRegions must equal the extents of dstImage identified by imageSubresource
• If dstImage is non-sparse then the image or each specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
• The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when dstImage was created
• If imageSubresource.layerCount is not REMAINING_ARRAY_LAYERS, imageSubresource.baseArrayLayer + imageSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in ImageCreateInfo when dstImage was created
• dstImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• For each element of pRegions, imageOffset.x and (imageExtent.width + imageOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified imageSubresource of dstImage
• For each element of pRegions, imageOffset.y and (imageExtent.height + imageOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified imageSubresource of dstImage
• dstImage must have a sample count equal to SAMPLE_COUNT_1_BIT
• If dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, imageOffset.y must be 0 and imageExtent.height must be 1
• For each element of pRegions, imageOffset.z and (imageExtent.depth + imageOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified imageSubresource of dstImage
• If dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, imageOffset.z must be 0 and imageExtent.depth must be 1
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, imageOffset.x must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and imageOffset.x does not equal the width of the subresource specified by imageSubresource, imageOffset.x must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, imageOffset.y must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and imageOffset.y does not equal the height of the subresource specified by imageSubresource, imageOffset.y must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, imageOffset.z must be a multiple of the texel block extent depth of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of imageOffset.x and extent.width does not equal the width of the subresource specified by imageSubresource, extent.width must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of imageOffset.x and extent.height must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of imageOffset.x and extent.width must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of imageOffset.x and extent.height does not equal the width of the subresource specified by imageSubresource, extent.height must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of imageOffset.y and extent.height does not equal the height of the subresource specified by imageSubresource, extent.height must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of imageOffset.y and extent.width does not equal the height of the subresource specified by imageSubresource, extent.width must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of imageOffset.y and extent.height must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of imageOffset.y and extent.width must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if the sum of imageOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the Format of dstImage
• For each element of pRegions, imageSubresource.aspectMask must specify aspects present in dstImage
• If dstImage has a multi-planar format, then for each element of pRegions, imageSubresource.aspectMask must be a single valid multi-planar aspect mask bit
• If dstImage is of type IMAGE_TYPE_3D, for each element of pRegions, imageSubresource.baseArrayLayer must be 0 and imageSubresource.layerCount must be 1
• For each element of pRegions, memoryRowLength must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, memoryImageHeight must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, memoryRowLength divided by the texel block extent width and then multiplied by the texel block size of dstImage must be less than or equal to 231-1
• dstImageLayout must specify the current layout of the image subresources of dstImage specified in pRegions
• dstImageLayout must be one of the image layouts returned in PhysicalDeviceHostImageCopyProperties::pCopyDstLayouts
• If flags includes HOST_IMAGE_COPY_MEMCPY_BIT, for each region in pRegions, memoryRowLength and memoryImageHeight must both be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO

• pNext must be NULL
• flags must be a valid combination of HostImageCopyFlagBits values
• dstImage must be a valid Image handle
• dstImageLayout must be a valid ImageLayout value
• pRegions must be a valid pointer to an array of regionCount valid MemoryToImageCopy structures
• regionCount must be greater than 0

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, HostImageCopyFlags, Image, ImageLayout, MemoryToImageCopy, StructureType, copyMemoryToImage, copyMemoryToImage

VkCopyImageToMemoryInfo - Structure specifying parameters of an image to host memory copy command

Description

copyImageToMemory does not check whether the device memory associated with srcImage is currently in use before performing the copy. The application must guarantee that any previously submitted command that writes to the copy regions has completed before the host performs the copy.

Copy regions for the image must be aligned to a multiple of the texel block extent in each dimension, except at the edges of the image, where region extents must match the edge of the image.

Valid Usage

• If srcImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory

• If the stencil aspect of srcImage is accessed, and srcImage was not created with separate stencil usage, srcImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If the stencil aspect of srcImage is accessed, and srcImage was created with separate stencil usage, srcImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If non-stencil aspects of srcImage are accessed, srcImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If flags contains HOST_IMAGE_COPY_MEMCPY_BIT, the x, y, and z members of the imageOffset member of each element of pRegions must be 0
• If flags contains HOST_IMAGE_COPY_MEMCPY_BIT, the imageExtent member of each element of pRegions must equal the extents of srcImage identified by imageSubresource
• If srcImage is non-sparse then the image or each specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
• The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when srcImage was created
• If imageSubresource.layerCount is not REMAINING_ARRAY_LAYERS, imageSubresource.baseArrayLayer + imageSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in ImageCreateInfo when srcImage was created
• srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• For each element of pRegions, imageOffset.x and (imageExtent.width + imageOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified imageSubresource of srcImage
• For each element of pRegions, imageOffset.y and (imageExtent.height + imageOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified imageSubresource of srcImage
• srcImage must have a sample count equal to SAMPLE_COUNT_1_BIT
• If srcImage is of type IMAGE_TYPE_1D, then for each element of pRegions, imageOffset.y must be 0 and imageExtent.height must be 1
• For each element of pRegions, imageOffset.z and (imageExtent.depth + imageOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified imageSubresource of srcImage
• If srcImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, imageOffset.z must be 0 and imageExtent.depth must be 1
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, imageOffset.x must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and imageOffset.x does not equal the width of the subresource specified by imageSubresource, imageOffset.x must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, imageOffset.y must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and imageOffset.y does not equal the height of the subresource specified by imageSubresource, imageOffset.y must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, imageOffset.z must be a multiple of the texel block extent depth of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of imageOffset.x and extent.width does not equal the width of the subresource specified by imageSubresource, extent.width must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of imageOffset.x and extent.height must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of imageOffset.x and extent.width must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of imageOffset.x and extent.height does not equal the width of the subresource specified by imageSubresource, extent.height must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of imageOffset.y and extent.height does not equal the height of the subresource specified by imageSubresource, extent.height must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of imageOffset.y and extent.width does not equal the height of the subresource specified by imageSubresource, extent.width must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of imageOffset.y and extent.height must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of imageOffset.y and extent.width must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if the sum of imageOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the Format of srcImage
• For each element of pRegions, imageSubresource.aspectMask must specify aspects present in srcImage
• If srcImage has a multi-planar format, then for each element of pRegions, imageSubresource.aspectMask must be a single valid multi-planar aspect mask bit
• If srcImage is of type IMAGE_TYPE_3D, for each element of pRegions, imageSubresource.baseArrayLayer must be 0 and imageSubresource.layerCount must be 1
• For each element of pRegions, memoryRowLength must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, memoryImageHeight must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, memoryRowLength divided by the texel block extent width and then multiplied by the texel block size of srcImage must be less than or equal to 231-1
• srcImageLayout must specify the current layout of the image subresources of srcImage specified in pRegions
• srcImageLayout must be one of the image layouts returned in PhysicalDeviceHostImageCopyProperties::pCopySrcLayouts
• If flags includes HOST_IMAGE_COPY_MEMCPY_BIT, for each region in pRegions, memoryRowLength and memoryImageHeight must both be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO

• pNext must be NULL
• flags must be a valid combination of HostImageCopyFlagBits values
• srcImage must be a valid Image handle
• srcImageLayout must be a valid ImageLayout value
• pRegions must be a valid pointer to an array of regionCount valid ImageToMemoryCopy structures
• regionCount must be greater than 0

See Also

VK_EXT_host_image_copy, VK_VERSION_1_4, HostImageCopyFlags, Image, ImageLayout, ImageToMemoryCopy, StructureType, copyImageToMemory, copyImageToMemory

VkCopyImageToImageInfo - Structure specifying parameters of an image to image host copy command

Description

copyImageToImage does not check whether the device memory associated with srcImage or dstImage is currently in use before performing the copy. The application must guarantee that any previously submitted command that writes to the copy regions has completed before the host performs the copy.

Valid Usage

• srcImage and dstImage must have been created with identical image creation parameters

• If srcImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory
• If the stencil aspect of srcImage is accessed, and srcImage was not created with separate stencil usage, srcImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If the stencil aspect of srcImage is accessed, and srcImage was created with separate stencil usage, srcImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If non-stencil aspects of srcImage are accessed, srcImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If flags contains HOST_IMAGE_COPY_MEMCPY_BIT, the x, y, and z members of the srcOffset member of each element of pRegions must be 0
• If flags contains HOST_IMAGE_COPY_MEMCPY_BIT, the extent member of each element of pRegions must equal the extents of srcImage identified by srcSubresource
• If srcImage is non-sparse then the image or each specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
• The srcSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when srcImage was created
• If srcSubresource.layerCount is not REMAINING_ARRAY_LAYERS, srcSubresource.baseArrayLayer + srcSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in ImageCreateInfo when srcImage was created
• srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• For each element of pRegions, srcOffset.x and (extent.width + srcOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified srcSubresource of srcImage
• For each element of pRegions, srcOffset.y and (extent.height + srcOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified srcSubresource of srcImage
• If srcImage is of type IMAGE_TYPE_1D, then for each element of pRegions, srcOffset.y must be 0 and extent.height must be 1
• For each element of pRegions, srcOffset.z and (extent.depth + srcOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified srcSubresource of srcImage
• If srcImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, srcOffset.z must be 0 and extent.depth must be 1
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, srcOffset.x must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and srcOffset.x does not equal the width of the subresource specified by srcSubresource, srcOffset.x must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, srcOffset.y must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and srcOffset.y does not equal the height of the subresource specified by srcSubresource, srcOffset.y must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, srcOffset.z must be a multiple of the texel block extent depth of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of srcOffset.x and extent.width does not equal the width of the subresource specified by srcSubresource, extent.width must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of srcOffset.x and extent.height must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of srcOffset.x and extent.width must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of srcOffset.x and extent.height does not equal the width of the subresource specified by srcSubresource, extent.height must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of srcOffset.y and extent.height does not equal the height of the subresource specified by srcSubresource, extent.height must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of srcOffset.y and extent.width does not equal the height of the subresource specified by srcSubresource, extent.width must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of srcOffset.y and extent.height must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of srcOffset.y and extent.width must be a multiple of the texel block extent height of the Format of srcImage
• For each element of pRegions, if the sum of srcOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the Format of srcImage
• For each element of pRegions, srcSubresource.aspectMask must specify aspects present in srcImage
• If srcImage has a multi-planar format, then for each element of pRegions, srcSubresource.aspectMask must be a single valid multi-planar aspect mask bit
• If srcImage is of type IMAGE_TYPE_3D, for each element of pRegions, srcSubresource.baseArrayLayer must be 0 and srcSubresource.layerCount must be 1
• If dstImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory
• If the stencil aspect of dstImage is accessed, and dstImage was not created with separate stencil usage, dstImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If the stencil aspect of dstImage is accessed, and dstImage was created with separate stencil usage, dstImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If non-stencil aspects of dstImage are accessed, dstImage must have been created with the IMAGE_USAGE_HOST_TRANSFER_BIT usage flag set
• If flags contains HOST_IMAGE_COPY_MEMCPY_BIT, the x, y, and z members of the dstOffset member of each element of pRegions must be 0
• If flags contains HOST_IMAGE_COPY_MEMCPY_BIT, the extent member of each element of pRegions must equal the extents of dstImage identified by dstSubresource
• If dstImage is non-sparse then the image or each specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
• The dstSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when dstImage was created
• If dstSubresource.layerCount is not REMAINING_ARRAY_LAYERS, dstSubresource.baseArrayLayer + dstSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in ImageCreateInfo when dstImage was created
• dstImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• For each element of pRegions, dstOffset.x and (extent.width + dstOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified dstSubresource of dstImage
• For each element of pRegions, dstOffset.y and (extent.height + dstOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified dstSubresource of dstImage
• If dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, dstOffset.y must be 0 and extent.height must be 1
• For each element of pRegions, dstOffset.z and (extent.depth + dstOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified dstSubresource of dstImage
• If dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, dstOffset.z must be 0 and extent.depth must be 1
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, dstOffset.x must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and dstOffset.x does not equal the width of the subresource specified by dstSubresource, dstOffset.x must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, dstOffset.y must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and dstOffset.y does not equal the height of the subresource specified by dstSubresource, dstOffset.y must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, dstOffset.z must be a multiple of the texel block extent depth of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of dstOffset.x and extent.width does not equal the width of the subresource specified by dstSubresource, extent.width must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of dstOffset.x and extent.height must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of dstOffset.x and extent.width must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of dstOffset.x and extent.height does not equal the width of the subresource specified by dstSubresource, extent.height must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of dstOffset.y and extent.height does not equal the height of the subresource specified by dstSubresource, extent.height must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of dstOffset.y and extent.width does not equal the height of the subresource specified by dstSubresource, extent.width must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of dstOffset.y and extent.height must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of dstOffset.y and extent.width must be a multiple of the texel block extent height of the Format of dstImage
• For each element of pRegions, if the sum of dstOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the Format of dstImage
• For each element of pRegions, dstSubresource.aspectMask must specify aspects present in dstImage
• If dstImage has a multi-planar format, then for each element of pRegions, dstSubresource.aspectMask must be a single valid multi-planar aspect mask bit
• If dstImage is of type IMAGE_TYPE_3D, for each element of pRegions, dstSubresource.baseArrayLayer must be 0 and dstSubresource.layerCount must be 1
• srcImageLayout must specify the current layout of the image subresources of srcImage specified in pRegions
• dstImageLayout must specify the current layout of the image subresources of dstImage specified in pRegions
• srcImageLayout must be one of the image layouts returned in PhysicalDeviceHostImageCopyProperties::pCopySrcLayouts
• dstImageLayout must be one of the image layouts returned in PhysicalDeviceHostImageCopyProperties::pCopyDstLayouts