Package org.lwjgl.vulkan

Class VkImageResolve

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkImageResolve
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying an image resolve operation.
    Valid Usage
    • The aspectMask member of srcSubresource and dstSubresource must only contain IMAGE_ASPECT_COLOR_BIT
    • 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
    • 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
    • If the calling command’s srcImage is of type IMAGE_TYPE_1D, then srcOffset.y must be 0 and extent.height must be 1.
    • 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
    • If the calling command’s srcImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then srcOffset.z must be 0 and extent.depth must be 1.
    • 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
    • If the calling command’s dstImage is of type IMAGE_TYPE_1D, then dstOffset.y must be 0 and extent.height must be 1.
    • 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 dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then dstOffset.z must be 0 and extent.depth must be 1.
    Valid Usage (Implicit)
    See Also

    VkExtent3D, VkImageSubresourceLayers, VkOffset3D, CmdResolveImage

    Member documentation

    • srcSubresource – srcSubresource and dstSubresource are VkImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively. Resolve of depth/stencil images is not supported.
    • srcOffset – srcOffset and dstOffset select the initial x, y, and z offsets in texels of the sub-regions of the source and destination image data.
    • dstSubresource – see srcSubresource
    • dstOffset – see srcOffset
    • extent – the size in texels of the source image to resolve in width, height and depth.

    Layout

    
 struct VkImageResolve {
     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

      • VkImageResolve

        public VkImageResolve​(java.nio.ByteBuffer container)
        Creates a VkImageResolve 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.