Class VkAllocationCallbacks

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAllocationCallbacks>

org.lwjgl.vulkan.VkAllocationCallbacks

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkAllocationCallbacks
extends Struct<VkAllocationCallbacks>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAllocationCallbacks.Buffer	An array of VkAllocationCallbacks structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PFNALLOCATION	The struct member offsets.
static final int	PFNFREE	The struct member offsets.
static final int	PFNINTERNALALLOCATION	The struct member offsets.
static final int	PFNINTERNALFREE	The struct member offsets.
static final int	PFNREALLOCATION	The struct member offsets.
static final int	PUSERDATA	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkAllocationCallbacks(ByteBuffer container)	Creates a VkAllocationCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkAllocationCallbacks	calloc()	Returns a new VkAllocationCallbacks instance allocated with memCalloc.
static VkAllocationCallbacks.Buffer	calloc(int capacity)	Returns a new VkAllocationCallbacks.Buffer instance allocated with memCalloc.
static VkAllocationCallbacks.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkAllocationCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAllocationCallbacks	calloc(MemoryStack stack)	Returns a new VkAllocationCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAllocationCallbacks	create()	Returns a new VkAllocationCallbacks instance allocated with BufferUtils.
static VkAllocationCallbacks.Buffer	create(int capacity)	Returns a new VkAllocationCallbacks.Buffer instance allocated with BufferUtils.
static VkAllocationCallbacks	create(long address)	Returns a new VkAllocationCallbacks instance for the specified memory address.
static VkAllocationCallbacks.Buffer	create(long address, int capacity)	Create a VkAllocationCallbacks.Buffer instance at the specified memory.
static @Nullable VkAllocationCallbacks	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAllocationCallbacks.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAllocationCallbacks	malloc()	Returns a new VkAllocationCallbacks instance allocated with memAlloc.
static VkAllocationCallbacks.Buffer	malloc(int capacity)	Returns a new VkAllocationCallbacks.Buffer instance allocated with memAlloc.
static VkAllocationCallbacks.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkAllocationCallbacks.Buffer instance allocated on the specified MemoryStack.
static VkAllocationCallbacks	malloc(MemoryStack stack)	Returns a new VkAllocationCallbacks instance allocated on the specified MemoryStack.
static @Nullable VkAllocationFunction	npfnAllocation(long struct)	Unsafe version of pfnAllocation().
static void	npfnAllocation(long struct, @Nullable VkAllocationFunctionI value)	Unsafe version of pfnAllocation.
static @Nullable VkFreeFunction	npfnFree(long struct)	Unsafe version of pfnFree().
static void	npfnFree(long struct, @Nullable VkFreeFunctionI value)	Unsafe version of pfnFree.
static @Nullable VkInternalAllocationNotification	npfnInternalAllocation(long struct)	Unsafe version of pfnInternalAllocation().
static void	npfnInternalAllocation(long struct, @Nullable VkInternalAllocationNotificationI value)	Unsafe version of pfnInternalAllocation.
static @Nullable VkInternalFreeNotification	npfnInternalFree(long struct)	Unsafe version of pfnInternalFree().
static void	npfnInternalFree(long struct, @Nullable VkInternalFreeNotificationI value)	Unsafe version of pfnInternalFree.
static @Nullable VkReallocationFunction	npfnReallocation(long struct)	Unsafe version of pfnReallocation().
static void	npfnReallocation(long struct, @Nullable VkReallocationFunctionI value)	Unsafe version of pfnReallocation.
static long	npUserData(long struct)	Unsafe version of pUserData().
static void	npUserData(long struct, long value)	Unsafe version of pUserData.
@Nullable VkAllocationFunction	pfnAllocation()
VkAllocationCallbacks	pfnAllocation(@Nullable VkAllocationFunctionI value)	Sets the specified value to the pfnAllocation field.
@Nullable VkFreeFunction	pfnFree()
VkAllocationCallbacks	pfnFree(@Nullable VkFreeFunctionI value)	Sets the specified value to the pfnFree field.
@Nullable VkInternalAllocationNotification	pfnInternalAllocation()
VkAllocationCallbacks	pfnInternalAllocation(@Nullable VkInternalAllocationNotificationI value)	Sets the specified value to the pfnInternalAllocation field.
@Nullable VkInternalFreeNotification	pfnInternalFree()
VkAllocationCallbacks	pfnInternalFree(@Nullable VkInternalFreeNotificationI value)	Sets the specified value to the pfnInternalFree field.
@Nullable VkReallocationFunction	pfnReallocation()
VkAllocationCallbacks	pfnReallocation(@Nullable VkReallocationFunctionI value)	Sets the specified value to the pfnReallocation field.
long	pUserData()
VkAllocationCallbacks	pUserData(long value)	Sets the specified value to the pUserData field.
VkAllocationCallbacks	set(long pUserData, VkAllocationFunctionI pfnAllocation, VkReallocationFunctionI pfnReallocation, VkFreeFunctionI pfnFree, VkInternalAllocationNotificationI pfnInternalAllocation, VkInternalFreeNotificationI pfnInternalFree)	Initializes this struct with the specified values.
VkAllocationCallbacks	set(VkAllocationCallbacks src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

PUSERDATA

public static final int PUSERDATA

The struct member offsets.

PFNALLOCATION

public static final int PFNALLOCATION

The struct member offsets.

PFNREALLOCATION

public static final int PFNREALLOCATION

The struct member offsets.

PFNFREE

public static final int PFNFREE

The struct member offsets.

PFNINTERNALALLOCATION

public static final int PFNINTERNALALLOCATION

The struct member offsets.

PFNINTERNALFREE

public static final int PFNINTERNALFREE

The struct member offsets.

Constructor Details

VkAllocationCallbacks

public VkAllocationCallbacks(ByteBuffer container)

Creates a VkAllocationCallbacks instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkAllocationCallbacks>

pUserData

@NativeType("void *")
public long pUserData()

Returns:

the value of the pUserData field.

pfnAllocation

@NativeType("PFN_vkAllocationFunction")
public @Nullable VkAllocationFunction pfnAllocation()

Returns:

the value of the pfnAllocation field.

pfnReallocation

@NativeType("PFN_vkReallocationFunction")
public @Nullable VkReallocationFunction pfnReallocation()

Returns:

the value of the pfnReallocation field.

pfnFree

@NativeType("PFN_vkFreeFunction")
public @Nullable VkFreeFunction pfnFree()

Returns:

the value of the pfnFree field.

pfnInternalAllocation

@NativeType("PFN_vkInternalAllocationNotification")
public @Nullable VkInternalAllocationNotification pfnInternalAllocation()

Returns:

the value of the pfnInternalAllocation field.

pfnInternalFree

@NativeType("PFN_vkInternalFreeNotification")
public @Nullable VkInternalFreeNotification pfnInternalFree()

Returns:

the value of the pfnInternalFree field.

pUserData

public VkAllocationCallbacks pUserData(@NativeType("void *")
 long value)

Sets the specified value to the pUserData field.

pfnAllocation

public VkAllocationCallbacks pfnAllocation(@NativeType("PFN_vkAllocationFunction")
 @Nullable VkAllocationFunctionI value)

Sets the specified value to the pfnAllocation field.

pfnReallocation

public VkAllocationCallbacks pfnReallocation(@NativeType("PFN_vkReallocationFunction")
 @Nullable VkReallocationFunctionI value)

Sets the specified value to the pfnReallocation field.

pfnFree

public VkAllocationCallbacks pfnFree(@NativeType("PFN_vkFreeFunction")
 @Nullable VkFreeFunctionI value)

Sets the specified value to the pfnFree field.

pfnInternalAllocation

public VkAllocationCallbacks pfnInternalAllocation(@NativeType("PFN_vkInternalAllocationNotification")
 @Nullable VkInternalAllocationNotificationI value)

Sets the specified value to the pfnInternalAllocation field.

pfnInternalFree

public VkAllocationCallbacks pfnInternalFree(@NativeType("PFN_vkInternalFreeNotification")
 @Nullable VkInternalFreeNotificationI value)

Sets the specified value to the pfnInternalFree field.

set

public VkAllocationCallbacks set(long pUserData,
 VkAllocationFunctionI pfnAllocation,
 VkReallocationFunctionI pfnReallocation,
 VkFreeFunctionI pfnFree,
 VkInternalAllocationNotificationI pfnInternalAllocation,
 VkInternalFreeNotificationI pfnInternalFree)

Initializes this struct with the specified values.

set

public VkAllocationCallbacks set(VkAllocationCallbacks src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAllocationCallbacks malloc()

Returns a new VkAllocationCallbacks instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkAllocationCallbacks calloc()

Returns a new VkAllocationCallbacks instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkAllocationCallbacks create()

Returns a new VkAllocationCallbacks instance allocated with BufferUtils.

create

public static VkAllocationCallbacks create(long address)

Returns a new VkAllocationCallbacks instance for the specified memory address.

createSafe

public static @Nullable VkAllocationCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAllocationCallbacks.Buffer malloc(int capacity)

Returns a new VkAllocationCallbacks.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkAllocationCallbacks.Buffer calloc(int capacity)

Returns a new VkAllocationCallbacks.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkAllocationCallbacks.Buffer create(int capacity)

Returns a new VkAllocationCallbacks.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkAllocationCallbacks.Buffer create(long address,
 int capacity)

Create a VkAllocationCallbacks.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkAllocationCallbacks.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkAllocationCallbacks malloc(MemoryStack stack)

Returns a new VkAllocationCallbacks instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAllocationCallbacks calloc(MemoryStack stack)

Returns a new VkAllocationCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkAllocationCallbacks.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkAllocationCallbacks.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkAllocationCallbacks.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkAllocationCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

npUserData

public static long npUserData(long struct)

Unsafe version of pUserData().

npfnAllocation

public static @Nullable VkAllocationFunction npfnAllocation(long struct)

Unsafe version of pfnAllocation().

npfnReallocation

public static @Nullable VkReallocationFunction npfnReallocation(long struct)

Unsafe version of pfnReallocation().

npfnFree

public static @Nullable VkFreeFunction npfnFree(long struct)

Unsafe version of pfnFree().

npfnInternalAllocation

public static @Nullable VkInternalAllocationNotification npfnInternalAllocation(long struct)

Unsafe version of pfnInternalAllocation().

npfnInternalFree

public static @Nullable VkInternalFreeNotification npfnInternalFree(long struct)

Unsafe version of pfnInternalFree().

npUserData

public static void npUserData(long struct,
 long value)

Unsafe version of pUserData.

npfnAllocation

public static void npfnAllocation(long struct,
 @Nullable VkAllocationFunctionI value)

Unsafe version of pfnAllocation.

npfnReallocation

public static void npfnReallocation(long struct,
 @Nullable VkReallocationFunctionI value)

Unsafe version of pfnReallocation.

npfnFree

public static void npfnFree(long struct,
 @Nullable VkFreeFunctionI value)

Unsafe version of pfnFree.

npfnInternalAllocation

public static void npfnInternalAllocation(long struct,
 @Nullable VkInternalAllocationNotificationI value)

Unsafe version of pfnInternalAllocation.

npfnInternalFree

public static void npfnInternalFree(long struct,
 @Nullable VkInternalFreeNotificationI value)

Unsafe version of pfnInternalFree.