Record Class STBTT_Fontinfo

java.lang.Object

java.lang.Record

club.doki7.stb.truetype.datatype.STBTT_Fontinfo

All Implemented Interfaces:

IPointer, ISTBTT_Fontinfo

@ValueBasedCandidate
@UnsafeConstructor
public record STBTT_Fontinfo(@NotNull MemorySegment segment)
extends Record
implements ISTBTT_Fontinfo

Represents a pointer to a stbtt_fontinfo structure in native memory.

Structure

typedef struct stbtt_fontinfo {
    void* userdata;
    char* data;
    int fontstart;
    int numglyphs;
    int loca;
    int head;
    int glyf;
    int hhea;
    int hmtx;
    int kern;
    int gpos;
    int svg;
    int indexMap;
    int indextolocformat;
    stbtt__buf cff;
    stbtt__buf charstrings;
    stbtt__buf gsubrs;
    stbtt__buf subrs;
    stbtt__buf fontdicts;
    stbtt__buf fdselect;
} stbtt_fontinfo;

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	STBTT_Fontinfo.Ptr	Represents a pointer to / an array of null structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final StructLayout	LAYOUT$cff
static final StructLayout	LAYOUT$charstrings
static final AddressLayout	LAYOUT$data
static final StructLayout	LAYOUT$fdselect
static final StructLayout	LAYOUT$fontdicts
static final ValueLayout.OfInt	LAYOUT$fontstart
static final ValueLayout.OfInt	LAYOUT$glyf
static final ValueLayout.OfInt	LAYOUT$gpos
static final StructLayout	LAYOUT$gsubrs
static final ValueLayout.OfInt	LAYOUT$head
static final ValueLayout.OfInt	LAYOUT$hhea
static final ValueLayout.OfInt	LAYOUT$hmtx
static final ValueLayout.OfInt	LAYOUT$indexMap
static final ValueLayout.OfInt	LAYOUT$indextolocformat
static final ValueLayout.OfInt	LAYOUT$kern
static final ValueLayout.OfInt	LAYOUT$loca
static final ValueLayout.OfInt	LAYOUT$numglyphs
static final StructLayout	LAYOUT$subrs
static final ValueLayout.OfInt	LAYOUT$svg
static final AddressLayout	LAYOUT$userdata
static final long	OFFSET$cff
static final long	OFFSET$charstrings
static final long	OFFSET$data
static final long	OFFSET$fdselect
static final long	OFFSET$fontdicts
static final long	OFFSET$fontstart
static final long	OFFSET$glyf
static final long	OFFSET$gpos
static final long	OFFSET$gsubrs
static final long	OFFSET$head
static final long	OFFSET$hhea
static final long	OFFSET$hmtx
static final long	OFFSET$indexMap
static final long	OFFSET$indextolocformat
static final long	OFFSET$kern
static final long	OFFSET$loca
static final long	OFFSET$numglyphs
static final long	OFFSET$subrs
static final long	OFFSET$svg
static final long	OFFSET$userdata
static final MemoryLayout.PathElement	PATH$cff
static final MemoryLayout.PathElement	PATH$charstrings
static final MemoryLayout.PathElement	PATH$data
static final MemoryLayout.PathElement	PATH$fdselect
static final MemoryLayout.PathElement	PATH$fontdicts
static final MemoryLayout.PathElement	PATH$fontstart
static final MemoryLayout.PathElement	PATH$glyf
static final MemoryLayout.PathElement	PATH$gpos
static final MemoryLayout.PathElement	PATH$gsubrs
static final MemoryLayout.PathElement	PATH$head
static final MemoryLayout.PathElement	PATH$hhea
static final MemoryLayout.PathElement	PATH$hmtx
static final MemoryLayout.PathElement	PATH$indexMap
static final MemoryLayout.PathElement	PATH$indextolocformat
static final MemoryLayout.PathElement	PATH$kern
static final MemoryLayout.PathElement	PATH$loca
static final MemoryLayout.PathElement	PATH$numglyphs
static final MemoryLayout.PathElement	PATH$subrs
static final MemoryLayout.PathElement	PATH$svg
static final MemoryLayout.PathElement	PATH$userdata
static final long	SIZE$cff
static final long	SIZE$charstrings
static final long	SIZE$data
static final long	SIZE$fdselect
static final long	SIZE$fontdicts
static final long	SIZE$fontstart
static final long	SIZE$glyf
static final long	SIZE$gpos
static final long	SIZE$gsubrs
static final long	SIZE$head
static final long	SIZE$hhea
static final long	SIZE$hmtx
static final long	SIZE$indexMap
static final long	SIZE$indextolocformat
static final long	SIZE$kern
static final long	SIZE$loca
static final long	SIZE$numglyphs
static final long	SIZE$subrs
static final long	SIZE$svg
static final long	SIZE$userdata

