vkCmdCopyBuffer2 - Copy data between buffer regions

Description

Each source region specified by pCopyBufferInfo->pRegions is copied from the source buffer to the destination region of the destination buffer. If any of the specified regions in pCopyBufferInfo->srcBuffer overlaps in memory with any of the specified regions in pCopyBufferInfo->dstBuffer, values read from those overlapping regions are undefined.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcBuffer must not be a protected buffer

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstBuffer must not be a protected buffer
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstBuffer must not be an unprotected buffer

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pCopyBufferInfo must be a valid pointer to a valid CopyBufferInfo2 structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, QUEUE_GRAPHICS_BIT, or QUEUE_TRANSFER_BIT operations
• This command must only be called outside of a render pass instance
• This command must not be called between suspended render pass instances
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdCopyBuffer2 is not affected by conditional rendering

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, CommandBuffer, CopyBufferInfo2

vkCmdCopyImage2 - Copy data between images

Description

This command is functionally identical to cmdCopyImage, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT, and the maintenance10 feature is not enabled, for each element of pCopyImageInfo->pRegions, where the aspectMask member of srcSubresource is IMAGE_ASPECT_COLOR_BIT, the aspectMask of dstSubresource must not be IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT but does support QUEUE_COMPUTE_BIT, and in any element of pCopyImageInfo->pRegions the aspectMask member of srcSubresource is IMAGE_ASPECT_COLOR_BIT and the aspectMask of dstSubresource is IMAGE_ASPECT_DEPTH_BIT, then the format features of dstImage must contain FORMAT_FEATURE_2_DEPTH_COPY_ON_COMPUTE_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT and QUEUE_COMPUTE_BIT, but does support QUEUE_TRANSFER_BIT, and in any element of pCopyImageInfo->pRegions the aspectMask member of srcSubresource is IMAGE_ASPECT_COLOR_BIT and the aspectMask of dstSubresource is IMAGE_ASPECT_DEPTH_BIT, then the format features of dstImage must contain FORMAT_FEATURE_2_DEPTH_COPY_ON_TRANSFER_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT but does support QUEUE_COMPUTE_BIT, and in any element of pCopyImageInfo->pRegions the aspectMask member of srcSubresource is IMAGE_ASPECT_COLOR_BIT and the aspectMask of dstSubresource is IMAGE_ASPECT_STENCIL_BIT, then the format features of dstImage must contain FORMAT_FEATURE_2_STENCIL_COPY_ON_COMPUTE_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT and QUEUE_COMPUTE_BIT, but does support QUEUE_TRANSFER_BIT, and in any element of pCopyImageInfo->pRegions the aspectMask member of srcSubresource is IMAGE_ASPECT_COLOR_BIT and the aspectMask of dstSubresource is IMAGE_ASPECT_STENCIL_BIT, then the format features of dstImage must contain FORMAT_FEATURE_2_STENCIL_COPY_ON_TRANSFER_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT, and the maintenance10 feature is not enabled, for each element of pCopyImageInfo->pRegions, where the aspectMask member of dstSubresource is IMAGE_ASPECT_COLOR_BIT then the aspectMask of srcSubresource must not be IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT but does support QUEUE_COMPUTE_BIT, and in any element of pCopyImageInfo->pRegions the aspectMask member of dstSubresource is IMAGE_ASPECT_COLOR_BIT and the aspectMask of srcSubresource is IMAGE_ASPECT_DEPTH_BIT, then the format features of srcImage must contain FORMAT_FEATURE_2_DEPTH_COPY_ON_COMPUTE_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT and QUEUE_COMPUTE_BIT, but does support QUEUE_TRANSFER_BIT, and in any element of pCopyImageInfo->pRegions the aspectMask member of dstSubresource is IMAGE_ASPECT_COLOR_BIT and the aspectMask of srcSubresource is IMAGE_ASPECT_DEPTH_BIT, then the format features of srcImage must contain FORMAT_FEATURE_2_DEPTH_COPY_ON_TRANSFER_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT but does support QUEUE_COMPUTE_BIT, and in any element of pCopyImageInfo->pRegions the aspectMask member of dstSubresource is IMAGE_ASPECT_COLOR_BIT and the aspectMask of srcSubresource is IMAGE_ASPECT_STENCIL_BIT, then the format features of srcImage must contain FORMAT_FEATURE_2_STENCIL_COPY_ON_COMPUTE_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT and QUEUE_COMPUTE_BIT, but does support QUEUE_TRANSFER_BIT, and in any element of pCopyImageInfo->pRegions the aspectMask member of dstSubresource is IMAGE_ASPECT_COLOR_BIT and the aspectMask of srcSubresource is IMAGE_ASPECT_STENCIL_BIT, then the format features of srcImage must contain FORMAT_FEATURE_2_STENCIL_COPY_ON_TRANSFER_QUEUE_BIT_KHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pCopyImageInfo must be a valid pointer to a valid CopyImageInfo2 structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, QUEUE_GRAPHICS_BIT, or QUEUE_TRANSFER_BIT operations
• This command must only be called outside of a render pass instance
• This command must not be called between suspended render pass instances
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdCopyImage2 is not affected by conditional rendering

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, CommandBuffer, CopyImageInfo2

