Class VkImageCopy

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer


    public class VkImageCopy
    extends Struct
    Khronos Reference Page
    Vulkan Specification

    Specifies the image regions to copy.

    Valid Usage
    • srcSubresource must be a valid VkImageSubresourceLayers structure
    • dstSubresource must be a valid VkImageSubresourceLayers structure
    • The aspectMask member of srcSubresource and dstSubresource must match
    • The layerCount member of srcSubresource and dstSubresource must match
    • If either of the calling command's srcImage or dstImage parameters are of VkImageType IMAGE_TYPE_3D, the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
    • The aspectMask member of srcSubresource must specify aspects present in the calling command's srcImage
    • The aspectMask member of dstSubresource must specify aspects present in the calling command's dstImage
    • srcOffset.x and (extent.width + srcOffset.x) must both be greater than or equal to 0 and less than or equal to the source image subresource width
    • srcOffset.y and (extent.height + srcOffset.y) must both be greater than or equal to 0 and less than or equal to the source image subresource height
    • srcOffset.z and (extent.depth + srcOffset.z) must both be greater than or equal to 0 and less than or equal to the source image subresource depth
    • dstOffset.x and (extent.width + dstOffset.x) must both be greater than or equal to 0 and less than or equal to the destination image subresource width
    • dstOffset.y and (extent.height + dstOffset.y) must both be greater than or equal to 0 and less than or equal to the destination image subresource height
    • dstOffset.z and (extent.depth + dstOffset.z) must both be greater than or equal to 0 and less than or equal to the destination image subresource depth
    • If the calling command's srcImage is a compressed format image:
    • If the calling command's dstImage is a compressed format image:
    • srcOffset, dstOffset, and extent must respect the image transfer granularity requirements of the queue family that it will be submitted against, as described in Physical Device Enumeration

    Member documentation

    • srcSubresource – a VkImageSubresourceLayers structure specifying the image subresource of the image used for the source image data
    • srcOffset – selects the initial x, y, and z offsets in texels of the sub-regions of the source image data
    • dstSubresource – an VkImageSubresourceLayers structure specifying the image subresource of the image used for the destination image data
    • dstOffset – selects the initial x, y, and z offsets in texels of the sub-regions of the destination image data
    • extent – the size in texels of the source image to copy in width, height and depth

    Layout

    struct VkImageCopy {
        VkImageSubresourceLayers srcSubresource;
        VkOffset3D srcOffset;
        VkImageSubresourceLayers dstSubresource;
        VkOffset3D dstOffset;
        VkExtent3D extent;
    }