Record Class GLFWallocator

java.lang.Object

java.lang.Record

club.doki7.glfw.datatype.GLFWallocator

All Implemented Interfaces:

IPointer, IGLFWallocator

@ValueBasedCandidate
@UnsafeConstructor
public record GLFWallocator(@NotNull MemorySegment segment)
extends Record
implements IGLFWallocator

Since:

Added in version 3.4.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GLFWallocator.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$allocate
static final AddressLayout	LAYOUT$deallocate
static final AddressLayout	LAYOUT$reallocate
static final AddressLayout	LAYOUT$user
static final long	OFFSET$allocate
static final long	OFFSET$deallocate
static final long	OFFSET$reallocate
static final long	OFFSET$user
static final MemoryLayout.PathElement	PATH$allocate
static final MemoryLayout.PathElement	PATH$deallocate
static final MemoryLayout.PathElement	PATH$reallocate
static final MemoryLayout.PathElement	PATH$user
static final long	SIZE$allocate
static final long	SIZE$deallocate
static final long	SIZE$reallocate
static final long	SIZE$user

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NotNull MemorySegment	allocate()
GLFWallocator	allocate(@Nullable IPointer pointer)
GLFWallocator	allocate(@NotNull GLFWFunctionTypes.IGLFWallocatefun value)
GLFWallocator	allocate(@NotNull Arena arena, @NotNull GLFWFunctionTypes.IGLFWallocatefun value)
GLFWallocator	allocate(@NotNull MemorySegment value)
static GLFWallocator	allocate(Arena arena)
static GLFWallocator.Ptr	allocate(Arena arena, long count)
static GLFWallocator	clone(Arena arena, GLFWallocator src)
@NotNull MemorySegment	deallocate()
GLFWallocator	deallocate(@Nullable IPointer pointer)
GLFWallocator	deallocate(@NotNull GLFWFunctionTypes.IGLFWdeallocatefun value)
GLFWallocator	deallocate(@NotNull Arena arena, @NotNull GLFWFunctionTypes.IGLFWdeallocatefun value)
GLFWallocator	deallocate(@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	reallocate()
GLFWallocator	reallocate(@Nullable IPointer pointer)
GLFWallocator	reallocate(@NotNull GLFWFunctionTypes.IGLFWreallocatefun value)
GLFWallocator	reallocate(@NotNull Arena arena, @NotNull GLFWFunctionTypes.IGLFWreallocatefun value)
GLFWallocator	reallocate(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
@NotNull MemorySegment	user()
GLFWallocator	user(@Nullable IPointer pointer)
GLFWallocator	user(@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$allocate

public static final MemoryLayout.PathElement PATH$allocate

PATH$reallocate

public static final MemoryLayout.PathElement PATH$reallocate

PATH$deallocate

public static final MemoryLayout.PathElement PATH$deallocate

PATH$user

public static final MemoryLayout.PathElement PATH$user

LAYOUT$allocate

public static final AddressLayout LAYOUT$allocate

LAYOUT$reallocate

public static final AddressLayout LAYOUT$reallocate

LAYOUT$deallocate

public static final AddressLayout LAYOUT$deallocate

LAYOUT$user

public static final AddressLayout LAYOUT$user

SIZE$allocate

public static final long SIZE$allocate

SIZE$reallocate

public static final long SIZE$reallocate

SIZE$deallocate

public static final long SIZE$deallocate

SIZE$user

public static final long SIZE$user

OFFSET$allocate

public static final long OFFSET$allocate

OFFSET$reallocate

public static final long OFFSET$reallocate

OFFSET$deallocate

public static final long OFFSET$deallocate

OFFSET$user

public static final long OFFSET$user

Constructor Details

GLFWallocator

public GLFWallocator(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a GLFWallocator record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static GLFWallocator allocate(Arena arena)

allocate

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

clone

public static GLFWallocator clone(Arena arena,
 GLFWallocator src)

allocate

@Pointer(comment="GLFWallocatefun")
@NotNull
public @NotNull MemorySegment allocate()

allocate

public GLFWallocator allocate(@Pointer(comment="GLFWallocatefun") @NotNull
 @NotNull MemorySegment value)

allocate

public GLFWallocator allocate(@NotNull
 @NotNull GLFWFunctionTypes.IGLFWallocatefun value)

allocate

public GLFWallocator allocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull GLFWFunctionTypes.IGLFWallocatefun value)

allocate

public GLFWallocator allocate(@Nullable
 @Nullable IPointer pointer)

reallocate

@Pointer(comment="GLFWreallocatefun")
@NotNull
public @NotNull MemorySegment reallocate()

reallocate

public GLFWallocator reallocate(@Pointer(comment="GLFWreallocatefun") @NotNull
 @NotNull MemorySegment value)

reallocate

public GLFWallocator reallocate(@NotNull
 @NotNull GLFWFunctionTypes.IGLFWreallocatefun value)

reallocate

public GLFWallocator reallocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull GLFWFunctionTypes.IGLFWreallocatefun value)

reallocate

public GLFWallocator reallocate(@Nullable
 @Nullable IPointer pointer)

deallocate

@Pointer(comment="GLFWdeallocatefun")
@NotNull
public @NotNull MemorySegment deallocate()

deallocate

public GLFWallocator deallocate(@Pointer(comment="GLFWdeallocatefun") @NotNull
 @NotNull MemorySegment value)

deallocate

public GLFWallocator deallocate(@NotNull
 @NotNull GLFWFunctionTypes.IGLFWdeallocatefun value)

deallocate

public GLFWallocator deallocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull GLFWFunctionTypes.IGLFWdeallocatefun value)

deallocate

public GLFWallocator deallocate(@Nullable
 @Nullable IPointer pointer)

user

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

user

public GLFWallocator user(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

user

public GLFWallocator user(@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