vkCmdBlitImage2 - Copy regions of an image, potentially performing format conversion,

Description

This command is functionally identical to cmdBlitImage, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pBlitImageInfo must be a valid pointer to a valid BlitImageInfo2 structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support QUEUE_GRAPHICS_BIT operations
• This command must only be called outside of a render pass instance
• This command must not be called between suspended render pass instances
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdBlitImage2 is not affected by conditional rendering

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, BlitImageInfo2, CommandBuffer

vkCmdCopyBufferToImage2 - Copy data from a buffer into an image

Description

This command is functionally identical to cmdCopyBufferToImage, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcBuffer must not be a protected buffer

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT or QUEUE_COMPUTE_BIT, the bufferOffset member of any element of pCopyBufferToImageInfo->pRegions must be a multiple of 4
• The imageOffset and imageExtent members of each element of pCopyBufferToImageInfo->pRegions must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in QueueFamilyProperties
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT, and the maintenance10 feature is not enabled, for each element of pCopyBufferToImageInfo->pRegions, the aspectMask member of imageSubresource must not be IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT but does support QUEUE_COMPUTE_BIT, and in any element of pCopyBufferToImageInfo->pRegions the aspectMask member of imageSubresource is IMAGE_ASPECT_DEPTH_BIT, then the format features of dstImage must contain FORMAT_FEATURE_2_DEPTH_COPY_ON_COMPUTE_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT and QUEUE_COMPUTE_BIT, but does support QUEUE_TRANSFER_BIT, and in any element of pCopyBufferToImageInfo->pRegions the aspectMask member of imageSubresource is IMAGE_ASPECT_DEPTH_BIT, then the format features of dstImage must contain FORMAT_FEATURE_2_DEPTH_COPY_ON_TRANSFER_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT but does support QUEUE_COMPUTE_BIT, and in any element of pCopyBufferToImageInfo->pRegions the aspectMask member of imageSubresource is IMAGE_ASPECT_STENCIL_BIT, then the format features of dstImage must contain FORMAT_FEATURE_2_STENCIL_COPY_ON_COMPUTE_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT and QUEUE_COMPUTE_BIT, but does support QUEUE_TRANSFER_BIT, and in any element of pCopyBufferToImageInfo->pRegions the aspectMask member of imageSubresource is IMAGE_ASPECT_STENCIL_BIT, then the format features of dstImage must contain FORMAT_FEATURE_2_STENCIL_COPY_ON_TRANSFER_QUEUE_BIT_KHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pCopyBufferToImageInfo must be a valid pointer to a valid CopyBufferToImageInfo2 structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, QUEUE_GRAPHICS_BIT, or QUEUE_TRANSFER_BIT operations
• This command must only be called outside of a render pass instance
• This command must not be called between suspended render pass instances
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdCopyBufferToImage2 is not affected by conditional rendering

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, CommandBuffer, CopyBufferToImageInfo2

