C Specification

To copy regions of a source image into a destination image, potentially performing format conversion, arbitrary scaling, and filtering, call:

// Provided by VK_KHR_copy_commands2
void vkCmdBlitImage2KHR(
    VkCommandBuffer                             commandBuffer,
    const VkBlitImageInfo2KHR*                  pBlitImageInfo);

Parameters

  • commandBuffer is the command buffer into which the command will be recorded.

  • pBlitImageInfo is a pointer to a VkBlitImageInfo2KHR structure describing the blit parameters.

Description

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

Valid Usage
  • VUID-vkCmdBlitImage2KHR-commandBuffer-01834
    If commandBuffer is an unprotected command buffer, then srcImage must not be a protected image

  • VUID-vkCmdBlitImage2KHR-commandBuffer-01835
    If commandBuffer is an unprotected command buffer, then dstImage must not be a protected image

  • VUID-vkCmdBlitImage2KHR-commandBuffer-01836
    If commandBuffer is a protected command buffer, then dstImage must not be an unprotected image

Valid Usage (Implicit)
  • VUID-vkCmdBlitImage2KHR-commandBuffer-parameter
    commandBuffer must be a valid VkCommandBuffer handle

  • VUID-vkCmdBlitImage2KHR-pBlitImageInfo-parameter
    pBlitImageInfo must be a valid pointer to a valid VkBlitImageInfo2KHR structure

  • VUID-vkCmdBlitImage2KHR-commandBuffer-recording
    commandBuffer must be in the recording state

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

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

Host Synchronization
  • Host access to commandBuffer must be externally synchronized

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

Command Properties
Command Buffer Levels Render Pass Scope Supported Queue Types Pipeline Type

Primary
Secondary

Outside

Graphics

Transfer

See Also

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.

Copyright 2014-2021 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0