Constructor Summary

Constructors

Constructor	Description
STBTT_Fontinfo(@NotNull MemorySegment segment)	Creates an instance of a STBTT_Fontinfo record class.

Method Summary

Modifier and Type	Method	Description
static STBTT_Fontinfo	allocate(Arena arena)
static STBTT_Fontinfo.Ptr	allocate(Arena arena, long count)
@NotNull STBTT_Buf	cff()
STBTT_Fontinfo	cff(@NotNull STBTT_Buf value)
STBTT_Fontinfo	cff(Consumer<@NotNull STBTT_Buf> consumer)
@NotNull STBTT_Buf	charstrings()
STBTT_Fontinfo	charstrings(@NotNull STBTT_Buf value)
STBTT_Fontinfo	charstrings(Consumer<@NotNull STBTT_Buf> consumer)
static STBTT_Fontinfo	clone(Arena arena, STBTT_Fontinfo src)
@Nullable BytePtr	data()	Note: the returned BytePtr does not have correct BytePtr.size() property.
STBTT_Fontinfo	data(@Nullable BytePtr value)
@NotNull MemorySegment	dataRaw()
void	dataRaw(@NotNull MemorySegment value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull STBTT_Buf	fdselect()
STBTT_Fontinfo	fdselect(@NotNull STBTT_Buf value)
STBTT_Fontinfo	fdselect(Consumer<@NotNull STBTT_Buf> consumer)
@NotNull STBTT_Buf	fontdicts()
STBTT_Fontinfo	fontdicts(@NotNull STBTT_Buf value)
STBTT_Fontinfo	fontdicts(Consumer<@NotNull STBTT_Buf> consumer)
int	fontstart()
STBTT_Fontinfo	fontstart(int value)
int	glyf()
STBTT_Fontinfo	glyf(int value)
int	gpos()
STBTT_Fontinfo	gpos(int value)
@NotNull STBTT_Buf	gsubrs()
STBTT_Fontinfo	gsubrs(@NotNull STBTT_Buf value)
STBTT_Fontinfo	gsubrs(Consumer<@NotNull STBTT_Buf> consumer)
final int	hashCode()	Returns a hash code value for this object.
int	head()
STBTT_Fontinfo	head(int value)
int	hhea()
STBTT_Fontinfo	hhea(int value)
int	hmtx()
STBTT_Fontinfo	hmtx(int value)
int	indexMap()
STBTT_Fontinfo	indexMap(int value)
int	indextolocformat()
STBTT_Fontinfo	indextolocformat(int value)
int	kern()
STBTT_Fontinfo	kern(int value)
int	loca()
STBTT_Fontinfo	loca(int value)
int	numglyphs()
STBTT_Fontinfo	numglyphs(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull STBTT_Buf	subrs()
STBTT_Fontinfo	subrs(@NotNull STBTT_Buf value)
STBTT_Fontinfo	subrs(Consumer<@NotNull STBTT_Buf> consumer)
int	svg()
STBTT_Fontinfo	svg(int value)
final String	toString()	Returns a string representation of this record class.
@NotNull MemorySegment	userdata()
STBTT_Fontinfo	userdata(@Nullable IPointer pointer)
STBTT_Fontinfo	userdata(@NotNull MemorySegment value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$userdata

public static final MemoryLayout.PathElement PATH$userdata

PATH$data

public static final MemoryLayout.PathElement PATH$data

PATH$fontstart

public static final MemoryLayout.PathElement PATH$fontstart

PATH$numglyphs

public static final MemoryLayout.PathElement PATH$numglyphs

PATH$loca

public static final MemoryLayout.PathElement PATH$loca

PATH$head

public static final MemoryLayout.PathElement PATH$head

PATH$glyf

public static final MemoryLayout.PathElement PATH$glyf

PATH$hhea

public static final MemoryLayout.PathElement PATH$hhea

PATH$hmtx

public static final MemoryLayout.PathElement PATH$hmtx

PATH$kern

public static final MemoryLayout.PathElement PATH$kern

PATH$gpos

public static final MemoryLayout.PathElement PATH$gpos

PATH$svg

public static final MemoryLayout.PathElement PATH$svg

PATH$indexMap

public static final MemoryLayout.PathElement PATH$indexMap

PATH$indextolocformat

public static final MemoryLayout.PathElement PATH$indextolocformat

PATH$cff

public static final MemoryLayout.PathElement PATH$cff

PATH$charstrings

public static final MemoryLayout.PathElement PATH$charstrings

PATH$gsubrs

public static final MemoryLayout.PathElement PATH$gsubrs

PATH$subrs

public static final MemoryLayout.PathElement PATH$subrs

PATH$fontdicts

public static final MemoryLayout.PathElement PATH$fontdicts

PATH$fdselect

public static final MemoryLayout.PathElement PATH$fdselect

LAYOUT$userdata

public static final AddressLayout LAYOUT$userdata

LAYOUT$data

public static final AddressLayout LAYOUT$data

LAYOUT$fontstart

public static final ValueLayout.OfInt LAYOUT$fontstart

LAYOUT$numglyphs

public static final ValueLayout.OfInt LAYOUT$numglyphs

LAYOUT$loca

public static final ValueLayout.OfInt LAYOUT$loca

LAYOUT$head

public static final ValueLayout.OfInt LAYOUT$head

LAYOUT$glyf

public static final ValueLayout.OfInt LAYOUT$glyf

LAYOUT$hhea

public static final ValueLayout.OfInt LAYOUT$hhea

LAYOUT$hmtx

public static final ValueLayout.OfInt LAYOUT$hmtx

LAYOUT$kern

public static final ValueLayout.OfInt LAYOUT$kern

LAYOUT$gpos

public static final ValueLayout.OfInt LAYOUT$gpos

LAYOUT$svg

public static final ValueLayout.OfInt LAYOUT$svg

LAYOUT$indexMap

public static final ValueLayout.OfInt LAYOUT$indexMap

LAYOUT$indextolocformat

public static final ValueLayout.OfInt LAYOUT$indextolocformat

LAYOUT$cff

public static final StructLayout LAYOUT$cff

LAYOUT$charstrings

public static final StructLayout LAYOUT$charstrings

LAYOUT$gsubrs

public static final StructLayout LAYOUT$gsubrs

LAYOUT$subrs

public static final StructLayout LAYOUT$subrs

LAYOUT$fontdicts

public static final StructLayout LAYOUT$fontdicts

LAYOUT$fdselect

public static final StructLayout LAYOUT$fdselect

SIZE$userdata

public static final long SIZE$userdata

SIZE$data

public static final long SIZE$data

SIZE$fontstart

public static final long SIZE$fontstart

SIZE$numglyphs

public static final long SIZE$numglyphs

SIZE$loca

public static final long SIZE$loca

SIZE$head

public static final long SIZE$head

SIZE$glyf

public static final long SIZE$glyf

SIZE$hhea

public static final long SIZE$hhea

SIZE$hmtx

public static final long SIZE$hmtx

SIZE$kern

public static final long SIZE$kern

SIZE$gpos

public static final long SIZE$gpos

SIZE$svg

public static final long SIZE$svg

SIZE$indexMap

public static final long SIZE$indexMap

SIZE$indextolocformat

public static final long SIZE$indextolocformat

SIZE$cff

public static final long SIZE$cff

SIZE$charstrings

public static final long SIZE$charstrings

SIZE$gsubrs

public static final long SIZE$gsubrs

SIZE$subrs

public static final long SIZE$subrs

SIZE$fontdicts

public static final long SIZE$fontdicts

SIZE$fdselect

public static final long SIZE$fdselect

OFFSET$userdata

public static final long OFFSET$userdata

OFFSET$data

public static final long OFFSET$data

OFFSET$fontstart

public static final long OFFSET$fontstart

OFFSET$numglyphs

public static final long OFFSET$numglyphs

OFFSET$loca

public static final long OFFSET$loca

OFFSET$head

public static final long OFFSET$head

OFFSET$glyf

public static final long OFFSET$glyf

OFFSET$hhea

public static final long OFFSET$hhea

OFFSET$hmtx

public static final long OFFSET$hmtx

OFFSET$kern

public static final long OFFSET$kern

OFFSET$gpos

public static final long OFFSET$gpos

OFFSET$svg

public static final long OFFSET$svg

OFFSET$indexMap

public static final long OFFSET$indexMap

OFFSET$indextolocformat

public static final long OFFSET$indextolocformat

OFFSET$cff

public static final long OFFSET$cff

OFFSET$charstrings

public static final long OFFSET$charstrings

OFFSET$gsubrs

public static final long OFFSET$gsubrs

OFFSET$subrs

public static final long OFFSET$subrs

OFFSET$fontdicts

public static final long OFFSET$fontdicts

OFFSET$fdselect

public static final long OFFSET$fdselect

Constructor Details

STBTT_Fontinfo

public STBTT_Fontinfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a STBTT_Fontinfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static STBTT_Fontinfo allocate(Arena arena)

allocate

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

clone

public static STBTT_Fontinfo clone(Arena arena,
 STBTT_Fontinfo src)

userdata

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment userdata()

userdata

public STBTT_Fontinfo userdata(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

userdata

public STBTT_Fontinfo userdata(@Nullable
 @Nullable IPointer pointer)

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_Fontinfo 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)

fontstart

public int fontstart()

fontstart

public STBTT_Fontinfo fontstart(int value)

numglyphs

public int numglyphs()

numglyphs

public STBTT_Fontinfo numglyphs(int value)

loca

public int loca()

loca

public STBTT_Fontinfo loca(int value)

head

public int head()

head

public STBTT_Fontinfo head(int value)

glyf

public int glyf()

glyf

public STBTT_Fontinfo glyf(int value)

hhea

public int hhea()

hhea

public STBTT_Fontinfo hhea(int value)

hmtx

public int hmtx()

hmtx

public STBTT_Fontinfo hmtx(int value)

kern

public int kern()

kern

public STBTT_Fontinfo kern(int value)

gpos

public int gpos()

gpos

public STBTT_Fontinfo gpos(int value)

svg

public int svg()

svg

public STBTT_Fontinfo svg(int value)

indexMap

public int indexMap()

indexMap

public STBTT_Fontinfo indexMap(int value)

indextolocformat

public int indextolocformat()

indextolocformat

public STBTT_Fontinfo indextolocformat(int value)

cff

@NotNull
public @NotNull STBTT_Buf cff()

cff

public STBTT_Fontinfo cff(@NotNull
 @NotNull STBTT_Buf value)

cff

public STBTT_Fontinfo cff(Consumer<@NotNull STBTT_Buf> consumer)

charstrings

@NotNull
public @NotNull STBTT_Buf charstrings()

charstrings

public STBTT_Fontinfo charstrings(@NotNull
 @NotNull STBTT_Buf value)

charstrings

public STBTT_Fontinfo charstrings(Consumer<@NotNull STBTT_Buf> consumer)

gsubrs

@NotNull
public @NotNull STBTT_Buf gsubrs()

gsubrs

public STBTT_Fontinfo gsubrs(@NotNull
 @NotNull STBTT_Buf value)

gsubrs

public STBTT_Fontinfo gsubrs(Consumer<@NotNull STBTT_Buf> consumer)

subrs

@NotNull
public @NotNull STBTT_Buf subrs()

subrs

public STBTT_Fontinfo subrs(@NotNull
 @NotNull STBTT_Buf value)

subrs

public STBTT_Fontinfo subrs(Consumer<@NotNull STBTT_Buf> consumer)

fontdicts

@NotNull
public @NotNull STBTT_Buf fontdicts()

fontdicts

public STBTT_Fontinfo fontdicts(@NotNull
 @NotNull STBTT_Buf value)

fontdicts

public STBTT_Fontinfo fontdicts(Consumer<@NotNull STBTT_Buf> consumer)

fdselect

@NotNull
public @NotNull STBTT_Buf fdselect()

fdselect

public STBTT_Fontinfo fdselect(@NotNull
 @NotNull STBTT_Buf value)

fdselect

public STBTT_Fontinfo fdselect(Consumer<@NotNull STBTT_Buf> 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