Package org.lwjgl.vulkan

Class VkImageCopy

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkImageCopy
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying an image copy operation.
    Description

    For IMAGE_TYPE_3D images, copies are performed slice by slice starting with the z member of the srcOffset or dstOffset, and copying depth slices. For images with multiple layers, copies are performed layer by layer starting with the baseArrayLayer member of the srcSubresource or dstSubresource and copying layerCount layers. Image data can be copied between images with different image types. If one image is IMAGE_TYPE_3D and the other image is IMAGE_TYPE_2D with multiple layers, then each slice is copied to or from a different layer.

    Copies involving a multi-planar image format specify the region to be copied in terms of the plane to be copied, not the coordinates of the multi-planar image. This means that copies accessing the R/B planes of “_422” format images must fit the copied region within half the width of the parent image, and that copies accessing the R/B planes of “_420” format images must fit the copied region within half the width and height of the parent image.

    Valid Usage
    • 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)
    See Also

    VkExtent3D, VkImageSubresourceLayers, VkOffset3D, CmdCopyImage

    Layout

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

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • SRCSUBRESOURCE, SRCOFFSET, DSTSUBRESOURCE, DSTOFFSET, EXTENT

        The struct member offsets.

    • Constructor Detail

      • VkImageCopy

        public VkImageCopy​(java.nio.ByteBuffer container)
        Creates a VkImageCopy instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

        The created instance holds a strong reference to the container object.