vkCmdBlitImage(3)

vkCmdBlitImage must not be used for multisampled source or destination images. Use vkCmdResolveImage for this purpose.

As the sizes of the source and destination extents can differ in any dimension, texels in the source extent are scaled and filtered to the destination extent. Scaling occurs via the following operations:

For each destination texel, the integer coordinate of that texel is converted to an unnormalized texture coordinate, using the effective inverse of the equations described in unnormalized to integer conversion:

ubase = i + 陆

vbase = j + 陆

wbase = k + 陆

These base coordinates are then offset by the first destination offset:

uoffset = ubase - xdst0

voffset = vbase - ydst0

woffset = wbase - zdst0

aoffset = a - baseArrayCountdst

The scale is determined from the source and destination regions, and applied to the offset coordinates:

scaleu = (xsrc1 - xsrc0) / (xdst1 - xdst0)

scalev = (ysrc1 - ysrc0) / (ydst1 - ydst0)

scalew = (zsrc1 - zsrc0) / (zdst1 - zdst0)

uscaled = uoffset 脳 scaleu

vscaled = voffset 脳 scalev

wscaled = woffset 脳 scalew

Finally the source offset is added to the scaled coordinates, to determine the final unnormalized coordinates used to sample from srcImage:

u = uscaled + xsrc0

v = vscaled + ysrc0

w = wscaled + zsrc0

q = mipLevel

a = aoffset + baseArrayCountsrc

These coordinates are used to sample from the source image, as described in Image Operations chapter, with the filter mode equal to that of filter, a mipmap mode of VK_SAMPLER_MIPMAP_MODE_NEAREST and an address mode of VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE. Implementations must clamp at the edge of the source image, and may additionally clamp to the edge of the source region.

Due to allowable rounding errors in the generation of the source texture coordinates, it is not always possible to guarantee exactly which source texels will be sampled for a given blit. As rounding errors are implementation-dependent, the exact results of a blitting operation are also implementation-dependent.

Blits are done layer by layer starting with the baseArrayLayer member of srcSubresource for the source and dstSubresource for the destination. layerCount layers are blitted to the destination image.

When blitting 3D textures, slices in the destination region bounded by dstOffsets[0].z and dstOffsets[1].z are sampled from slices in the source region bounded by srcOffsets[0].z and srcOffsets[1].z. If the filter parameter is VK_FILTER_LINEAR then the value sampled from the source image is taken by doing linear filtering using the interpolated z coordinate represented by w in the previous equations. If the filter parameter is VK_FILTER_NEAREST then the value sampled from the source image is taken from the single nearest slice, with an implementation-dependent arithmetic rounding mode.

The following filtering and conversion rules apply:

Integer formats can only be converted to other integer formats with the same signedness.

No format conversion is supported between depth/stencil images. The formats must match.

Format conversions on unorm, snorm, scaled and packed float formats of the copied aspect of the image are performed by first converting the pixels to float values.

For sRGB source formats, nonlinear RGB values are converted to linear representation prior to filtering.

After filtering, the float values are first clamped and then cast to the destination image format. In case of sRGB destination format, linear RGB values are converted to nonlinear representation before writing the pixel to the image.

Signed and unsigned integers are converted by first clamping to the representable range of the destination format, then casting the value.

VUID-vkCmdBlitImage-commandBuffer-01834 If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

VUID-vkCmdBlitImage-commandBuffer-01835 If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image

VUID-vkCmdBlitImage-commandBuffer-01836 If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image

VUID-vkCmdBlitImage-pRegions-00215 The source region specified by each element of pRegions must be a region that is contained within srcImage

VUID-vkCmdBlitImage-pRegions-00216 The destination region specified by each element of pRegions must be a region that is contained within dstImage

VUID-vkCmdBlitImage-pRegions-00217 The union of all destination regions, specified by the elements of pRegions, must not overlap in memory with any texel that may be sampled during the blit operation

VUID-vkCmdBlitImage-srcImage-01999 The format features of srcImage must contain VK_FORMAT_FEATURE_BLIT_SRC_BIT

VUID-vkCmdBlitImage-srcImage-06421 srcImage must not use a format that requires a sampler Y鈥睠BCR conversion

