VkImageCopy2KHR(3)

# VkImageCopy2KHR(3) Manual Page

## Name

VkImageCopy2KHR - Structure specifying an image copy operation

Loading… please wait.

## C Specification

The `VkImageCopy2KHR` structure is defined as:

    // Provided by VK_KHR_copy_commands2
    typedef struct VkImageCopy2KHR {
        VkStructureType             sType;
        const void*                 pNext;
        VkImageSubresourceLayers    srcSubresource;
        VkOffset3D                  srcOffset;
        VkImageSubresourceLayers    dstSubresource;
        VkOffset3D                  dstOffset;
        VkExtent3D                  extent;
    } VkImageCopy2KHR;

## Members

- `sType` is the type of this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `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-VkImageCopy2KHR-extent-00140
  The number of slices of the `extent` (for 3D) or layers of the `srcSubresource` (for non-3D) must match the number of slices of the `extent` (for 3D) or layers of the `dstSubresource` (for non-3D)

Valid Usage (Implicit)

- VUID-VkImageCopy2KHR-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_IMAGE_COPY_2_KHR`

- VUID-VkImageCopy2KHR-pNext-pNext
  `pNext` must be `NULL`

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

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

## See Also

VkCopyImageInfo2KHR, VkExtent3D, VkImageSubresourceLayers, VkOffset3D, VkStructureType

## 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-2021 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0