Record Class VkRect2D

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

Represents a pointer to a VkRect2D structure in native memory.

Structure

typedef struct VkRect2D {
    VkOffset2D offset;
    VkExtent2D extent;
} VkRect2D;

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

      public static final MemoryLayout.PathElement PATH$offset

    • PATH$extent

      public static final MemoryLayout.PathElement PATH$extent

    • LAYOUT$offset

      public static final StructLayout LAYOUT$offset

    • LAYOUT$extent

      public static final StructLayout LAYOUT$extent

    • SIZE$offset

      public static final long SIZE$offset

    • SIZE$extent

      public static final long SIZE$extent

    • OFFSET$offset

      public static final long OFFSET$offset

    • OFFSET$extent

      public static final long OFFSET$extent

  • Constructor Details

    • VkRect2D

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

  • Method Details

    • allocate

      public static VkRect2D allocate(Arena arena)

    • allocate

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

    • clone

      public static VkRect2D clone(Arena arena, VkRect2D src)

    • offset

      @NotNull public @NotNull VkOffset2D offset()

    • offset

      public VkRect2D offset(@NotNull @NotNull VkOffset2D value)

    • offset

      public VkRect2D offset(Consumer<@NotNull VkOffset2D> consumer)

    • extent

      @NotNull public @NotNull VkExtent2D extent()

    • extent

      public VkRect2D extent(@NotNull @NotNull VkExtent2D value)

    • extent

      public VkRect2D extent(Consumer<@NotNull VkExtent2D> consumer)

    • 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