vkCmdCopyImageToBuffer2 - Copy image data into a buffer

Description

This command is functionally identical to cmdCopyImageToBuffer, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstBuffer must not be a protected buffer
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstBuffer must not be an unprotected buffer
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT or QUEUE_COMPUTE_BIT, the bufferOffset member of any element of pCopyImageToBufferInfo->pRegions must be a multiple of 4
• The imageOffset and imageExtent members of each element of pCopyImageToBufferInfo->pRegions must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in QueueFamilyProperties
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT, and the maintenance10 feature is not enabled, for each element of pCopyImageToBufferInfo->pRegions, the aspectMask member of imageSubresource must not be IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT but does support QUEUE_COMPUTE_BIT, and in any element of pCopyImageToBufferInfo->pRegions the aspectMask member of imageSubresource is IMAGE_ASPECT_DEPTH_BIT, then the format features of srcImage must contain FORMAT_FEATURE_2_DEPTH_COPY_ON_COMPUTE_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT and QUEUE_COMPUTE_BIT, but does support QUEUE_TRANSFER_BIT, and in any element of pCopyImageToBufferInfo->pRegions the aspectMask member of imageSubresource is IMAGE_ASPECT_DEPTH_BIT, then the format features of srcImage must contain FORMAT_FEATURE_2_DEPTH_COPY_ON_TRANSFER_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT but does support QUEUE_COMPUTE_BIT, and in any element of pCopyImageToBufferInfo->pRegions the aspectMask member of imageSubresource is IMAGE_ASPECT_STENCIL_BIT, then the format features of srcImage must contain FORMAT_FEATURE_2_STENCIL_COPY_ON_COMPUTE_QUEUE_BIT_KHR
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT and QUEUE_COMPUTE_BIT, but does support QUEUE_TRANSFER_BIT, and in any element of pCopyImageToBufferInfo->pRegions the aspectMask member of imageSubresource is IMAGE_ASPECT_STENCIL_BIT, then the format features of srcImage must contain FORMAT_FEATURE_2_STENCIL_COPY_ON_TRANSFER_QUEUE_BIT_KHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pCopyImageToBufferInfo must be a valid pointer to a valid CopyImageToBufferInfo2 structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, QUEUE_GRAPHICS_BIT, or QUEUE_TRANSFER_BIT operations
• This command must only be called outside of a render pass instance
• This command must not be called between suspended render pass instances
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdCopyImageToBuffer2 is not affected by conditional rendering

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, CommandBuffer, CopyImageToBufferInfo2

vkCmdResolveImage2 - Resolve regions of an image

Description

This command is functionally identical to cmdResolveImage, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pResolveImageInfo must be a valid pointer to a valid ResolveImageInfo2 structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support QUEUE_GRAPHICS_BIT operations
• This command must only be called outside of a render pass instance
• This command must not be called between suspended render pass instances
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdResolveImage2 is not affected by conditional rendering

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, CommandBuffer, ResolveImageInfo2

VkBufferCopy2 - Structure specifying a buffer copy operation

Valid Usage

• The size must be greater than 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_COPY_2

• pNext must be NULL

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, CopyBufferInfo2, DeviceSize, StructureType

VkImageCopy2 - Structure specifying an image copy operation

Valid Usage

• If the VK_KHR_sampler_ycbcr_conversion extension is not enabled, and PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, the aspectMask member of srcSubresource and dstSubresource must match

• If the VK_KHR_maintenance1 extension is not enabled, and PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, the layerCount member of srcSubresource and dstSubresource must match
• extent.width must not be 0
• extent.height must not be 0
• extent.depth must not be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_COPY_2

• pNext must be NULL
• srcSubresource must be a valid ImageSubresourceLayers structure
• dstSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, CopyImageInfo2, PromotedStreamingTransfers.CopyImageToImageInfo', Extent3D, ImageSubresourceLayers, Offset3D, StructureType

