Record Class STBTT_PackContext

java.lang.Object

java.lang.Record

club.doki7.stb.truetype.datatype.STBTT_PackContext

All Implemented Interfaces:

IPointer, ISTBTT_PackContext

@ValueBasedCandidate
@UnsafeConstructor
public record STBTT_PackContext(@NotNull MemorySegment segment)
extends Record
implements ISTBTT_PackContext

Represents a pointer to a stbtt_pack_context structure in native memory.

Structure

typedef struct stbtt_pack_context {
    void* userAllocatorContext;
    void* packInfo;
    int width;
    int height;
    int strideInBytes;
    int padding;
    int skipMissing;
    int hOversample;
    int vOversample;
    char* pixels;
    void* nodes;
} stbtt_pack_context;

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_PackContext.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 ValueLayout.OfInt	LAYOUT$height
static final ValueLayout.OfInt	LAYOUT$hOversample
static final AddressLayout	LAYOUT$nodes
static final AddressLayout	LAYOUT$packInfo
static final ValueLayout.OfInt	LAYOUT$padding
static final AddressLayout	LAYOUT$pixels
static final ValueLayout.OfInt	LAYOUT$skipMissing
static final ValueLayout.OfInt	LAYOUT$strideInBytes
static final AddressLayout	LAYOUT$userAllocatorContext
static final ValueLayout.OfInt	LAYOUT$vOversample
static final ValueLayout.OfInt	LAYOUT$width
static final long	OFFSET$height
static final long	OFFSET$hOversample
static final long	OFFSET$nodes
static final long	OFFSET$packInfo
static final long	OFFSET$padding
static final long	OFFSET$pixels
static final long	OFFSET$skipMissing
static final long	OFFSET$strideInBytes
static final long	OFFSET$userAllocatorContext
static final long	OFFSET$vOversample
static final long	OFFSET$width
static final MemoryLayout.PathElement	PATH$height
static final MemoryLayout.PathElement	PATH$hOversample
static final MemoryLayout.PathElement	PATH$nodes
static final MemoryLayout.PathElement	PATH$packInfo
static final MemoryLayout.PathElement	PATH$padding
static final MemoryLayout.PathElement	PATH$pixels
static final MemoryLayout.PathElement	PATH$skipMissing
static final MemoryLayout.PathElement	PATH$strideInBytes
static final MemoryLayout.PathElement	PATH$userAllocatorContext
static final MemoryLayout.PathElement	PATH$vOversample
static final MemoryLayout.PathElement	PATH$width
static final long	SIZE$height
static final long	SIZE$hOversample
static final long	SIZE$nodes
static final long	SIZE$packInfo
static final long	SIZE$padding
static final long	SIZE$pixels
static final long	SIZE$skipMissing
static final long	SIZE$strideInBytes
static final long	SIZE$userAllocatorContext
static final long	SIZE$vOversample
static final long	SIZE$width

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static STBTT_PackContext	allocate(Arena arena)
static STBTT_PackContext.Ptr	allocate(Arena arena, long count)
static STBTT_PackContext	clone(Arena arena, STBTT_PackContext src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	height()
STBTT_PackContext	height(int value)
int	hOversample()
STBTT_PackContext	hOversample(int value)
@NotNull MemorySegment	nodes()
STBTT_PackContext	nodes(@Nullable IPointer pointer)
STBTT_PackContext	nodes(@NotNull MemorySegment value)
@NotNull MemorySegment	packInfo()
STBTT_PackContext	packInfo(@Nullable IPointer pointer)
STBTT_PackContext	packInfo(@NotNull MemorySegment value)
int	padding()
STBTT_PackContext	padding(int value)
@Nullable BytePtr	pixels()	Note: the returned BytePtr does not have correct BytePtr.size() property.
STBTT_PackContext	pixels(@Nullable BytePtr value)
@NotNull MemorySegment	pixelsRaw()
void	pixelsRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	skipMissing()
STBTT_PackContext	skipMissing(int value)
int	strideInBytes()
STBTT_PackContext	strideInBytes(int value)
final String	toString()	Returns a string representation of this record class.
@NotNull MemorySegment	userAllocatorContext()
STBTT_PackContext	userAllocatorContext(@Nullable IPointer pointer)
STBTT_PackContext	userAllocatorContext(@NotNull MemorySegment value)
int	vOversample()
STBTT_PackContext	vOversample(int value)
int	width()
STBTT_PackContext	width(int 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$userAllocatorContext

public static final MemoryLayout.PathElement PATH$userAllocatorContext

PATH$packInfo

public static final MemoryLayout.PathElement PATH$packInfo

PATH$width

public static final MemoryLayout.PathElement PATH$width

PATH$height

public static final MemoryLayout.PathElement PATH$height

PATH$strideInBytes

public static final MemoryLayout.PathElement PATH$strideInBytes

PATH$padding

public static final MemoryLayout.PathElement PATH$padding

PATH$skipMissing

public static final MemoryLayout.PathElement PATH$skipMissing

PATH$hOversample

public static final MemoryLayout.PathElement PATH$hOversample

PATH$vOversample

public static final MemoryLayout.PathElement PATH$vOversample

PATH$pixels

public static final MemoryLayout.PathElement PATH$pixels

PATH$nodes

public static final MemoryLayout.PathElement PATH$nodes

LAYOUT$userAllocatorContext

public static final AddressLayout LAYOUT$userAllocatorContext

LAYOUT$packInfo

public static final AddressLayout LAYOUT$packInfo

LAYOUT$width

public static final ValueLayout.OfInt LAYOUT$width

LAYOUT$height

public static final ValueLayout.OfInt LAYOUT$height

LAYOUT$strideInBytes

public static final ValueLayout.OfInt LAYOUT$strideInBytes

LAYOUT$padding

public static final ValueLayout.OfInt LAYOUT$padding

LAYOUT$skipMissing

public static final ValueLayout.OfInt LAYOUT$skipMissing

LAYOUT$hOversample

public static final ValueLayout.OfInt LAYOUT$hOversample

LAYOUT$vOversample

public static final ValueLayout.OfInt LAYOUT$vOversample

LAYOUT$pixels

public static final AddressLayout LAYOUT$pixels

LAYOUT$nodes

public static final AddressLayout LAYOUT$nodes

SIZE$userAllocatorContext

public static final long SIZE$userAllocatorContext

SIZE$packInfo

public static final long SIZE$packInfo

SIZE$width

public static final long SIZE$width

SIZE$height

public static final long SIZE$height

SIZE$strideInBytes

public static final long SIZE$strideInBytes

SIZE$padding

public static final long SIZE$padding

SIZE$skipMissing

public static final long SIZE$skipMissing

SIZE$hOversample

public static final long SIZE$hOversample

SIZE$vOversample

public static final long SIZE$vOversample

SIZE$pixels

public static final long SIZE$pixels

SIZE$nodes

public static final long SIZE$nodes

OFFSET$userAllocatorContext

public static final long OFFSET$userAllocatorContext

OFFSET$packInfo

public static final long OFFSET$packInfo

OFFSET$width

public static final long OFFSET$width

OFFSET$height

public static final long OFFSET$height

OFFSET$strideInBytes

public static final long OFFSET$strideInBytes

OFFSET$padding

public static final long OFFSET$padding

OFFSET$skipMissing

public static final long OFFSET$skipMissing

OFFSET$hOversample

public static final long OFFSET$hOversample

OFFSET$vOversample

public static final long OFFSET$vOversample

OFFSET$pixels

public static final long OFFSET$pixels

OFFSET$nodes

public static final long OFFSET$nodes

Constructor Details

STBTT_PackContext

public STBTT_PackContext(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a STBTT_PackContext record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static STBTT_PackContext allocate(Arena arena)

allocate

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

clone

public static STBTT_PackContext clone(Arena arena,
 STBTT_PackContext src)

userAllocatorContext

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

userAllocatorContext

public STBTT_PackContext userAllocatorContext(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

userAllocatorContext

public STBTT_PackContext userAllocatorContext(@Nullable
 @Nullable IPointer pointer)

packInfo

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

packInfo

public STBTT_PackContext packInfo(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

packInfo

public STBTT_PackContext packInfo(@Nullable
 @Nullable IPointer pointer)

width

public int width()

width

public STBTT_PackContext width(int value)

height

public int height()

height

public STBTT_PackContext height(int value)

strideInBytes

public int strideInBytes()

strideInBytes

public STBTT_PackContext strideInBytes(int value)

padding

public int padding()

padding

public STBTT_PackContext padding(int value)

skipMissing

public int skipMissing()

skipMissing

public STBTT_PackContext skipMissing(int value)

hOversample

public int hOversample()

hOversample

public STBTT_PackContext hOversample(int value)

vOversample

public int vOversample()

vOversample

public STBTT_PackContext vOversample(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_PackContext 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)

nodes

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

nodes

public STBTT_PackContext nodes(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

nodes

public STBTT_PackContext nodes(@Nullable
 @Nullable IPointer pointer)

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