Record Class STBTT_Buf

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

Represents a pointer to a stbtt__buf structure in native memory.

Structure

typedef struct stbtt__buf {
    char* data;
    int cursor;
    int size;
} stbtt__buf;

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

      public static final MemoryLayout.PathElement PATH$data

    • PATH$cursor

      public static final MemoryLayout.PathElement PATH$cursor

    • PATH$size

      public static final MemoryLayout.PathElement PATH$size

    • LAYOUT$data

      public static final AddressLayout LAYOUT$data

    • LAYOUT$cursor

      public static final ValueLayout.OfInt LAYOUT$cursor

    • LAYOUT$size

      public static final ValueLayout.OfInt LAYOUT$size

    • SIZE$data

      public static final long SIZE$data

    • SIZE$cursor

      public static final long SIZE$cursor

    • SIZE$size

      public static final long SIZE$size

    • OFFSET$data

      public static final long OFFSET$data

    • OFFSET$cursor

      public static final long OFFSET$cursor

    • OFFSET$size

      public static final long OFFSET$size

  • Constructor Details

    • STBTT_Buf

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

  • Method Details

    • allocate

      public static STBTT_Buf allocate(Arena arena)

    • allocate

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

    • clone

      public static STBTT_Buf clone(Arena arena, STBTT_Buf src)

    • data

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

    • data

      public STBTT_Buf data(@Nullable @Nullable BytePtr value)

    • dataRaw

      @Pointer(comment="int8_t*") @NotNull public @NotNull MemorySegment dataRaw()

    • dataRaw

      public void dataRaw(@Pointer(comment="int8_t*") @NotNull @NotNull MemorySegment value)

    • cursor

      public int cursor()

    • cursor

      public STBTT_Buf cursor(int value)

    • size

      public int size()

    • size

      public STBTT_Buf size(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