Class VkDisplayModePropertiesKHR

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

Represents VkDisplayModePropertiesKHR.

Layout

struct VkDisplayModePropertiesKHR {
    (uint64_t) VkDisplayModeKHR displayMode;
    (struct VkDisplayModeParametersKHR) VkDisplayModeParametersKHR parameters;
};

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT
      The struct layout of VkDisplayModePropertiesKHR.

    • OFFSET_displayMode

      public static final long OFFSET_displayMode
      The byte offset of displayMode.

    • LAYOUT_displayMode

      public static final MemoryLayout LAYOUT_displayMode
      The memory layout of displayMode.

    • VH_displayMode

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

    • OFFSET_parameters

      public static final long OFFSET_parameters
      The byte offset of parameters.

    • LAYOUT_parameters

      public static final MemoryLayout LAYOUT_parameters
      The memory layout of parameters.

  • Constructor Details

    • VkDisplayModePropertiesKHR

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

  • Method Details

    • of

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

    • ofNative

      public static VkDisplayModePropertiesKHR ofNative(MemorySegment segment)

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

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

    • alloc

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

    • copyFrom

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

    • reinterpret

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

    • displayMode

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

    • displayMode

      public long displayMode()
      Returns displayMode.
      Returns:
      displayMode

    • displayMode

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

    • displayMode

      public VkDisplayModePropertiesKHR displayMode(long value)
      Sets displayMode with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • parameters

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

    • parameters

      public MemorySegment parameters()
      Returns parameters.
      Returns:
      parameters

    • parameters

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

    • parameters

      public VkDisplayModePropertiesKHR parameters(MemorySegment value)
      Sets parameters with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • parameters

      public VkDisplayModePropertiesKHR parameters(Consumer<VkDisplayModeParametersKHR> func)
      Accepts parameters with the given function.
      Parameters:
      func - the function
      Returns:
      this

    • asSlice

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

    • asSlice

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

    • at

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

    • displayModeAt

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

    • displayModeAt

      public VkDisplayModePropertiesKHR displayModeAt(long index, long value)
      Sets displayMode with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • parametersAt

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

    • parametersAt

      public VkDisplayModePropertiesKHR parametersAt(long index, MemorySegment value)
      Sets parameters with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • parametersAt

      public VkDisplayModePropertiesKHR parametersAt(long index, Consumer<VkDisplayModeParametersKHR> func)
      Accepts parameters with the given function.
      Parameters:
      index - the index of the struct buffer
      func - the function
      Returns:
      this