Class VkCopyMemoryToImageInfo

java.lang.Object
overrungl.struct.GroupType
overrungl.vulkan.struct.VkCopyMemoryToImageInfo
All Implemented Interfaces:
Addressable
Direct Known Subclasses:
VkCopyMemoryToImageInfo.Buffer
public sealed class VkCopyMemoryToImageInfo extends GroupType permits VkCopyMemoryToImageInfo.Buffer

Layout

struct VkCopyMemoryToImageInfo {
    (int) VkStructureType sType;
    const void* pNext;
    ((uint32_t) VkFlags) VkHostImageCopyFlags flags;
    (uint64_t) VkImage dstImage;
    (int) VkImageLayout dstImageLayout;
    uint32_t regionCount;
    const VkMemoryToImageCopy* pRegions;
};

  • Field Details

    • LAYOUT

      public static final GroupLayout LAYOUT
      The struct layout of VkCopyMemoryToImageInfo.

    • OFFSET_sType

      public static final long OFFSET_sType
      The byte offset of sType.

    • LAYOUT_sType

      public static final MemoryLayout LAYOUT_sType
      The memory layout of sType.

    • VH_sType

      public static final VarHandle VH_sType
      The VarHandle of sType of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_pNext

      public static final long OFFSET_pNext
      The byte offset of pNext.

    • LAYOUT_pNext

      public static final MemoryLayout LAYOUT_pNext
      The memory layout of pNext.

    • VH_pNext

      public static final VarHandle VH_pNext
      The VarHandle of pNext of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_flags

      public static final long OFFSET_flags
      The byte offset of flags.

    • LAYOUT_flags

      public static final MemoryLayout LAYOUT_flags
      The memory layout of flags.

    • VH_flags

      public static final VarHandle VH_flags
      The VarHandle of flags of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_dstImage

      public static final long OFFSET_dstImage
      The byte offset of dstImage.

    • LAYOUT_dstImage

      public static final MemoryLayout LAYOUT_dstImage
      The memory layout of dstImage.

    • VH_dstImage

      public static final VarHandle VH_dstImage
      The VarHandle of dstImage of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_dstImageLayout

      public static final long OFFSET_dstImageLayout
      The byte offset of dstImageLayout.

    • LAYOUT_dstImageLayout

      public static final MemoryLayout LAYOUT_dstImageLayout
      The memory layout of dstImageLayout.

    • VH_dstImageLayout

      public static final VarHandle VH_dstImageLayout
      The VarHandle of dstImageLayout of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_regionCount

      public static final long OFFSET_regionCount
      The byte offset of regionCount.

    • LAYOUT_regionCount

      public static final MemoryLayout LAYOUT_regionCount
      The memory layout of regionCount.

    • VH_regionCount

      public static final VarHandle VH_regionCount
      The VarHandle of regionCount of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_pRegions

      public static final long OFFSET_pRegions
      The byte offset of pRegions.

    • LAYOUT_pRegions

      public static final MemoryLayout LAYOUT_pRegions
      The memory layout of pRegions.

    • VH_pRegions

      public static final VarHandle VH_pRegions
      The VarHandle of pRegions of type (MemorySegment base, long baseOffset, long index)MemorySegment.

  • Constructor Details

    • VkCopyMemoryToImageInfo

      public VkCopyMemoryToImageInfo(MemorySegment segment)
      Creates VkCopyMemoryToImageInfo with the given segment.
      Parameters:
      segment - the memory segment

  • Method Details

    • of

      public static VkCopyMemoryToImageInfo.Buffer of(MemorySegment segment)
      Creates VkCopyMemoryToImageInfo with the given segment.
      Parameters:
      segment - the memory segment
      Returns:
      the created instance or null if the segment is NULL

    • ofNative

      public static VkCopyMemoryToImageInfo ofNative(MemorySegment segment)

      Creates VkCopyMemoryToImageInfo with the given segment.

      Reinterprets the segment if zero-length.

      Parameters:
      segment - the memory segment
      Returns:
      the created instance or null if the segment is NULL

    • ofNative

      public static VkCopyMemoryToImageInfo.Buffer ofNative(MemorySegment segment, long count)

      Creates VkCopyMemoryToImageInfo with the given segment.

      Reinterprets the segment if zero-length.

      Parameters:
      segment - the memory segment
      count - the count of the buffer
      Returns:
      the created instance or null if the segment is NULL

    • alloc

      public static VkCopyMemoryToImageInfo alloc(SegmentAllocator allocator)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator.
      Parameters:
      allocator - the segment allocator
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • alloc

      public static VkCopyMemoryToImageInfo.Buffer alloc(SegmentAllocator allocator, long count)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator and count.
      Parameters:
      allocator - the segment allocator
      count - the count
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • allocInit

      public static VkCopyMemoryToImageInfo allocInit(SegmentAllocator allocator, int sType, MemorySegment pNext, int flags, long dstImage, int dstImageLayout, int regionCount, MemorySegment pRegions)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator and arguments like initializer list.
      Parameters:
      allocator - the segment allocator
      sType - sType
      pNext - pNext
      flags - flags
      dstImage - dstImage
      dstImageLayout - dstImageLayout
      regionCount - regionCount
      pRegions - pRegions
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • allocInit

      public static VkCopyMemoryToImageInfo allocInit(SegmentAllocator allocator, int sType, MemorySegment pNext, int flags, long dstImage, int dstImageLayout, int regionCount)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator and arguments like initializer list.
      Parameters:
      allocator - the segment allocator
      sType - sType
      pNext - pNext
      flags - flags
      dstImage - dstImage
      dstImageLayout - dstImageLayout
      regionCount - regionCount
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • allocInit

      public static VkCopyMemoryToImageInfo allocInit(SegmentAllocator allocator, int sType, MemorySegment pNext, int flags, long dstImage, int dstImageLayout)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator and arguments like initializer list.
      Parameters:
      allocator - the segment allocator
      sType - sType
      pNext - pNext
      flags - flags
      dstImage - dstImage
      dstImageLayout - dstImageLayout
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • allocInit

      public static VkCopyMemoryToImageInfo allocInit(SegmentAllocator allocator, int sType, MemorySegment pNext, int flags, long dstImage)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator and arguments like initializer list.
      Parameters:
      allocator - the segment allocator
      sType - sType
      pNext - pNext
      flags - flags
      dstImage - dstImage
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • allocInit

      public static VkCopyMemoryToImageInfo allocInit(SegmentAllocator allocator, int sType, MemorySegment pNext, int flags)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator and arguments like initializer list.
      Parameters:
      allocator - the segment allocator
      sType - sType
      pNext - pNext
      flags - flags
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • allocInit

      public static VkCopyMemoryToImageInfo allocInit(SegmentAllocator allocator, int sType, MemorySegment pNext)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator and arguments like initializer list.
      Parameters:
      allocator - the segment allocator
      sType - sType
      pNext - pNext
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • allocInit

      public static VkCopyMemoryToImageInfo allocInit(SegmentAllocator allocator, int sType)
      Allocates a VkCopyMemoryToImageInfo with the given segment allocator and arguments like initializer list.
      Parameters:
      allocator - the segment allocator
      sType - sType
      Returns:
      the allocated VkCopyMemoryToImageInfo

    • copyFrom

      public VkCopyMemoryToImageInfo copyFrom(VkCopyMemoryToImageInfo src)
      Copies from the given source.
      Parameters:
      src - the source
      Returns:
      this

    • asBuffer

      public VkCopyMemoryToImageInfo.Buffer asBuffer()
      Converts this instance to a buffer.
      Returns:
      the buffer

    • sType

      public static int sType(MemorySegment segment, long index)
      Returns sType at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      sType at the given index

    • sType

      public int sType()
      Returns sType.
      Returns:
      sType

    • sType

      public static void sType(MemorySegment segment, long index, int value)
      Sets sType with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • sType

      public VkCopyMemoryToImageInfo sType(int value)
      Sets sType with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • pNext

      public static MemorySegment pNext(MemorySegment segment, long index)
      Returns pNext at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      pNext at the given index

    • pNext

      public MemorySegment pNext()
      Returns pNext.
      Returns:
      pNext

    • pNext

      public static void pNext(MemorySegment segment, long index, MemorySegment value)
      Sets pNext with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • pNext

      public VkCopyMemoryToImageInfo pNext(MemorySegment value)
      Sets pNext with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • flags

      public static int flags(MemorySegment segment, long index)
      Returns flags at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      flags at the given index

    • flags

      public int flags()
      Returns flags.
      Returns:
      flags

    • flags

      public static void flags(MemorySegment segment, long index, int value)
      Sets flags with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • flags

      public VkCopyMemoryToImageInfo flags(int value)
      Sets flags with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • dstImage

      public static long dstImage(MemorySegment segment, long index)
      Returns dstImage at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      dstImage at the given index

    • dstImage

      public long dstImage()
      Returns dstImage.
      Returns:
      dstImage

    • dstImage

      public static void dstImage(MemorySegment segment, long index, long value)
      Sets dstImage with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • dstImage

      public VkCopyMemoryToImageInfo dstImage(long value)
      Sets dstImage with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • dstImageLayout

      public static int dstImageLayout(MemorySegment segment, long index)
      Returns dstImageLayout at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      dstImageLayout at the given index

    • dstImageLayout

      public int dstImageLayout()
      Returns dstImageLayout.
      Returns:
      dstImageLayout

    • dstImageLayout

      public static void dstImageLayout(MemorySegment segment, long index, int value)
      Sets dstImageLayout with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • dstImageLayout

      public VkCopyMemoryToImageInfo dstImageLayout(int value)
      Sets dstImageLayout with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • regionCount

      public static int regionCount(MemorySegment segment, long index)
      Returns regionCount at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      regionCount at the given index

    • regionCount

      public int regionCount()
      Returns regionCount.
      Returns:
      regionCount

    • regionCount

      public static void regionCount(MemorySegment segment, long index, int value)
      Sets regionCount with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • regionCount

      public VkCopyMemoryToImageInfo regionCount(int value)
      Sets regionCount with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • pRegions

      public static MemorySegment pRegions(MemorySegment segment, long index)
      Returns pRegions at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      pRegions at the given index

    • pRegions

      public MemorySegment pRegions()
      Returns pRegions.
      Returns:
      pRegions

    • pRegions

      public static void pRegions(MemorySegment segment, long index, MemorySegment value)
      Sets pRegions with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • pRegions

      public VkCopyMemoryToImageInfo pRegions(MemorySegment value)
      Sets pRegions with the given value.
      Parameters:
      value - the value
      Returns:
      this