Package org.lwjgl.vulkan

Class VkCopyImageToBufferInfo2

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkCopyImageToBufferInfo2>
org.lwjgl.vulkan.VkCopyImageToBufferInfo2
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkCopyImageToBufferInfo2KHR
public class VkCopyImageToBufferInfo2 extends org.lwjgl.system.Struct<VkCopyImageToBufferInfo2> implements org.lwjgl.system.NativeResource
Structure specifying parameters of an image to buffer copy command.
Valid Usage
  • If srcImage is non-sparse then the image or the specified disjoint plane must be bound completely and contiguously to a single VkDeviceMemory object
  • The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in VkImageCreateInfo when srcImage was created
  • If imageSubresource.layerCount is not REMAINING_ARRAY_LAYERS, imageSubresource.baseArrayLayer + imageSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in VkImageCreateInfo when srcImage was created
  • srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
  • For each element of pRegions, bufferRowLength must be a multiple of the texel block extent width of the VkFormat of srcImage
  • For each element of pRegions, bufferImageHeight must be a multiple of the texel block extent height of the VkFormat of srcImage
  • For each element of pRegions, bufferRowLength divided by the texel block extent width and then multiplied by the texel block size of srcImage must be less than or equal to 231-1
  • If srcImage does not have either a depth/stencil format or a multi-planar format, then for each element of pRegions, bufferOffset must be a multiple of the texel block size
  • If srcImage has a multi-planar format, then for each element of pRegions, bufferOffset must be a multiple of the element size of the compatible format for the format and the aspectMask of the imageSubresource as defined in Compatible formats of planes of multi-planar formats
  • If srcImage has a depth/stencil format, the bufferOffset member of any element of pRegions must be a multiple of 4
  • For each element of pRegions not containing VkCopyCommandTransformInfoQCOM in its pNext chain, imageOffset.x and (imageExtent.width + imageOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified imageSubresource of srcImage
  • For each element of pRegions not containing VkCopyCommandTransformInfoQCOM in its pNext chain, imageOffset.y and (imageExtent.height + imageOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified imageSubresource of srcImage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2
  • pNext must be NULL
  • srcImage must be a valid VkImage handle
  • srcImageLayout must be a valid VkImageLayout value
  • dstBuffer must be a valid VkBuffer handle
  • pRegions must be a valid pointer to an array of regionCount valid VkBufferImageCopy2 structures
  • regionCount must be greater than 0
  • Both of dstBuffer, and srcImage must have been created, allocated, or retrieved from the same VkDevice
See Also

VkBufferImageCopy2, CmdCopyImageToBuffer2, CmdCopyImageToBuffer2KHR

Layout


 struct VkCopyImageToBufferInfo2 {
     VkStructureType sType();
     void const * pNext();
     VkImage srcImage();
     VkImageLayout srcImageLayout();
     VkBuffer dstBuffer();
     uint32_t regionCount();
     VkBufferImageCopy2 const * pRegions();
 }

  • 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.

    • SRCIMAGE

      public static final int SRCIMAGE
      The struct member offsets.

    • SRCIMAGELAYOUT

      public static final int SRCIMAGELAYOUT
      The struct member offsets.

    • DSTBUFFER

      public static final int DSTBUFFER
      The struct member offsets.

    • REGIONCOUNT

      public static final int REGIONCOUNT
      The struct member offsets.

    • PREGIONS

      public static final int PREGIONS
      The struct member offsets.

  • Constructor Details

    • VkCopyImageToBufferInfo2

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

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkCopyImageToBufferInfo2>

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • srcImage

      public long srcImage()
      the source image.

    • srcImageLayout

      public int srcImageLayout()
      the layout of the source image subresources for the copy.

    • dstBuffer

      public long dstBuffer()
      the destination buffer.

    • regionCount

      public int regionCount()
      the number of regions to copy.

    • pRegions

      public VkBufferImageCopy2.Buffer pRegions()
      a pointer to an array of VkBufferImageCopy2 structures specifying the regions to copy.

    • sType

      public VkCopyImageToBufferInfo2 sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkCopyImageToBufferInfo2 sType$Default()
      Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 value to the sType() field.

    • pNext

      public VkCopyImageToBufferInfo2 pNext(long value)
      Sets the specified value to the pNext() field.

    • srcImage

      public VkCopyImageToBufferInfo2 srcImage(long value)
      Sets the specified value to the srcImage() field.

    • srcImageLayout

      public VkCopyImageToBufferInfo2 srcImageLayout(int value)
      Sets the specified value to the srcImageLayout() field.

    • dstBuffer

      public VkCopyImageToBufferInfo2 dstBuffer(long value)
      Sets the specified value to the dstBuffer() field.

    • pRegions

      public VkCopyImageToBufferInfo2 pRegions(VkBufferImageCopy2.Buffer value)
      Sets the address of the specified VkBufferImageCopy2.Buffer to the pRegions() field.

    • set

      public VkCopyImageToBufferInfo2 set(int sType, long pNext, long srcImage, int srcImageLayout, long dstBuffer, VkBufferImageCopy2.Buffer pRegions)
      Initializes this struct with the specified values.

    • set

      public VkCopyImageToBufferInfo2 set(VkCopyImageToBufferInfo2 src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static VkCopyImageToBufferInfo2 malloc()
      Returns a new VkCopyImageToBufferInfo2 instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static VkCopyImageToBufferInfo2 calloc()
      Returns a new VkCopyImageToBufferInfo2 instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static VkCopyImageToBufferInfo2 create()
      Returns a new VkCopyImageToBufferInfo2 instance allocated with BufferUtils.

    • create

      public static VkCopyImageToBufferInfo2 create(long address)
      Returns a new VkCopyImageToBufferInfo2 instance for the specified memory address.

    • createSafe

      public static @Nullable VkCopyImageToBufferInfo2 createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkCopyImageToBufferInfo2.Buffer malloc(int capacity)
      Returns a new VkCopyImageToBufferInfo2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkCopyImageToBufferInfo2.Buffer calloc(int capacity)
      Returns a new VkCopyImageToBufferInfo2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkCopyImageToBufferInfo2.Buffer create(int capacity)
      Returns a new VkCopyImageToBufferInfo2.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkCopyImageToBufferInfo2.Buffer create(long address, int capacity)
      Create a VkCopyImageToBufferInfo2.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkCopyImageToBufferInfo2.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkCopyImageToBufferInfo2 malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkCopyImageToBufferInfo2 instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkCopyImageToBufferInfo2 calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkCopyImageToBufferInfo2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VkCopyImageToBufferInfo2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkCopyImageToBufferInfo2.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkCopyImageToBufferInfo2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkCopyImageToBufferInfo2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • nsType

      public static int nsType(long struct)
      Unsafe version of sType().

    • npNext

      public static long npNext(long struct)
      Unsafe version of pNext().

    • nsrcImage

      public static long nsrcImage(long struct)
      Unsafe version of srcImage().

    • nsrcImageLayout

      public static int nsrcImageLayout(long struct)
      Unsafe version of srcImageLayout().

    • ndstBuffer

      public static long ndstBuffer(long struct)
      Unsafe version of dstBuffer().

    • nregionCount

      public static int nregionCount(long struct)
      Unsafe version of regionCount().

    • npRegions

      public static VkBufferImageCopy2.Buffer npRegions(long struct)
      Unsafe version of pRegions().

    • nsType

      public static void nsType(long struct, int value)
      Unsafe version of sType.

    • npNext

      public static void npNext(long struct, long value)
      Unsafe version of pNext.

    • nsrcImage

      public static void nsrcImage(long struct, long value)
      Unsafe version of srcImage.

    • nsrcImageLayout

      public static void nsrcImageLayout(long struct, int value)
      Unsafe version of srcImageLayout.

    • ndstBuffer

      public static void ndstBuffer(long struct, long value)
      Unsafe version of dstBuffer.

    • nregionCount

      public static void nregionCount(long struct, int value)
      Sets the specified value to the regionCount field of the specified struct.

    • npRegions

      public static void npRegions(long struct, VkBufferImageCopy2.Buffer value)
      Unsafe version of pRegions.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate