Record Class STBTT_Bitmap

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

Represents a pointer to a stbtt__bitmap structure in native memory.

Structure

typedef struct stbtt__bitmap {
    int w;
    int h;
    int stride;
    char* pixels;
} stbtt__bitmap;

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

      public static final MemoryLayout.PathElement PATH$w

    • PATH$h

      public static final MemoryLayout.PathElement PATH$h

    • PATH$stride

      public static final MemoryLayout.PathElement PATH$stride

    • PATH$pixels

      public static final MemoryLayout.PathElement PATH$pixels

    • LAYOUT$w

      public static final ValueLayout.OfInt LAYOUT$w

    • LAYOUT$h

      public static final ValueLayout.OfInt LAYOUT$h

    • LAYOUT$stride

      public static final ValueLayout.OfInt LAYOUT$stride

    • LAYOUT$pixels

      public static final AddressLayout LAYOUT$pixels

    • SIZE$w

      public static final long SIZE$w

    • SIZE$h

      public static final long SIZE$h

    • SIZE$stride

      public static final long SIZE$stride

    • SIZE$pixels

      public static final long SIZE$pixels

    • OFFSET$w

      public static final long OFFSET$w

    • OFFSET$h

      public static final long OFFSET$h

    • OFFSET$stride

      public static final long OFFSET$stride

    • OFFSET$pixels

      public static final long OFFSET$pixels

  • Constructor Details

    • STBTT_Bitmap

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

  • Method Details

    • allocate

      public static STBTT_Bitmap allocate(Arena arena)

    • allocate

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

    • clone

      public static STBTT_Bitmap clone(Arena arena, STBTT_Bitmap src)

    • w

      public int w()

    • w

      public STBTT_Bitmap w(int value)

    • h

      public int h()

    • h

      public STBTT_Bitmap h(int value)

    • stride

      public int stride()

    • stride

      public STBTT_Bitmap stride(int value)

    • pixels

      @Nullable public @Nullable BytePtr pixels()
      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.

    • pixels

      public STBTT_Bitmap pixels(@Nullable @Nullable BytePtr value)

    • pixelsRaw

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

    • pixelsRaw

      public void pixelsRaw(@Pointer(comment="int8_t*") @NotNull @NotNull MemorySegment 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