VUID-vkCmdBlitImage-srcImage-00219 srcImage must have been created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT usage flag

VUID-vkCmdBlitImage-srcImage-00220 If srcImage is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object

VUID-vkCmdBlitImage-srcImageLayout-00221 srcImageLayout must specify the layout of the image subresources of srcImage specified in pRegions at the time this command is executed on a VkDevice

VUID-vkCmdBlitImage-srcImageLayout-01398 srcImageLayout must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or VK_IMAGE_LAYOUT_GENERAL

VUID-vkCmdBlitImage-srcImage-09459 If srcImage and dstImage are the same, and an elements of pRegions contains the srcSubresource and dstSubresource with matching mipLevel and overlapping array layers, then the srcImageLayout and dstImageLayout must be VK_IMAGE_LAYOUT_GENERAL or VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR

VUID-vkCmdBlitImage-dstImage-02000 The format features of dstImage must contain VK_FORMAT_FEATURE_BLIT_DST_BIT

VUID-vkCmdBlitImage-dstImage-06422 dstImage must not use a format that requires a sampler Y鈥睠BCR conversion

VUID-vkCmdBlitImage-dstImage-00224 dstImage must have been created with VK_IMAGE_USAGE_TRANSFER_DST_BIT usage flag

VUID-vkCmdBlitImage-dstImage-00225 If dstImage is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object

VUID-vkCmdBlitImage-dstImageLayout-00226 dstImageLayout must specify the layout of the image subresources of dstImage specified in pRegions at the time this command is executed on a VkDevice

VUID-vkCmdBlitImage-dstImageLayout-01399 dstImageLayout must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or VK_IMAGE_LAYOUT_GENERAL

VUID-vkCmdBlitImage-srcImage-00229 If either of srcImage or dstImage was created with a signed integer VkFormat, the other must also have been created with a signed integer VkFormat

VUID-vkCmdBlitImage-srcImage-00230 If either of srcImage or dstImage was created with an unsigned integer VkFormat, the other must also have been created with an unsigned integer VkFormat

VUID-vkCmdBlitImage-srcImage-00231 If either of srcImage or dstImage was created with a depth/stencil format, the other must have exactly the same format

VUID-vkCmdBlitImage-srcImage-00232 If srcImage was created with a depth/stencil format, filter must be VK_FILTER_NEAREST

VUID-vkCmdBlitImage-srcImage-00233 srcImage must have been created with a samples value of VK_SAMPLE_COUNT_1_BIT

VUID-vkCmdBlitImage-dstImage-00234 dstImage must have been created with a samples value of VK_SAMPLE_COUNT_1_BIT

VUID-vkCmdBlitImage-filter-02001 If filter is VK_FILTER_LINEAR, then the format features of srcImage must contain VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

VUID-vkCmdBlitImage-filter-02002 If filter is VK_FILTER_CUBIC_EXT, then the format features of srcImage must contain VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT

VUID-vkCmdBlitImage-filter-00237 If filter is VK_FILTER_CUBIC_EXT, srcImage must be of type VK_IMAGE_TYPE_2D

VUID-vkCmdBlitImage-srcSubresource-01705 The srcSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in VkImageCreateInfo when srcImage was created

VUID-vkCmdBlitImage-dstSubresource-01706 The dstSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in VkImageCreateInfo when dstImage was created

VUID-vkCmdBlitImage-srcSubresource-01707 If srcSubresource.layerCount is not VK_REMAINING_ARRAY_LAYERS, srcSubresource.baseArrayLayer + srcSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in VkImageCreateInfo when srcImage was created

VUID-vkCmdBlitImage-dstSubresource-01708 If srcSubresource.layerCount is not VK_REMAINING_ARRAY_LAYERS, dstSubresource.baseArrayLayer + dstSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in VkImageCreateInfo when dstImage was created

VUID-vkCmdBlitImage-dstImage-02545 dstImage and srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT

VUID-vkCmdBlitImage-srcImage-00240 If either srcImage or dstImage is of type VK_IMAGE_TYPE_3D, then for each element of pRegions, srcSubresource.baseArrayLayer and dstSubresource.baseArrayLayer must each be 0, and srcSubresource.layerCount and dstSubresource.layerCount must each be 1

