Package org.lwjgl.vulkan

Class VkCopyImageToImageInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkCopyImageToImageInfo>
org.lwjgl.vulkan.VkCopyImageToImageInfo
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
Direct Known Subclasses:
VkCopyImageToImageInfoEXT
public class VkCopyImageToImageInfo extends Struct<VkCopyImageToImageInfo> implements NativeResource

 struct VkCopyImageToImageInfo {
     VkStructureType sType;
     void const * pNext;
     VkHostImageCopyFlags flags;
     VkImage srcImage;
     VkImageLayout srcImageLayout;
     VkImage dstImage;
     VkImageLayout dstImageLayout;
     uint32_t regionCount;
     {@link VkImageCopy2 VkImageCopy2} 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.

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • SRCIMAGE

      public static final int SRCIMAGE
      The struct member offsets.

    • SRCIMAGELAYOUT

      public static final int SRCIMAGELAYOUT
      The struct member offsets.

    • DSTIMAGE

      public static final int DSTIMAGE
      The struct member offsets.

    • DSTIMAGELAYOUT

      public static final int DSTIMAGELAYOUT
      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

    • VkCopyImageToImageInfo

      public VkCopyImageToImageInfo(ByteBuffer container)
      Creates a VkCopyImageToImageInfo 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()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<VkCopyImageToImageInfo>

    • sType

      public int sType()
      Returns:
      the value of the sType field.

    • pNext

      public long pNext()
      Returns:
      the value of the pNext field.

    • flags

      public int flags()
      Returns:
      the value of the flags field.

    • srcImage

      public long srcImage()
      Returns:
      the value of the srcImage field.

    • srcImageLayout

      public int srcImageLayout()
      Returns:
      the value of the srcImageLayout field.

    • dstImage

      public long dstImage()
      Returns:
      the value of the dstImage field.

    • dstImageLayout

      public int dstImageLayout()
      Returns:
      the value of the dstImageLayout field.

    • regionCount

      public int regionCount()
      Returns:
      the value of the regionCount field.

    • pRegions

      public VkImageCopy2.Buffer pRegions()
      Returns:
      a VkImageCopy2.Buffer view of the struct array pointed to by the pRegions field.

    • sType

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

    • sType$Default

      public VkCopyImageToImageInfo sType$Default()
      Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO value to the sType field.

    • pNext

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

    • flags

      public VkCopyImageToImageInfo flags(int value)
      Sets the specified value to the flags field.

    • srcImage

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

    • srcImageLayout

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

    • dstImage

      public VkCopyImageToImageInfo dstImage(long value)
      Sets the specified value to the dstImage field.

    • dstImageLayout

      public VkCopyImageToImageInfo dstImageLayout(int value)
      Sets the specified value to the dstImageLayout field.

    • pRegions

      public VkCopyImageToImageInfo pRegions(VkImageCopy2.Buffer value)
      Sets the address of the specified VkImageCopy2.Buffer to the pRegions field.

    • set

      public VkCopyImageToImageInfo set(int sType, long pNext, int flags, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageCopy2.Buffer pRegions)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

      public static VkCopyImageToImageInfo.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new VkCopyImageToImageInfo.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().

    • nflags

      public static int nflags(long struct)
      Unsafe version of flags().

    • nsrcImage

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

    • nsrcImageLayout

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

    • ndstImage

      public static long ndstImage(long struct)
      Unsafe version of dstImage().

    • ndstImageLayout

      public static int ndstImageLayout(long struct)
      Unsafe version of dstImageLayout().

    • nregionCount

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

    • npRegions

      public static VkImageCopy2.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.

    • nflags

      public static void nflags(long struct, int value)
      Unsafe version of flags.

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

    • ndstImage

      public static void ndstImage(long struct, long value)
      Unsafe version of dstImage.

    • ndstImageLayout

      public static void ndstImageLayout(long struct, int value)
      Unsafe version of dstImageLayout.

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