Record Class VkAllocationCallbacks

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkAllocationCallbacks

All Implemented Interfaces:

IPointer, IVkAllocationCallbacks

@ValueBasedCandidate
@UnsafeConstructor
public record VkAllocationCallbacks(@NotNull MemorySegment segment)
extends Record
implements IVkAllocationCallbacks

Represents a pointer to a VkAllocationCallbacks structure in native memory.

Structure

typedef struct VkAllocationCallbacks {
    void* pUserData; // optional
    PFN_vkAllocationFunction pfnAllocation;
    PFN_vkReallocationFunction pfnReallocation;
    PFN_vkFreeFunction pfnFree;
    PFN_vkInternalAllocationNotification pfnInternalAllocation; // optional
    PFN_vkInternalFreeNotification pfnInternalFree; // optional
} VkAllocationCallbacks;

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.

See Also:

• VkAllocationCallbacks

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkAllocationCallbacks.Ptr	Represents a pointer to / an array of VkAllocationCallbacks 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$pfnAllocation
static final AddressLayout	LAYOUT$pfnFree
static final AddressLayout	LAYOUT$pfnInternalAllocation
static final AddressLayout	LAYOUT$pfnInternalFree
static final AddressLayout	LAYOUT$pfnReallocation
static final AddressLayout	LAYOUT$pUserData
static final long	OFFSET$pfnAllocation
static final long	OFFSET$pfnFree
static final long	OFFSET$pfnInternalAllocation
static final long	OFFSET$pfnInternalFree
static final long	OFFSET$pfnReallocation
static final long	OFFSET$pUserData
static final MemoryLayout.PathElement	PATH$pfnAllocation
static final MemoryLayout.PathElement	PATH$pfnFree
static final MemoryLayout.PathElement	PATH$pfnInternalAllocation
static final MemoryLayout.PathElement	PATH$pfnInternalFree
static final MemoryLayout.PathElement	PATH$pfnReallocation
static final MemoryLayout.PathElement	PATH$pUserData
static final long	SIZE$pfnAllocation
static final long	SIZE$pfnFree
static final long	SIZE$pfnInternalAllocation
static final long	SIZE$pfnInternalFree
static final long	SIZE$pfnReallocation
static final long	SIZE$pUserData

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkAllocationCallbacks	allocate(Arena arena)
static VkAllocationCallbacks.Ptr	allocate(Arena arena, long count)
static VkAllocationCallbacks	clone(Arena arena, VkAllocationCallbacks 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.
MemorySegment	pfnAllocation()
VkAllocationCallbacks	pfnAllocation(@Nullable IPointer pointer)
void	pfnAllocation(MemorySegment value)
MemorySegment	pfnFree()
VkAllocationCallbacks	pfnFree(@Nullable IPointer pointer)
void	pfnFree(MemorySegment value)
MemorySegment	pfnInternalAllocation()
VkAllocationCallbacks	pfnInternalAllocation(@Nullable IPointer pointer)
void	pfnInternalAllocation(MemorySegment value)
MemorySegment	pfnInternalFree()
VkAllocationCallbacks	pfnInternalFree(@Nullable IPointer pointer)
void	pfnInternalFree(MemorySegment value)
MemorySegment	pfnReallocation()
VkAllocationCallbacks	pfnReallocation(@Nullable IPointer pointer)
void	pfnReallocation(MemorySegment value)
MemorySegment	pUserData()
VkAllocationCallbacks	pUserData(@Nullable IPointer pointer)
void	pUserData(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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$pUserData

public static final MemoryLayout.PathElement PATH$pUserData

PATH$pfnAllocation

public static final MemoryLayout.PathElement PATH$pfnAllocation

PATH$pfnReallocation

public static final MemoryLayout.PathElement PATH$pfnReallocation

PATH$pfnFree

public static final MemoryLayout.PathElement PATH$pfnFree

PATH$pfnInternalAllocation

public static final MemoryLayout.PathElement PATH$pfnInternalAllocation

PATH$pfnInternalFree

public static final MemoryLayout.PathElement PATH$pfnInternalFree

LAYOUT$pUserData

public static final AddressLayout LAYOUT$pUserData

LAYOUT$pfnAllocation

public static final AddressLayout LAYOUT$pfnAllocation

LAYOUT$pfnReallocation

public static final AddressLayout LAYOUT$pfnReallocation

LAYOUT$pfnFree

public static final AddressLayout LAYOUT$pfnFree

LAYOUT$pfnInternalAllocation

public static final AddressLayout LAYOUT$pfnInternalAllocation

LAYOUT$pfnInternalFree

public static final AddressLayout LAYOUT$pfnInternalFree

SIZE$pUserData

public static final long SIZE$pUserData

SIZE$pfnAllocation

public static final long SIZE$pfnAllocation

SIZE$pfnReallocation

public static final long SIZE$pfnReallocation

SIZE$pfnFree

public static final long SIZE$pfnFree

SIZE$pfnInternalAllocation

public static final long SIZE$pfnInternalAllocation

SIZE$pfnInternalFree

public static final long SIZE$pfnInternalFree

OFFSET$pUserData

public static final long OFFSET$pUserData

OFFSET$pfnAllocation

public static final long OFFSET$pfnAllocation

OFFSET$pfnReallocation

public static final long OFFSET$pfnReallocation

OFFSET$pfnFree

public static final long OFFSET$pfnFree

OFFSET$pfnInternalAllocation

public static final long OFFSET$pfnInternalAllocation

OFFSET$pfnInternalFree

public static final long OFFSET$pfnInternalFree

Constructor Details

VkAllocationCallbacks

public VkAllocationCallbacks(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkAllocationCallbacks record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkAllocationCallbacks allocate(Arena arena)

allocate

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

clone

public static VkAllocationCallbacks clone(Arena arena,
 VkAllocationCallbacks src)

pUserData

@Pointer(comment="void*")
public MemorySegment pUserData()

pUserData

public void pUserData(@Pointer(comment="void*")
 MemorySegment value)

pUserData

public VkAllocationCallbacks pUserData(@Nullable
 @Nullable IPointer pointer)

pfnAllocation

@Pointer(comment="PFN_vkAllocationFunction")
public MemorySegment pfnAllocation()

pfnAllocation

public void pfnAllocation(@Pointer(comment="PFN_vkAllocationFunction")
 MemorySegment value)

pfnAllocation

public VkAllocationCallbacks pfnAllocation(@Nullable
 @Nullable IPointer pointer)

pfnReallocation

@Pointer(comment="PFN_vkReallocationFunction")
public MemorySegment pfnReallocation()

pfnReallocation

public void pfnReallocation(@Pointer(comment="PFN_vkReallocationFunction")
 MemorySegment value)

pfnReallocation

public VkAllocationCallbacks pfnReallocation(@Nullable
 @Nullable IPointer pointer)

pfnFree

@Pointer(comment="PFN_vkFreeFunction")
public MemorySegment pfnFree()

pfnFree

public void pfnFree(@Pointer(comment="PFN_vkFreeFunction")
 MemorySegment value)

pfnFree

public VkAllocationCallbacks pfnFree(@Nullable
 @Nullable IPointer pointer)

pfnInternalAllocation

@Pointer(comment="PFN_vkInternalAllocationNotification")
public MemorySegment pfnInternalAllocation()

pfnInternalAllocation

public void pfnInternalAllocation(@Pointer(comment="PFN_vkInternalAllocationNotification")
 MemorySegment value)

pfnInternalAllocation

public VkAllocationCallbacks pfnInternalAllocation(@Nullable
 @Nullable IPointer pointer)

pfnInternalFree

@Pointer(comment="PFN_vkInternalFreeNotification")
public MemorySegment pfnInternalFree()

pfnInternalFree

public void pfnInternalFree(@Pointer(comment="PFN_vkInternalFreeNotification")
 MemorySegment value)

pfnInternalFree

public VkAllocationCallbacks pfnInternalFree(@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