VkImageBlit2 - Structure specifying an image blit operation

Description

For each element of the pRegions array, a blit operation is performed for the specified source and destination regions.

Valid Usage

• The aspectMask member of srcSubresource and dstSubresource must match

• If neither of the layerCount members of srcSubresource or dstSubresource are REMAINING_ARRAY_LAYERS, the layerCount members of srcSubresource or dstSubresource must match
• If one of the layerCount members of srcSubresource or dstSubresource is REMAINING_ARRAY_LAYERS, the other member must be either REMAINING_ARRAY_LAYERS or equal to the arrayLayers member of the ImageCreateInfo used to create the image minus baseArrayLayer

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_BLIT_2

• pNext must be NULL or a pointer to a valid instance of CopyCommandTransformInfoQCOM
• The sType value of each structure in the pNext chain must be unique
• srcSubresource must be a valid ImageSubresourceLayers structure
• dstSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, BlitImageInfo2, ImageSubresourceLayers, Offset3D, StructureType

VkBufferImageCopy2 - Structure specifying a buffer image copy operation

Description

This structure is functionally identical to BufferImageCopy, but adds sType and pNext parameters, allowing it to be more easily extended.

Valid Usage

• bufferRowLength must be 0, or greater than or equal to the width member of imageExtent

• bufferImageHeight 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_BUFFER_IMAGE_COPY_2

• pNext must be NULL or a pointer to a valid instance of CopyCommandTransformInfoQCOM
• The sType value of each structure in the pNext chain must be unique
• imageSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, CopyBufferToImageInfo2, CopyImageToBufferInfo2, DeviceSize, Extent3D, ImageSubresourceLayers, Offset3D, StructureType

VkImageResolve2 - Structure specifying an image resolve operation

Valid Usage

• The aspectMask member of srcSubresource and dstSubresource must only contain IMAGE_ASPECT_DEPTH_BIT, IMAGE_ASPECT_STENCIL_BIT, or IMAGE_ASPECT_COLOR_BIT

• If maintenance10 feature is not enabled, srcSubresource and dstSubresource must not contain IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If neither of the layerCount members of srcSubresource or dstSubresource are REMAINING_ARRAY_LAYERS, the layerCount member of srcSubresource and dstSubresource must match
• If one of the layerCount members of srcSubresource or dstSubresource is REMAINING_ARRAY_LAYERS, the other member must be either REMAINING_ARRAY_LAYERS or equal to the arrayLayers member of the ImageCreateInfo used to create the image minus baseArrayLayer

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_RESOLVE_2

• pNext must be NULL
• srcSubresource must be a valid ImageSubresourceLayers structure
• dstSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, Extent3D, ImageSubresourceLayers, Offset3D, ResolveImageInfo2, StructureType

VkCopyBufferInfo2 - Structure specifying parameters of a buffer copy command

Valid Usage

• The srcOffset member of each element of pRegions must be less than the size of srcBuffer

• The dstOffset member of each element of pRegions must be less than the size of dstBuffer
• The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
• The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
• The union of the source regions, and the union of the destination regions, specified by the elements of pRegions, must not overlap in memory
• srcBuffer must have been created with the BUFFER_USAGE_TRANSFER_SRC_BIT usage flag set
• If srcBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• dstBuffer must have been created with the BUFFER_USAGE_TRANSFER_DST_BIT usage flag set
• If dstBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_BUFFER_INFO_2

• pNext must be NULL
• srcBuffer must be a valid Buffer handle
• dstBuffer must be a valid Buffer handle
• pRegions must be a valid pointer to an array of regionCount valid BufferCopy2 structures
• regionCount must be greater than 0
• Both of dstBuffer, and srcBuffer must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_copy_commands2, VK_VERSION_1_3, Buffer, BufferCopy2, StructureType, cmdCopyBuffer2, cmdCopyBuffer2