VUID-vkCmdBlitImage-aspectMask-00241 For each element of pRegions, srcSubresource.aspectMask must specify aspects present in srcImage

VUID-vkCmdBlitImage-aspectMask-00242 For each element of pRegions, dstSubresource.aspectMask must specify aspects present in dstImage

VUID-vkCmdBlitImage-srcOffset-00243 For each element of pRegions, srcOffsets[0].x and srcOffsets[1].x must both be greater than or equal to 0 and less than or equal to the width of the specified srcSubresource of srcImage

VUID-vkCmdBlitImage-srcOffset-00244 For each element of pRegions, srcOffsets[0].y and srcOffsets[1].y must both be greater than or equal to 0 and less than or equal to the height of the specified srcSubresource of srcImage

VUID-vkCmdBlitImage-srcImage-00245 If srcImage is of type VK_IMAGE_TYPE_1D, then for each element of pRegions, srcOffsets[0].y must be 0 and srcOffsets[1].y must be 1

VUID-vkCmdBlitImage-srcOffset-00246 For each element of pRegions, srcOffsets[0].z and srcOffsets[1].z must both be greater than or equal to 0 and less than or equal to the depth of the specified srcSubresource of srcImage

VUID-vkCmdBlitImage-srcImage-00247 If srcImage is of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D, then for each element of pRegions, srcOffsets[0].z must be 0 and srcOffsets[1].z must be 1

VUID-vkCmdBlitImage-dstOffset-00248 For each element of pRegions, dstOffsets[0].x and dstOffsets[1].x must both be greater than or equal to 0 and less than or equal to the width of the specified dstSubresource of dstImage

VUID-vkCmdBlitImage-dstOffset-00249 For each element of pRegions, dstOffsets[0].y and dstOffsets[1].y must both be greater than or equal to 0 and less than or equal to the height of the specified dstSubresource of dstImage

VUID-vkCmdBlitImage-dstImage-00250 If dstImage is of type VK_IMAGE_TYPE_1D, then for each element of pRegions, dstOffsets[0].y must be 0 and dstOffsets[1].y must be 1

VUID-vkCmdBlitImage-dstOffset-00251 For each element of pRegions, dstOffsets[0].z and dstOffsets[1].z must both be greater than or equal to 0 and less than or equal to the depth of the specified dstSubresource of dstImage

VUID-vkCmdBlitImage-dstImage-00252 If dstImage is of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D, then for each element of pRegions, dstOffsets[0].z must be 0 and dstOffsets[1].z must be 1

VUID-vkCmdBlitImage-commandBuffer-parameter commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdBlitImage-srcImage-parameter srcImage must be a valid VkImage handle

VUID-vkCmdBlitImage-srcImageLayout-parameter srcImageLayout must be a valid VkImageLayout value

VUID-vkCmdBlitImage-dstImage-parameter dstImage must be a valid VkImage handle

VUID-vkCmdBlitImage-dstImageLayout-parameter dstImageLayout must be a valid VkImageLayout value

VUID-vkCmdBlitImage-pRegions-parameter pRegions must be a valid pointer to an array of regionCount valid VkImageBlit structures

VUID-vkCmdBlitImage-filter-parameter filter must be a valid VkFilter value

VUID-vkCmdBlitImage-commandBuffer-recording commandBuffer must be in the recording state

VUID-vkCmdBlitImage-commandBuffer-cmdpool The VkCommandPool that commandBuffer was allocated from must support graphics operations

VUID-vkCmdBlitImage-renderpass This command must only be called outside of a render pass instance

VUID-vkCmdBlitImage-videocoding This command must only be called outside of a video coding scope

VUID-vkCmdBlitImage-regionCount-arraylength regionCount must be greater than 0

VUID-vkCmdBlitImage-commonparent Each of commandBuffer, dstImage, and srcImage must have been created, allocated, or retrieved from the same VkDevice

Host access to commandBuffer must be externally synchronized

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

Primary Secondary

Outside

Outside

Graphics

Action