Record Class STBI_IoCallbacks

java.lang.Object

java.lang.Record

club.doki7.stb.image.datatype.STBI_IoCallbacks

All Implemented Interfaces:

IPointer, ISTBI_IoCallbacks

@ValueBasedCandidate
@UnsafeConstructor
public record STBI_IoCallbacks(@NotNull MemorySegment segment)
extends Record
implements ISTBI_IoCallbacks

Represents a pointer to a stbi_io_callbacks structure in native memory.

Structure

typedef struct stbi_io_callbacks {
    PFN_stbi_io_callbacks_read read;
    PFN_stbi_io_callbacks_skip skip;
    PFN_stbi_io_callbacks_eof eof;
} stbi_io_callbacks;

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	STBI_IoCallbacks.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 AddressLayout	LAYOUT$eof
static final AddressLayout	LAYOUT$read
static final AddressLayout	LAYOUT$skip
static final long	OFFSET$eof
static final long	OFFSET$read
static final long	OFFSET$skip
static final MemoryLayout.PathElement	PATH$eof
static final MemoryLayout.PathElement	PATH$read
static final MemoryLayout.PathElement	PATH$skip
static final long	SIZE$eof
static final long	SIZE$read
static final long	SIZE$skip

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static STBI_IoCallbacks	allocate(Arena arena)
static STBI_IoCallbacks.Ptr	allocate(Arena arena, long count)
static STBI_IoCallbacks	clone(Arena arena, STBI_IoCallbacks src)
@NotNull MemorySegment	eof()
STBI_IoCallbacks	eof(@Nullable IPointer pointer)
STBI_IoCallbacks	eof(@NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_eof value)
STBI_IoCallbacks	eof(@NotNull Arena arena, @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_eof value)
STBI_IoCallbacks	eof(@NotNull MemorySegment value)
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.
@NotNull MemorySegment	read()
STBI_IoCallbacks	read(@Nullable IPointer pointer)
STBI_IoCallbacks	read(@NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_read value)
STBI_IoCallbacks	read(@NotNull Arena arena, @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_read value)
STBI_IoCallbacks	read(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull MemorySegment	skip()
STBI_IoCallbacks	skip(@Nullable IPointer pointer)
STBI_IoCallbacks	skip(@NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_skip value)
STBI_IoCallbacks	skip(@NotNull Arena arena, @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_skip value)
STBI_IoCallbacks	skip(@NotNull MemorySegment value)
final String	toString()	Returns a string representation of this record class.

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

public static final MemoryLayout.PathElement PATH$read

PATH$skip

public static final MemoryLayout.PathElement PATH$skip

PATH$eof

public static final MemoryLayout.PathElement PATH$eof

LAYOUT$read

public static final AddressLayout LAYOUT$read

LAYOUT$skip

public static final AddressLayout LAYOUT$skip

LAYOUT$eof

public static final AddressLayout LAYOUT$eof

SIZE$read

public static final long SIZE$read

SIZE$skip

public static final long SIZE$skip

SIZE$eof

public static final long SIZE$eof

OFFSET$read

public static final long OFFSET$read

OFFSET$skip

public static final long OFFSET$skip

OFFSET$eof

public static final long OFFSET$eof

Constructor Details

STBI_IoCallbacks

public STBI_IoCallbacks(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a STBI_IoCallbacks record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static STBI_IoCallbacks allocate(Arena arena)

allocate

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

clone

public static STBI_IoCallbacks clone(Arena arena,
 STBI_IoCallbacks src)

read

@Pointer(comment="PFN_stbi_io_callbacks_read")
@NotNull
public @NotNull MemorySegment read()

read

public STBI_IoCallbacks read(@Pointer(comment="PFN_stbi_io_callbacks_read") @NotNull
 @NotNull MemorySegment value)

read

public STBI_IoCallbacks read(@NotNull
 @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_read value)

read

public STBI_IoCallbacks read(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_read value)

read

public STBI_IoCallbacks read(@Nullable
 @Nullable IPointer pointer)

skip

@Pointer(comment="PFN_stbi_io_callbacks_skip")
@NotNull
public @NotNull MemorySegment skip()

skip

public STBI_IoCallbacks skip(@Pointer(comment="PFN_stbi_io_callbacks_skip") @NotNull
 @NotNull MemorySegment value)

skip

public STBI_IoCallbacks skip(@NotNull
 @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_skip value)

skip

public STBI_IoCallbacks skip(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_skip value)

skip

public STBI_IoCallbacks skip(@Nullable
 @Nullable IPointer pointer)

eof

@Pointer(comment="PFN_stbi_io_callbacks_eof")
@NotNull
public @NotNull MemorySegment eof()

eof

public STBI_IoCallbacks eof(@Pointer(comment="PFN_stbi_io_callbacks_eof") @NotNull
 @NotNull MemorySegment value)

eof

public STBI_IoCallbacks eof(@NotNull
 @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_eof value)

eof

public STBI_IoCallbacks eof(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull STBIFunctionTypes.IPFN_stbi_io_callbacks_eof value)

eof

public STBI_IoCallbacks eof(@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