VkCopyImageInfo2 - Structure specifying parameters of an image copy command

Valid Usage

• The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory

• The format features of srcImage must contain FORMAT_FEATURE_TRANSFER_SRC_BIT
• srcImageLayout must specify the layout of the image subresources of srcImage specified in pRegions at the time this command is executed on a Device
• srcImageLayout must be IMAGE_LAYOUT_SHARED_PRESENT_KHR, IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, or IMAGE_LAYOUT_GENERAL
• If srcImage and dstImage are the same, and any elements of pRegions contains the srcSubresource and dstSubresource with matching mipLevel and overlapping array layers, then the srcImageLayout and dstImageLayout must be IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_SHARED_PRESENT_KHR
• The format features of dstImage must contain FORMAT_FEATURE_TRANSFER_DST_BIT
• dstImageLayout must specify the layout of the image subresources of dstImage specified in pRegions at the time this command is executed on a Device
• dstImageLayout must be IMAGE_LAYOUT_SHARED_PRESENT_KHR, IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, or IMAGE_LAYOUT_GENERAL
• If the Format of each of srcImage and dstImage is not a multi-planar format, the Format of each of srcImage and dstImage must be size-compatible
• In a copy to or from a plane of a multi-planar image, the Format of the image and plane must be compatible according to the description of compatible planes for the plane being copied
• If the Format of each of srcImage and dstImage is a compressed image format, the formats must have the same texel block extent
• The sample count of srcImage and dstImage must match
• The srcOffset and extent members of each element of pRegions must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in QueueFamilyProperties
• The dstOffset and extent members of each element of pRegions must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in QueueFamilyProperties
• If neither srcImage nor dstImage has a multi-planar format and the maintenance8 feature is not enabled then for each element of pRegions, srcSubresource.aspectMask and dstSubresource.aspectMask must match
• For each element of pRegions where srcSubresource.aspectMask and dstSubresource.aspectMask each contain at least one of IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT, srcSubresource.aspectMask and dstSubresource.aspectMask must match
• If srcSubresource.aspectMask is IMAGE_ASPECT_COLOR_BIT, then dstSubresource.aspectMask must not contain both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
• If dstSubresource.aspectMask is IMAGE_ASPECT_COLOR_BIT, then srcSubresource.aspectMask must not contain both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
• 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 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 srcImage has a multi-planar format and the dstImage does not have a multi-planar image format, then for each element of pRegions, dstSubresource.aspectMask must be IMAGE_ASPECT_COLOR_BIT
• If dstImage has a multi-planar format and the srcImage does not have a multi-planar image format, then for each element of pRegions, srcSubresource.aspectMask must be IMAGE_ASPECT_COLOR_BIT
• If srcSubresource.aspectMask is IMAGE_ASPECT_COLOR_BIT and dstSubresource.aspectMask is IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT, then the Format values of srcImage and dstImage must be compatible according to the list of compatible depth-stencil and color formats
• If srcSubresource.aspectMask is IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT and dstSubresource.aspectMask is IMAGE_ASPECT_COLOR_BIT, then the Format values of srcImage and dstImage must be compatible according to the list of compatible depth-stencil and color formats
• If the VK_KHR_maintenance1 extension is not enabled, or PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, and either srcImage or dstImage is of type IMAGE_TYPE_3D, then for each element of pRegions, srcSubresource.baseArrayLayer and dstSubresource.baseArrayLayer must both be 0, and srcSubresource.layerCount and dstSubresource.layerCount must both be 1
• If srcImage is of type IMAGE_TYPE_3D, then for each element of pRegions, srcSubresource.baseArrayLayer must be 0 and srcSubresource.layerCount must be 1
• If dstImage is of type IMAGE_TYPE_3D, then for each element of pRegions, dstSubresource.baseArrayLayer must be 0 and dstSubresource.layerCount must be 1
• For each element of pRegions, srcSubresource.aspectMask must specify aspects present in srcImage
• For each element of pRegions, dstSubresource.aspectMask must specify aspects present in dstImage
• 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
• If srcImage is of type IMAGE_TYPE_3D, then 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, then for each element of pRegions, srcOffset.z must be 0 and extent.depth must be 1
• If dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, dstOffset.z must be 0
• If either the Format of each of srcImage and dstImage is not a compressed image format, and dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, extent.depth must be 1
• If srcImage is of type IMAGE_TYPE_2D, then for each element of pRegions, srcOffset.z must be 0
• If dstImage is of type IMAGE_TYPE_2D, then for each element of pRegions, dstOffset.z must be 0
• If the VK_KHR_maintenance1 extension is not enabled, and PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, srcImage and dstImage must have the same ImageType
• If the VK_KHR_maintenance1 extension is not enabled, and PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, srcImage or dstImage is of type IMAGE_TYPE_2D, then for each element of pRegions, extent.depth must be 1
• If srcImage and dstImage have a different ImageType, and the maintenance5 feature is not enabled, one must be IMAGE_TYPE_3D and the other must be IMAGE_TYPE_2D
• If srcImage and dstImage have the same ImageType, for each element of pRegions, if neither of the layerCount members of srcSubresource or dstSubresource are REMAINING_ARRAY_LAYERS, the layerCount members of srcSubresource or dstSubresource must match
• If srcImage and dstImage have the same ImageType, and one of the layerCount members of srcSubresource or dstSubresource is REMAINING_ARRAY_LAYERS, the other member must be either REMAINING_ARRAY_LAYERS or equal to the arrayLayers member of the ImageCreateInfo used to create the image minus baseArrayLayer
• If srcImage and dstImage are both of type IMAGE_TYPE_2D, then for each element of pRegions, extent.depth must be 1
• If srcImage is of type IMAGE_TYPE_2D, and dstImage is of type IMAGE_TYPE_3D, then for each element of pRegions, extent.depth must equal srcSubresource.layerCount
• If dstImage is of type IMAGE_TYPE_2D, and srcImage is of type IMAGE_TYPE_3D, then for each element of pRegions, extent.depth must equal dstSubresource.layerCount
• For each element of pRegions, dstOffset.x and (extent.width + dstOffset.x), where extent is adjusted for size-compatibility, 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), where extent is adjusted for size-compatibility, 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
• If either the Format of each of srcImage and dstImage is not a compressed image format, and dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, extent.height must be 1, where extent is adjusted for size-compatibility
• If dstImage is of type IMAGE_TYPE_3D, then for each element of pRegions, dstOffset.z and (extent.depth + dstOffset.z), where extent is adjusted for size-compatibility, must both be greater than or equal to 0 and less than or equal to the depth of the specified dstSubresource of dstImage
• For each element of pRegions, srcOffset.x must be a multiple of the texel block extent width of the Format of srcImage
• For each element of pRegions, 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, dstOffset.x must be a multiple of the texel block extent width of the Format of dstImage
• For each element of pRegions, 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 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 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 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
• If the aspect member of any element of pRegions includes any flag other than IMAGE_ASPECT_STENCIL_BIT or srcImage was not created with separate stencil usage, srcImage must have been created with the IMAGE_USAGE_TRANSFER_SRC_BIT usage flag set
• If the aspect member of any element of pRegions includes any flag other than IMAGE_ASPECT_STENCIL_BIT or dstImage was not created with separate stencil usage, dstImage must have been created with the IMAGE_USAGE_TRANSFER_DST_BIT usage flag set
• If the aspect member of any element of pRegions includes IMAGE_ASPECT_STENCIL_BIT, and srcImage was created with separate stencil usage, srcImage must have been created with the IMAGE_USAGE_TRANSFER_SRC_BIT usage flag set
• If the aspect member of any element of pRegions includes IMAGE_ASPECT_STENCIL_BIT, and dstImage was created with separate stencil usage, srcImage must have been created with the IMAGE_USAGE_TRANSFER_DST_BIT usage flag set
• 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
• 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