VkImageCopy(3)

# VkImageCopy(3) Manual Page

## Name

VkImageCopy - Structure specifying an image copy operation

Loading… please wait.

## C Specification

The `VkImageCopy` structure is defined as:

    // Provided by VK_VERSION_1_0
    typedef struct VkImageCopy {
        VkImageSubresourceLayers    srcSubresource;
        VkOffset3D                  srcOffset;
        VkImageSubresourceLayers    dstSubresource;
        VkOffset3D                  dstOffset;
        VkExtent3D                  extent;
    } VkImageCopy;

## Members

- `srcSubresource` and `dstSubresource` are VkImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively.

- `srcOffset` and `dstOffset` select the initial `x`, `y`, and `z` offsets in texels of the sub-regions of the source and destination image data.

- `extent` is the size in texels of the image to copy in `width`, `height` and `depth`.

## Description

Valid Usage

- VUID-VkImageCopy-apiVersion-07940
  If the VK_KHR_sampler_ycbcr_conversion extension is not enabled and VkPhysicalDeviceProperties::`apiVersion` is less than Vulkan 1.1, the `aspectMask` member of `srcSubresource` and `dstSubresource` must match

- VUID-VkImageCopy-apiVersion-07941
  If the VK_KHR_maintenance1 extension is not enabled and VkPhysicalDeviceProperties::`apiVersion` is less than Vulkan 1.1, the `layerCount` member of `srcSubresource` and `dstSubresource` must match

- VUID-VkImageCopy-extent-06668
  `extent.width` must not be 0

- VUID-VkImageCopy-extent-06669
  `extent.height` must not be 0

- VUID-VkImageCopy-extent-06670
  `extent.depth` must not be 0

Valid Usage (Implicit)

- VUID-VkImageCopy-srcSubresource-parameter
  `srcSubresource` must be a valid VkImageSubresourceLayers structure

- VUID-VkImageCopy-dstSubresource-parameter
  `dstSubresource` must be a valid VkImageSubresourceLayers structure

## See Also

VK_VERSION_1_0, VkExtent3D, VkImageSubresourceLayers, VkOffset3D, vkCmdCopyImage

## 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

Copyright 2014-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0