Record Class STBTT_Kerningentry

java.lang.Object
java.lang.Record
club.doki7.stb.truetype.datatype.STBTT_Kerningentry
All Implemented Interfaces:
IPointer, ISTBTT_Kerningentry
@ValueBasedCandidate @UnsafeConstructor public record STBTT_Kerningentry(@NotNull MemorySegment segment) extends Record implements ISTBTT_Kerningentry

Represents a pointer to a stbtt_kerningentry structure in native memory.

Structure

typedef struct stbtt_kerningentry {
    int glyph1;
    int glyph2;
    int advance;
} stbtt_kerningentry;

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

      public static final MemoryLayout.PathElement PATH$glyph1

    • PATH$glyph2

      public static final MemoryLayout.PathElement PATH$glyph2

    • PATH$advance

      public static final MemoryLayout.PathElement PATH$advance

    • LAYOUT$glyph1

      public static final ValueLayout.OfInt LAYOUT$glyph1

    • LAYOUT$glyph2

      public static final ValueLayout.OfInt LAYOUT$glyph2

    • LAYOUT$advance

      public static final ValueLayout.OfInt LAYOUT$advance

    • SIZE$glyph1

      public static final long SIZE$glyph1

    • SIZE$glyph2

      public static final long SIZE$glyph2

    • SIZE$advance

      public static final long SIZE$advance

    • OFFSET$glyph1

      public static final long OFFSET$glyph1

    • OFFSET$glyph2

      public static final long OFFSET$glyph2

    • OFFSET$advance

      public static final long OFFSET$advance

  • Constructor Details

    • STBTT_Kerningentry

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

  • Method Details

    • allocate

      public static STBTT_Kerningentry allocate(Arena arena)

    • allocate

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

    • clone

      public static STBTT_Kerningentry clone(Arena arena, STBTT_Kerningentry src)

    • glyph1

      public int glyph1()

    • glyph1

      public STBTT_Kerningentry glyph1(int value)

    • glyph2

      public int glyph2()

    • glyph2

      public STBTT_Kerningentry glyph2(int value)

    • advance

      public int advance()

    • advance

      public STBTT_Kerningentry advance(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