Package org.lwjgl.vulkan

Class VkImageToMemoryCopyEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkImageToMemoryCopyEXT>
org.lwjgl.vulkan.VkImageToMemoryCopyEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkImageToMemoryCopyEXT extends org.lwjgl.system.Struct<VkImageToMemoryCopyEXT> implements org.lwjgl.system.NativeResource
Structure specifying an image to host memory copy operation.
Description

This structure is functionally similar to VkBufferImageCopy2, except it defines host memory as the target of copy instead of a buffer. In particular, the same data packing rules and restrictions as that structure apply here as well.

Valid Usage
  • pHostPointer must point to memory that is large enough to contain all memory locations that are accessed according to Buffer and Image Addressing, for each element of pRegions
  • The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory
  • bufferRowLength must be 0, or greater than or equal to the width member of imageExtent
  • bufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
  • The aspectMask member of imageSubresource must only have a single bit set
  • imageExtent.width must not be 0
  • imageExtent.height must not be 0
  • imageExtent.depth must not be 0
Valid Usage (Implicit)
See Also

VkCopyImageToMemoryInfoEXT, VkExtent3D, VkImageSubresourceLayers, VkOffset3D

Layout


 struct VkImageToMemoryCopyEXT {
     VkStructureType sType();
     void const * pNext();
     void * pHostPointer();
     uint32_t memoryRowLength();
     uint32_t memoryImageHeight();
     VkImageSubresourceLayers imageSubresource();
     VkOffset3D imageOffset();
     VkExtent3D imageExtent();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • PHOSTPOINTER

      public static final int PHOSTPOINTER
      The struct member offsets.

    • MEMORYROWLENGTH

      public static final int MEMORYROWLENGTH
      The struct member offsets.

    • MEMORYIMAGEHEIGHT

      public static final int MEMORYIMAGEHEIGHT
      The struct member offsets.

    • IMAGESUBRESOURCE

      public static final int IMAGESUBRESOURCE
      The struct member offsets.

    • IMAGEOFFSET

      public static final int IMAGEOFFSET
      The struct member offsets.

    • IMAGEEXTENT

      public static final int IMAGEEXTENT
      The struct member offsets.

  • Constructor Details

    • VkImageToMemoryCopyEXT

      public VkImageToMemoryCopyEXT(ByteBuffer container)
      Creates a VkImageToMemoryCopyEXT 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.

  • Method Details