Class VkFramebufferCreateInfo

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

Represents VkFramebufferCreateInfo.

Layout

struct VkFramebufferCreateInfo {
    (int) VkStructureType sType;
    const void* pNext;
    ((uint32_t) VkFlags) VkFramebufferCreateFlags flags;
    (uint64_t) VkRenderPass renderPass;
    uint32_t attachmentCount;
    const VkImageView* pAttachments;
    uint32_t width;
    uint32_t height;
    uint32_t layers;
};

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT
      The struct layout of VkFramebufferCreateInfo.

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

      public static final long OFFSET_renderPass
      The byte offset of renderPass.

    • LAYOUT_renderPass

      public static final MemoryLayout LAYOUT_renderPass
      The memory layout of renderPass.

    • VH_renderPass

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

    • OFFSET_attachmentCount

      public static final long OFFSET_attachmentCount
      The byte offset of attachmentCount.

    • LAYOUT_attachmentCount

      public static final MemoryLayout LAYOUT_attachmentCount
      The memory layout of attachmentCount.

    • VH_attachmentCount

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

    • OFFSET_pAttachments

      public static final long OFFSET_pAttachments
      The byte offset of pAttachments.

    • LAYOUT_pAttachments

      public static final MemoryLayout LAYOUT_pAttachments
      The memory layout of pAttachments.

    • VH_pAttachments

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

    • OFFSET_width

      public static final long OFFSET_width
      The byte offset of width.

    • LAYOUT_width

      public static final MemoryLayout LAYOUT_width
      The memory layout of width.

    • VH_width

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

    • OFFSET_height

      public static final long OFFSET_height
      The byte offset of height.

    • LAYOUT_height

      public static final MemoryLayout LAYOUT_height
      The memory layout of height.

    • VH_height

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

    • OFFSET_layers

      public static final long OFFSET_layers
      The byte offset of layers.

    • LAYOUT_layers

      public static final MemoryLayout LAYOUT_layers
      The memory layout of layers.

    • VH_layers

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

  • Constructor Details

    • VkFramebufferCreateInfo

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

  • Method Details

    • of

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

    • ofNative

      public static VkFramebufferCreateInfo ofNative(MemorySegment segment)

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

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

    • alloc

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

    • copyFrom

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

    • reinterpret

      public VkFramebufferCreateInfo 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 VkFramebufferCreateInfo 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 VkFramebufferCreateInfo 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 VkFramebufferCreateInfo flags(int value)
      Sets flags with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • renderPass

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

    • renderPass

      public long renderPass()
      Returns renderPass.
      Returns:
      renderPass

    • renderPass

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

    • renderPass

      public VkFramebufferCreateInfo renderPass(long value)
      Sets renderPass with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • attachmentCount

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

    • attachmentCount

      public int attachmentCount()
      Returns attachmentCount.
      Returns:
      attachmentCount

    • attachmentCount

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

    • attachmentCount

      public VkFramebufferCreateInfo attachmentCount(int value)
      Sets attachmentCount with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • pAttachments

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

    • pAttachments

      public MemorySegment pAttachments()
      Returns pAttachments.
      Returns:
      pAttachments

    • pAttachments

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

    • pAttachments

      public VkFramebufferCreateInfo pAttachments(MemorySegment value)
      Sets pAttachments with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • width

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

    • width

      public int width()
      Returns width.
      Returns:
      width

    • width

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

    • width

      public VkFramebufferCreateInfo width(int value)
      Sets width with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • height

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

    • height

      public int height()
      Returns height.
      Returns:
      height

    • height

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

    • height

      public VkFramebufferCreateInfo height(int value)
      Sets height with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • layers

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

    • layers

      public int layers()
      Returns layers.
      Returns:
      layers

    • layers

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

    • layers

      public VkFramebufferCreateInfo layers(int value)
      Sets layers with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • asSlice

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

    • asSlice

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

    • at

      public VkFramebufferCreateInfo at(long index, Consumer<VkFramebufferCreateInfo> func)
      Visits VkFramebufferCreateInfo 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 VkFramebufferCreateInfo 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 VkFramebufferCreateInfo 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 VkFramebufferCreateInfo 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

    • renderPassAt

      public long renderPassAt(long index)
      Returns renderPass at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      renderPass at the given index

    • renderPassAt

      public VkFramebufferCreateInfo renderPassAt(long index, long value)
      Sets renderPass with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • attachmentCountAt

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

    • attachmentCountAt

      public VkFramebufferCreateInfo attachmentCountAt(long index, int value)
      Sets attachmentCount with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • pAttachmentsAt

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

    • pAttachmentsAt

      public VkFramebufferCreateInfo pAttachmentsAt(long index, MemorySegment value)
      Sets pAttachments with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • widthAt

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

    • widthAt

      public VkFramebufferCreateInfo widthAt(long index, int value)
      Sets width with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • heightAt

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

    • heightAt

      public VkFramebufferCreateInfo heightAt(long index, int value)
      Sets height with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • layersAt

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

    • layersAt

      public VkFramebufferCreateInfo layersAt(long index, int value)
      Sets layers with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this