Class VkDisplayPropertiesKHR

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

Represents VkDisplayPropertiesKHR.

Layout

struct VkDisplayPropertiesKHR {
    (uint64_t) VkDisplayKHR display;
    const char* displayName;
    (struct VkExtent2D) VkExtent2D physicalDimensions;
    (struct VkExtent2D) VkExtent2D physicalResolution;
    ((uint32_t) VkFlags) VkSurfaceTransformFlagsKHR supportedTransforms;
    (uint32_t) VkBool32 planeReorderPossible;
    (uint32_t) VkBool32 persistentContent;
};

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT
      The struct layout of VkDisplayPropertiesKHR.

    • OFFSET_display

      public static final long OFFSET_display
      The byte offset of display.

    • LAYOUT_display

      public static final MemoryLayout LAYOUT_display
      The memory layout of display.

    • VH_display

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

    • OFFSET_displayName

      public static final long OFFSET_displayName
      The byte offset of displayName.

    • LAYOUT_displayName

      public static final MemoryLayout LAYOUT_displayName
      The memory layout of displayName.

    • VH_displayName

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

    • OFFSET_physicalDimensions

      public static final long OFFSET_physicalDimensions
      The byte offset of physicalDimensions.

    • LAYOUT_physicalDimensions

      public static final MemoryLayout LAYOUT_physicalDimensions
      The memory layout of physicalDimensions.

    • OFFSET_physicalResolution

      public static final long OFFSET_physicalResolution
      The byte offset of physicalResolution.

    • LAYOUT_physicalResolution

      public static final MemoryLayout LAYOUT_physicalResolution
      The memory layout of physicalResolution.

    • OFFSET_supportedTransforms

      public static final long OFFSET_supportedTransforms
      The byte offset of supportedTransforms.

    • LAYOUT_supportedTransforms

      public static final MemoryLayout LAYOUT_supportedTransforms
      The memory layout of supportedTransforms.

    • VH_supportedTransforms

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

    • OFFSET_planeReorderPossible

      public static final long OFFSET_planeReorderPossible
      The byte offset of planeReorderPossible.

    • LAYOUT_planeReorderPossible

      public static final MemoryLayout LAYOUT_planeReorderPossible
      The memory layout of planeReorderPossible.

    • VH_planeReorderPossible

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

    • OFFSET_persistentContent

      public static final long OFFSET_persistentContent
      The byte offset of persistentContent.

    • LAYOUT_persistentContent

      public static final MemoryLayout LAYOUT_persistentContent
      The memory layout of persistentContent.

    • VH_persistentContent

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

  • Constructor Details

    • VkDisplayPropertiesKHR

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

  • Method Details

    • of

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

    • ofNative

      public static VkDisplayPropertiesKHR ofNative(MemorySegment segment)

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

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

    • alloc

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

    • copyFrom

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

    • reinterpret

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

    • display

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

    • display

      public long display()
      Returns display.
      Returns:
      display

    • display

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

    • display

      public VkDisplayPropertiesKHR display(long value)
      Sets display with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • displayName

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

    • displayName

      public MemorySegment displayName()
      Returns displayName.
      Returns:
      displayName

    • displayName

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

    • displayName

      public VkDisplayPropertiesKHR displayName(MemorySegment value)
      Sets displayName with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • physicalDimensions

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

    • physicalDimensions

      public MemorySegment physicalDimensions()
      Returns physicalDimensions.
      Returns:
      physicalDimensions

    • physicalDimensions

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

    • physicalDimensions

      public VkDisplayPropertiesKHR physicalDimensions(MemorySegment value)
      Sets physicalDimensions with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • physicalDimensions

      public VkDisplayPropertiesKHR physicalDimensions(Consumer<VkExtent2D> func)
      Accepts physicalDimensions with the given function.
      Parameters:
      func - the function
      Returns:
      this

    • physicalResolution

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

    • physicalResolution

      public MemorySegment physicalResolution()
      Returns physicalResolution.
      Returns:
      physicalResolution

    • physicalResolution

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

    • physicalResolution

      public VkDisplayPropertiesKHR physicalResolution(MemorySegment value)
      Sets physicalResolution with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • physicalResolution

      public VkDisplayPropertiesKHR physicalResolution(Consumer<VkExtent2D> func)
      Accepts physicalResolution with the given function.
      Parameters:
      func - the function
      Returns:
      this

    • supportedTransforms

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

    • supportedTransforms

      public int supportedTransforms()
      Returns supportedTransforms.
      Returns:
      supportedTransforms

    • supportedTransforms

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

    • supportedTransforms

      public VkDisplayPropertiesKHR supportedTransforms(int value)
      Sets supportedTransforms with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • planeReorderPossible

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

    • planeReorderPossible

      public int planeReorderPossible()
      Returns planeReorderPossible.
      Returns:
      planeReorderPossible

    • planeReorderPossible

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

    • planeReorderPossible

      public VkDisplayPropertiesKHR planeReorderPossible(int value)
      Sets planeReorderPossible with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • persistentContent

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

    • persistentContent

      public int persistentContent()
      Returns persistentContent.
      Returns:
      persistentContent

    • persistentContent

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

    • persistentContent

      public VkDisplayPropertiesKHR persistentContent(int value)
      Sets persistentContent with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • asSlice

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

    • asSlice

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

    • at

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

    • displayAt

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

    • displayAt

      public VkDisplayPropertiesKHR displayAt(long index, long value)
      Sets display with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • displayNameAt

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

    • displayNameAt

      public VkDisplayPropertiesKHR displayNameAt(long index, MemorySegment value)
      Sets displayName with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • physicalDimensionsAt

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

    • physicalDimensionsAt

      public VkDisplayPropertiesKHR physicalDimensionsAt(long index, MemorySegment value)
      Sets physicalDimensions with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • physicalDimensionsAt

      public VkDisplayPropertiesKHR physicalDimensionsAt(long index, Consumer<VkExtent2D> func)
      Accepts physicalDimensions with the given function.
      Parameters:
      index - the index of the struct buffer
      func - the function
      Returns:
      this

    • physicalResolutionAt

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

    • physicalResolutionAt

      public VkDisplayPropertiesKHR physicalResolutionAt(long index, MemorySegment value)
      Sets physicalResolution with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • physicalResolutionAt

      public VkDisplayPropertiesKHR physicalResolutionAt(long index, Consumer<VkExtent2D> func)
      Accepts physicalResolution with the given function.
      Parameters:
      index - the index of the struct buffer
      func - the function
      Returns:
      this

    • supportedTransformsAt

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

    • supportedTransformsAt

      public VkDisplayPropertiesKHR supportedTransformsAt(long index, int value)
      Sets supportedTransforms with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • planeReorderPossibleAt

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

    • planeReorderPossibleAt

      public VkDisplayPropertiesKHR planeReorderPossibleAt(long index, int value)
      Sets planeReorderPossible with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • persistentContentAt

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

    • persistentContentAt

      public VkDisplayPropertiesKHR persistentContentAt(long index, int value)
      Sets persistentContent with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this