C Specification
The VkCopyImageToBufferInfo2 structure is defined as:
// Provided by VK_VERSION_1_3
typedef struct VkCopyImageToBufferInfo2 {
VkStructureType sType;
const void* pNext;
VkImage srcImage;
VkImageLayout srcImageLayout;
VkBuffer dstBuffer;
uint32_t regionCount;
const VkBufferImageCopy2* pRegions;
} VkCopyImageToBufferInfo2;
or the equivalent
// Provided by VK_KHR_copy_commands2
typedef VkCopyImageToBufferInfo2 VkCopyImageToBufferInfo2KHR;
Members
-
sTypeis the type of this structure. -
pNextisNULLor a pointer to a structure extending this structure. -
srcImageis the source image. -
srcImageLayoutis the layout of the source image subresources for the copy. -
dstBufferis the destination buffer. -
regionCountis the number of regions to copy. -
pRegionsis a pointer to an array of VkBufferImageCopy2 structures specifying the regions to copy.
Description
-
VUID-VkCopyImageToBufferInfo2-pRegions-04566
If the image region specified by each element ofpRegionsdoes not contain VkCopyCommandTransformInfoQCOM in itspNextchain, it must be contained within the specifiedimageSubresourceofsrcImage -
VUID-VkCopyImageToBufferInfo2KHR-pRegions-04557
If the image region specified by each element ofpRegionscontains VkCopyCommandTransformInfoQCOM in itspNextchain, the rotated source region as described in https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/vkspec.html#copies-buffers-images-rotation-addressing must be contained withinsrcImage -
VUID-VkCopyImageToBufferInfo2KHR-pRegions-04558
If any element ofpRegionscontains VkCopyCommandTransformInfoQCOM in itspNextchain, thensrcImagemust not be a blocked image -
VUID-VkCopyImageToBufferInfo2KHR-pRegions-06205
If any element ofpRegionscontains VkCopyCommandTransformInfoQCOM in itspNextchain, thensrcImagemust be of typeVK_IMAGE_TYPE_2D -
VUID-VkCopyImageToBufferInfo2KHR-pRegions-06206
If any element ofpRegionscontains VkCopyCommandTransformInfoQCOM in itspNextchain, thensrcImagemust not have a multi-planar format
-
VUID-VkCopyImageToBufferInfo2-pRegions-00183
dstBuffermust be large enough to contain all buffer locations that are accessed according to Buffer and Image Addressing, for each element ofpRegions -
VUID-VkCopyImageToBufferInfo2-pRegions-00184
The union of all source regions, and the union of all destination regions, specified by the elements ofpRegions, must not overlap in memory -
VUID-VkCopyImageToBufferInfo2-srcImage-00186
srcImagemust have been created withVK_IMAGE_USAGE_TRANSFER_SRC_BITusage flag -
VUID-VkCopyImageToBufferInfo2-srcImage-01998
The format features ofsrcImagemust containVK_FORMAT_FEATURE_TRANSFER_SRC_BIT -
VUID-VkCopyImageToBufferInfo2-srcImage-00187
IfsrcImageis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-VkCopyImageToBufferInfo2-dstBuffer-00191
dstBuffermust have been created withVK_BUFFER_USAGE_TRANSFER_DST_BITusage flag -
VUID-VkCopyImageToBufferInfo2-dstBuffer-00192
IfdstBufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject -
VUID-VkCopyImageToBufferInfo2-srcImage-00188
srcImagemust have a sample count equal toVK_SAMPLE_COUNT_1_BIT -
VUID-VkCopyImageToBufferInfo2-srcImageLayout-00189
srcImageLayoutmust specify the layout of the image subresources ofsrcImagespecified inpRegionsat the time this command is executed on aVkDevice -
VUID-VkCopyImageToBufferInfo2-srcImageLayout-01397
srcImageLayoutmust beVK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,VK_IMAGE_LAYOUT_GENERAL, orVK_IMAGE_LAYOUT_SHARED_PRESENT_KHR -
VUID-VkCopyImageToBufferInfo2-imageSubresource-01703
TheimageSubresource.mipLevelmember of each element ofpRegionsmust be less than themipLevelsspecified in VkImageCreateInfo whensrcImagewas created -
VUID-VkCopyImageToBufferInfo2-imageSubresource-01704
TheimageSubresource.baseArrayLayer+imageSubresource.layerCountof each element ofpRegionsmust be less than or equal to thearrayLayersspecified in VkImageCreateInfo whensrcImagewas created -
VUID-VkCopyImageToBufferInfo2-imageOffset-01794
TheimageOffsetandimageExtentmembers of each element ofpRegionsmust respect the image transfer granularity requirements ofcommandBuffer’s command pool’s queue family, as described in VkQueueFamilyProperties -
VUID-VkCopyImageToBufferInfo2-srcImage-02544
srcImagemust not have been created withflagscontainingVK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT -
VUID-VkCopyImageToBufferInfo2-imageOffset-00197
For each element ofpRegionsnot containingVkCopyCommandTransformInfoQCOMin itspNextchain,imageOffset.xand (imageExtent.width+imageOffset.x) must both be greater than or equal to0and less than or equal to the width of the specifiedimageSubresourceofsrcImage -
VUID-VkCopyImageToBufferInfo2-imageOffset-00198
For each element ofpRegionsnot containingVkCopyCommandTransformInfoQCOMin itspNextchain,imageOffset.yand (imageExtent.height+imageOffset.y) must both be greater than or equal to0and less than or equal to the height of the specifiedimageSubresourceofsrcImage
-
VUID-VkCopyImageToBufferInfo2-bufferOffset-01558
IfsrcImagedoes not have either a depth/stencil or a multi-planar format, then for each element ofpRegions,bufferOffsetmust be a multiple of the format’s texel block size -
VUID-VkCopyImageToBufferInfo2-bufferOffset-01559
IfsrcImagehas a multi-planar format, then for each element ofpRegions,bufferOffsetmust be a multiple of the element size of the compatible format for the format and theaspectMaskof theimageSubresourceas defined in [formats-compatible-planes] -
VUID-VkCopyImageToBufferInfo2-srcImage-00199
IfsrcImageis of typeVK_IMAGE_TYPE_1D, then for each element ofpRegions,imageOffset.ymust be0andimageExtent.heightmust be1 -
VUID-VkCopyImageToBufferInfo2-imageOffset-00200
For each element ofpRegions,imageOffset.zand (imageExtent.depth+imageOffset.z) must both be greater than or equal to0and less than or equal to the depth of the specifiedimageSubresourceofsrcImage -
VUID-VkCopyImageToBufferInfo2-srcImage-00201
IfsrcImageis of typeVK_IMAGE_TYPE_1DorVK_IMAGE_TYPE_2D, then for each element ofpRegions,imageOffset.zmust be0andimageExtent.depthmust be1 -
VUID-VkCopyImageToBufferInfo2-bufferRowLength-00203
IfsrcImageis a blocked image, for each element ofpRegions,bufferRowLengthmust be a multiple of the compressed texel block width -
VUID-VkCopyImageToBufferInfo2-bufferImageHeight-00204
IfsrcImageis a blocked image, for each element ofpRegions,bufferImageHeightmust be a multiple of the compressed texel block height -
VUID-VkCopyImageToBufferInfo2-imageOffset-00205
IfsrcImageis a blocked image, for each element ofpRegions, all members ofimageOffsetmust be a multiple of the corresponding dimensions of the compressed texel block -
VUID-VkCopyImageToBufferInfo2-bufferOffset-00206
IfsrcImageis a blocked image, for each element ofpRegions,bufferOffsetmust be a multiple of the compressed texel block size in bytes -
VUID-VkCopyImageToBufferInfo2-imageExtent-00207
IfsrcImageis a blocked image, for each element ofpRegions,imageExtent.widthmust be a multiple of the compressed texel block width or (imageExtent.width+imageOffset.x) must equal the width of the specifiedimageSubresourceofsrcImage -
VUID-VkCopyImageToBufferInfo2-imageExtent-00208
IfsrcImageis a blocked image, for each element ofpRegions,imageExtent.heightmust be a multiple of the compressed texel block height or (imageExtent.height+imageOffset.y) must equal the height of the specifiedimageSubresourceofsrcImage -
VUID-VkCopyImageToBufferInfo2-imageExtent-00209
IfsrcImageis a blocked image, for each element ofpRegions,imageExtent.depthmust be a multiple of the compressed texel block depth or (imageExtent.depth+imageOffset.z) must equal the depth of the specifiedimageSubresourceofsrcImage -
VUID-VkCopyImageToBufferInfo2-aspectMask-00211
For each element ofpRegions,imageSubresource.aspectMaskmust specify aspects present insrcImage -
VUID-VkCopyImageToBufferInfo2-aspectMask-01560
IfsrcImagehas a multi-planar format, then for each element ofpRegions,imageSubresource.aspectMaskmust beVK_IMAGE_ASPECT_PLANE_0_BIT,VK_IMAGE_ASPECT_PLANE_1_BIT, orVK_IMAGE_ASPECT_PLANE_2_BIT(withVK_IMAGE_ASPECT_PLANE_2_BITvalid only for image formats with three planes) -
VUID-VkCopyImageToBufferInfo2-baseArrayLayer-00213
IfsrcImageis of typeVK_IMAGE_TYPE_3D, for each element ofpRegions,imageSubresource.baseArrayLayermust be0andimageSubresource.layerCountmust be1 -
VUID-VkCopyImageToBufferInfo2-pRegions-04725
IfsrcImageis not a blocked image, for each element ofpRegions,bufferRowLengthmultiplied by the texel block size ofsrcImagemust be less than or equal to 231-1 -
VUID-VkCopyImageToBufferInfo2-pRegions-04726
IfsrcImageis a blocked image, for each element ofpRegions,bufferRowLengthdivided by the compressed texel block width and then multiplied by the texel block size ofsrcImagemust be less than or equal to 231-1 -
VUID-VkCopyImageToBufferInfo2-commandBuffer-04052
If the queue family used to create the VkCommandPool whichcommandBufferwas allocated from does not supportVK_QUEUE_GRAPHICS_BITorVK_QUEUE_COMPUTE_BIT, thebufferOffsetmember of any element ofpRegionsmust be a multiple of4 -
VUID-VkCopyImageToBufferInfo2-srcImage-04053
IfsrcImagehas a depth/stencil format, thebufferOffsetmember of any element ofpRegionsmust be a multiple of4
-
VUID-VkCopyImageToBufferInfo2-sType-sType
sTypemust beVK_STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 -
VUID-VkCopyImageToBufferInfo2-pNext-pNext
pNextmust beNULL -
VUID-VkCopyImageToBufferInfo2-srcImage-parameter
srcImagemust be a valid VkImage handle -
VUID-VkCopyImageToBufferInfo2-srcImageLayout-parameter
srcImageLayoutmust be a valid VkImageLayout value -
VUID-VkCopyImageToBufferInfo2-dstBuffer-parameter
dstBuffermust be a valid VkBuffer handle -
VUID-VkCopyImageToBufferInfo2-pRegions-parameter
pRegionsmust be a valid pointer to an array ofregionCountvalid VkBufferImageCopy2 structures -
VUID-VkCopyImageToBufferInfo2-regionCount-arraylength
regionCountmust be greater than0 -
VUID-VkCopyImageToBufferInfo2-commonparent
Both ofdstBuffer, andsrcImagemust have been created, allocated, or retrieved from the same 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.