Class VkDisplayPlanePropertiesKHR

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

Represents VkDisplayPlanePropertiesKHR.

Layout

struct VkDisplayPlanePropertiesKHR {
    (uint64_t) VkDisplayKHR currentDisplay;
    uint32_t currentStackIndex;
};

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT
      The struct layout of VkDisplayPlanePropertiesKHR.

    • OFFSET_currentDisplay

      public static final long OFFSET_currentDisplay
      The byte offset of currentDisplay.

    • LAYOUT_currentDisplay

      public static final MemoryLayout LAYOUT_currentDisplay
      The memory layout of currentDisplay.

    • VH_currentDisplay

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

    • OFFSET_currentStackIndex

      public static final long OFFSET_currentStackIndex
      The byte offset of currentStackIndex.

    • LAYOUT_currentStackIndex

      public static final MemoryLayout LAYOUT_currentStackIndex
      The memory layout of currentStackIndex.

    • VH_currentStackIndex

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

  • Constructor Details

    • VkDisplayPlanePropertiesKHR

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

  • Method Details

    • of

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

    • ofNative

      public static VkDisplayPlanePropertiesKHR ofNative(MemorySegment segment)

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

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

    • alloc

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

    • copyFrom

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

    • reinterpret

      public VkDisplayPlanePropertiesKHR reinterpret(long count)
      Reinterprets this buffer with the given count.
      Parameters:
      count - the new count
      Returns:
      the reinterpreted buffer

    • currentDisplay

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

    • currentDisplay

      public long currentDisplay()
      Returns currentDisplay.
      Returns:
      currentDisplay

    • currentDisplay

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

    • currentDisplay

      public VkDisplayPlanePropertiesKHR currentDisplay(long value)
      Sets currentDisplay with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • currentStackIndex

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

    • currentStackIndex

      public int currentStackIndex()
      Returns currentStackIndex.
      Returns:
      currentStackIndex

    • currentStackIndex

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

    • currentStackIndex

      public VkDisplayPlanePropertiesKHR currentStackIndex(int value)
      Sets currentStackIndex with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • asSlice

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

    • asSlice

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

    • at

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

    • currentDisplayAt

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

    • currentDisplayAt

      public VkDisplayPlanePropertiesKHR currentDisplayAt(long index, long value)
      Sets currentDisplay with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • currentStackIndexAt

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

    • currentStackIndexAt

      public VkDisplayPlanePropertiesKHR currentStackIndexAt(long index, int value)
      Sets currentStackIndex with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this