Record Class VkPresentIdKHR

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkPresentIdKHR
All Implemented Interfaces:
IPointer, IVkPresentIdKHR
@ValueBasedCandidate @UnsafeConstructor public record VkPresentIdKHR(@NotNull MemorySegment segment) extends Record implements IVkPresentIdKHR

Represents a pointer to a VkPresentIdKHR structure in native memory.

Structure

typedef struct VkPresentIdKHR {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t swapchainCount;
    uint64_t const* pPresentIds; // optional
} VkPresentIdKHR;

Auto initialization

This structure has the following members that can be automatically initialized:

  • sType = VK_STRUCTURE_TYPE_PRESENT_ID_KHR

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also:

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$sType

      public static final MemoryLayout.PathElement PATH$sType

    • PATH$pNext

      public static final MemoryLayout.PathElement PATH$pNext

    • PATH$swapchainCount

      public static final MemoryLayout.PathElement PATH$swapchainCount

    • PATH$pPresentIds

      public static final MemoryLayout.PathElement PATH$pPresentIds

    • LAYOUT$sType

      public static final ValueLayout.OfInt LAYOUT$sType

    • LAYOUT$pNext

      public static final AddressLayout LAYOUT$pNext

    • LAYOUT$swapchainCount

      public static final ValueLayout.OfInt LAYOUT$swapchainCount

    • LAYOUT$pPresentIds

      public static final AddressLayout LAYOUT$pPresentIds

    • SIZE$sType

      public static final long SIZE$sType

    • SIZE$pNext

      public static final long SIZE$pNext

    • SIZE$swapchainCount

      public static final long SIZE$swapchainCount

    • SIZE$pPresentIds

      public static final long SIZE$pPresentIds

    • OFFSET$sType

      public static final long OFFSET$sType

    • OFFSET$pNext

      public static final long OFFSET$pNext

    • OFFSET$swapchainCount

      public static final long OFFSET$swapchainCount

    • OFFSET$pPresentIds

      public static final long OFFSET$pPresentIds

  • Constructor Details

    • VkPresentIdKHR

      public VkPresentIdKHR(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a VkPresentIdKHR record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details

    • allocate

      public static VkPresentIdKHR allocate(Arena arena)

    • allocate

      public static VkPresentIdKHR.Ptr allocate(Arena arena, long count)

    • clone

      public static VkPresentIdKHR clone(Arena arena, VkPresentIdKHR src)

    • autoInit

      public void autoInit()

    • sType

      @EnumType(VkStructureType.class) public int sType()

    • sType

      public VkPresentIdKHR sType(@EnumType(VkStructureType.class) int value)

    • pNext

      @Pointer(comment="void*") public MemorySegment pNext()

    • pNext

      public void pNext(@Pointer(comment="void*") MemorySegment value)

    • pNext

      public VkPresentIdKHR pNext(@Nullable @Nullable IPointer pointer)

    • swapchainCount

      @Unsigned public int swapchainCount()

    • swapchainCount

      public VkPresentIdKHR swapchainCount(@Unsigned int value)

    • pPresentIds

      @Nullable @Unsigned public @Nullable LongPtr pPresentIds()
      Note: the returned LongPtr does not have correct LongPtr.size() property. It's up to user to track the size of the buffer, and use LongPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

    • pPresentIds

      public VkPresentIdKHR pPresentIds(@Nullable @Unsigned @Nullable LongPtr value)

    • pPresentIdsRaw

      @Pointer(comment="uint64_t*") public MemorySegment pPresentIdsRaw()

    • pPresentIdsRaw

      public void pPresentIdsRaw(@Pointer(comment="uint64_t*") MemorySegment value)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • segment

      @NotNull public @NotNull MemorySegment segment()
      Returns the value of the segment record component.
      Specified by:
      segment in interface IPointer
      Returns:
      the value of the segment record component