Record Class SDL_Vertex

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

Vertex structure.

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_Vertex {
    SDL_FPoint position;
    SDL_FColor color;
    SDL_FPoint tex_coord;
} SDL_Vertex;

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.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$position

      public static final MemoryLayout.PathElement PATH$position

    • PATH$color

      public static final MemoryLayout.PathElement PATH$color

    • PATH$tex_coord

      public static final MemoryLayout.PathElement PATH$tex_coord

    • LAYOUT$position

      public static final StructLayout LAYOUT$position

    • LAYOUT$color

      public static final StructLayout LAYOUT$color

    • LAYOUT$tex_coord

      public static final StructLayout LAYOUT$tex_coord

    • SIZE$position

      public static final long SIZE$position

    • SIZE$color

      public static final long SIZE$color

    • SIZE$tex_coord

      public static final long SIZE$tex_coord

    • OFFSET$position

      public static final long OFFSET$position

    • OFFSET$color

      public static final long OFFSET$color

    • OFFSET$tex_coord

      public static final long OFFSET$tex_coord

  • Constructor Details

    • SDL_Vertex

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

  • Method Details

    • allocate

      public static SDL_Vertex allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_Vertex clone(Arena arena, SDL_Vertex src)

    • position

      @NotNull public @NotNull SDL_FPoint position()

    • position

      public SDL_Vertex position(@NotNull @NotNull SDL_FPoint value)

    • position

      public SDL_Vertex position(Consumer<@NotNull SDL_FPoint> consumer)

    • color

      @NotNull public @NotNull SDL_FColor color()

    • color

      public SDL_Vertex color(@NotNull @NotNull SDL_FColor value)

    • color

      public SDL_Vertex color(Consumer<@NotNull SDL_FColor> consumer)

    • tex_coord

      @NotNull public @NotNull SDL_FPoint tex_coord()

    • tex_coord

      public SDL_Vertex tex_coord(@NotNull @NotNull SDL_FPoint value)

    • tex_coord

      public SDL_Vertex tex_coord(Consumer<@NotNull SDL_FPoint> 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