Class VkAttachmentDescription2

java.lang.Object
overrungl.struct.GroupType
overrungl.vulkan.struct.VkAttachmentDescription2
All Implemented Interfaces:
Addressable
public final class VkAttachmentDescription2 extends GroupType

Represents VkAttachmentDescription2.

Layout

struct VkAttachmentDescription2 {
    (int) VkStructureType sType;
    const void* pNext;
    ((uint32_t) VkFlags) VkAttachmentDescriptionFlags flags;
    (int) VkFormat format;
    (int) VkSampleCountFlagBits samples;
    (int) VkAttachmentLoadOp loadOp;
    (int) VkAttachmentStoreOp storeOp;
    (int) VkAttachmentLoadOp stencilLoadOp;
    (int) VkAttachmentStoreOp stencilStoreOp;
    (int) VkImageLayout initialLayout;
    (int) VkImageLayout finalLayout;
};

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT
      The struct layout of VkAttachmentDescription2.

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

      public static final long OFFSET_format
      The byte offset of format.

    • LAYOUT_format

      public static final MemoryLayout LAYOUT_format
      The memory layout of format.

    • VH_format

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

    • OFFSET_samples

      public static final long OFFSET_samples
      The byte offset of samples.

    • LAYOUT_samples

      public static final MemoryLayout LAYOUT_samples
      The memory layout of samples.

    • VH_samples

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

    • OFFSET_loadOp

      public static final long OFFSET_loadOp
      The byte offset of loadOp.

    • LAYOUT_loadOp

      public static final MemoryLayout LAYOUT_loadOp
      The memory layout of loadOp.

    • VH_loadOp

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

    • OFFSET_storeOp

      public static final long OFFSET_storeOp
      The byte offset of storeOp.

    • LAYOUT_storeOp

      public static final MemoryLayout LAYOUT_storeOp
      The memory layout of storeOp.

    • VH_storeOp

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

    • OFFSET_stencilLoadOp

      public static final long OFFSET_stencilLoadOp
      The byte offset of stencilLoadOp.

    • LAYOUT_stencilLoadOp

      public static final MemoryLayout LAYOUT_stencilLoadOp
      The memory layout of stencilLoadOp.

    • VH_stencilLoadOp

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

    • OFFSET_stencilStoreOp

      public static final long OFFSET_stencilStoreOp
      The byte offset of stencilStoreOp.

    • LAYOUT_stencilStoreOp

      public static final MemoryLayout LAYOUT_stencilStoreOp
      The memory layout of stencilStoreOp.

    • VH_stencilStoreOp

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

    • OFFSET_initialLayout

      public static final long OFFSET_initialLayout
      The byte offset of initialLayout.

    • LAYOUT_initialLayout

      public static final MemoryLayout LAYOUT_initialLayout
      The memory layout of initialLayout.

    • VH_initialLayout

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

    • OFFSET_finalLayout

      public static final long OFFSET_finalLayout
      The byte offset of finalLayout.

    • LAYOUT_finalLayout

      public static final MemoryLayout LAYOUT_finalLayout
      The memory layout of finalLayout.

    • VH_finalLayout

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

  • Constructor Details

    • VkAttachmentDescription2

      public VkAttachmentDescription2(MemorySegment segment, long elementCount)
      Creates VkAttachmentDescription2 with the given segment.
      Parameters:
      segment - the memory segment
      elementCount - the element count of this struct buffer

  • Method Details

    • of

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

    • ofNative

      public static VkAttachmentDescription2 ofNative(MemorySegment segment)

      Creates VkAttachmentDescription2 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 VkAttachmentDescription2 ofNative(MemorySegment segment, long count)

      Creates VkAttachmentDescription2 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 VkAttachmentDescription2 alloc(SegmentAllocator allocator)
      Allocates a VkAttachmentDescription2 with the given segment allocator.
      Parameters:
      allocator - the segment allocator
      Returns:
      the allocated VkAttachmentDescription2

    • alloc

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

    • copyFrom

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

    • reinterpret

      public VkAttachmentDescription2 reinterpret(long count)
      Reinterprets this buffer with the given count.
      Parameters:
      count - the new count
      Returns:
      the reinterpreted 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 VkAttachmentDescription2 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 VkAttachmentDescription2 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 VkAttachmentDescription2 flags(int value)
      Sets flags with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • format

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

    • format

      public int format()
      Returns format.
      Returns:
      format

    • format

      public static void format(MemorySegment segment, long index, int value)
      Sets format 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

    • format

      public VkAttachmentDescription2 format(int value)
      Sets format with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • samples

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

    • samples

      public int samples()
      Returns samples.
      Returns:
      samples

    • samples

      public static void samples(MemorySegment segment, long index, int value)
      Sets samples 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

    • samples

      public VkAttachmentDescription2 samples(int value)
      Sets samples with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • loadOp

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

    • loadOp

      public int loadOp()
      Returns loadOp.
      Returns:
      loadOp

    • loadOp

      public static void loadOp(MemorySegment segment, long index, int value)
      Sets loadOp 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

    • loadOp

      public VkAttachmentDescription2 loadOp(int value)
      Sets loadOp with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • storeOp

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

    • storeOp

      public int storeOp()
      Returns storeOp.
      Returns:
      storeOp

    • storeOp

      public static void storeOp(MemorySegment segment, long index, int value)
      Sets storeOp 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

    • storeOp

      public VkAttachmentDescription2 storeOp(int value)
      Sets storeOp with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • stencilLoadOp

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

    • stencilLoadOp

      public int stencilLoadOp()
      Returns stencilLoadOp.
      Returns:
      stencilLoadOp

    • stencilLoadOp

      public static void stencilLoadOp(MemorySegment segment, long index, int value)
      Sets stencilLoadOp 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

    • stencilLoadOp

      public VkAttachmentDescription2 stencilLoadOp(int value)
      Sets stencilLoadOp with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • stencilStoreOp

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

    • stencilStoreOp

      public int stencilStoreOp()
      Returns stencilStoreOp.
      Returns:
      stencilStoreOp

    • stencilStoreOp

      public static void stencilStoreOp(MemorySegment segment, long index, int value)
      Sets stencilStoreOp 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

    • stencilStoreOp

      public VkAttachmentDescription2 stencilStoreOp(int value)
      Sets stencilStoreOp with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • initialLayout

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

    • initialLayout

      public int initialLayout()
      Returns initialLayout.
      Returns:
      initialLayout

    • initialLayout

      public static void initialLayout(MemorySegment segment, long index, int value)
      Sets initialLayout 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

    • initialLayout

      public VkAttachmentDescription2 initialLayout(int value)
      Sets initialLayout with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • finalLayout

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

    • finalLayout

      public int finalLayout()
      Returns finalLayout.
      Returns:
      finalLayout

    • finalLayout

      public static void finalLayout(MemorySegment segment, long index, int value)
      Sets finalLayout 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

    • finalLayout

      public VkAttachmentDescription2 finalLayout(int value)
      Sets finalLayout with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • asSlice

      public VkAttachmentDescription2 asSlice(long index)
      Creates a slice of VkAttachmentDescription2.
      Parameters:
      index - the index of the struct buffer
      Returns:
      the slice of VkAttachmentDescription2

    • asSlice

      public VkAttachmentDescription2 asSlice(long index, long count)
      Creates a slice of VkAttachmentDescription2.
      Parameters:
      index - the index of the struct buffer
      count - the count
      Returns:
      the slice of VkAttachmentDescription2

    • at

      public VkAttachmentDescription2 at(long index, Consumer<VkAttachmentDescription2> func)
      Visits VkAttachmentDescription2 buffer at the given index.
      Parameters:
      index - the index of this buffer
      func - the function to run with the slice of this buffer
      Returns:
      this

    • sTypeAt

      public int sTypeAt(long index)
      Returns sType at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      sType at the given index

    • sTypeAt

      public VkAttachmentDescription2 sTypeAt(long index, int value)
      Sets sType with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • pNextAt

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

    • pNextAt

      public VkAttachmentDescription2 pNextAt(long index, MemorySegment value)
      Sets pNext with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • flagsAt

      public int flagsAt(long index)
      Returns flags at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      flags at the given index

    • flagsAt

      public VkAttachmentDescription2 flagsAt(long index, int value)
      Sets flags with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • formatAt

      public int formatAt(long index)
      Returns format at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      format at the given index

    • formatAt

      public VkAttachmentDescription2 formatAt(long index, int value)
      Sets format with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • samplesAt

      public int samplesAt(long index)
      Returns samples at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      samples at the given index

    • samplesAt

      public VkAttachmentDescription2 samplesAt(long index, int value)
      Sets samples with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • loadOpAt

      public int loadOpAt(long index)
      Returns loadOp at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      loadOp at the given index

    • loadOpAt

      public VkAttachmentDescription2 loadOpAt(long index, int value)
      Sets loadOp with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • storeOpAt

      public int storeOpAt(long index)
      Returns storeOp at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      storeOp at the given index

    • storeOpAt

      public VkAttachmentDescription2 storeOpAt(long index, int value)
      Sets storeOp with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • stencilLoadOpAt

      public int stencilLoadOpAt(long index)
      Returns stencilLoadOp at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      stencilLoadOp at the given index

    • stencilLoadOpAt

      public VkAttachmentDescription2 stencilLoadOpAt(long index, int value)
      Sets stencilLoadOp with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • stencilStoreOpAt

      public int stencilStoreOpAt(long index)
      Returns stencilStoreOp at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      stencilStoreOp at the given index

    • stencilStoreOpAt

      public VkAttachmentDescription2 stencilStoreOpAt(long index, int value)
      Sets stencilStoreOp with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • initialLayoutAt

      public int initialLayoutAt(long index)
      Returns initialLayout at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      initialLayout at the given index

    • initialLayoutAt

      public VkAttachmentDescription2 initialLayoutAt(long index, int value)
      Sets initialLayout with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • finalLayoutAt

      public int finalLayoutAt(long index)
      Returns finalLayout at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      finalLayout at the given index

    • finalLayoutAt

      public VkAttachmentDescription2 finalLayoutAt(long index, int value)
      Sets finalLayout with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this