Record Class VkMemoryHeap

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

Represents a pointer to a VkMemoryHeap structure in native memory.

Structure

typedef struct VkMemoryHeap {
    VkDeviceSize size;
    VkMemoryHeapFlags flags; // optional
} VkMemoryHeap;

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$size

      public static final MemoryLayout.PathElement PATH$size

    • PATH$flags

      public static final MemoryLayout.PathElement PATH$flags

    • LAYOUT$size

      public static final ValueLayout.OfLong LAYOUT$size

    • LAYOUT$flags

      public static final ValueLayout.OfInt LAYOUT$flags

    • SIZE$size

      public static final long SIZE$size

    • SIZE$flags

      public static final long SIZE$flags

    • OFFSET$size

      public static final long OFFSET$size

    • OFFSET$flags

      public static final long OFFSET$flags

  • Constructor Details

    • VkMemoryHeap

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

  • Method Details

    • allocate

      public static VkMemoryHeap allocate(Arena arena)

    • allocate

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

    • clone

      public static VkMemoryHeap clone(Arena arena, VkMemoryHeap src)

    • size

      @NativeType("VkDeviceSize") @Unsigned public long size()

    • size

      public VkMemoryHeap size(@NativeType("VkDeviceSize") @Unsigned long value)

    • flags

      @EnumType(VkMemoryHeapFlags.class) public int flags()

    • flags

      public VkMemoryHeap flags(@EnumType(VkMemoryHeapFlags.class) int 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