Package org.lwjgl.util.vma

Class VmaDeviceMemoryCallbacks

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VmaDeviceMemoryCallbacks>

org.lwjgl.util.vma.VmaDeviceMemoryCallbacks

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VmaDeviceMemoryCallbacks
extends org.lwjgl.system.Struct<VmaDeviceMemoryCallbacks>
implements org.lwjgl.system.NativeResource

Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory.

Provided for informative purpose, e.g. to gather statistics about number of allocations or total amount of memory allocated in Vulkan.

Used in VmaAllocatorCreateInfo::pDeviceMemoryCallbacks.

Layout

 struct VmaDeviceMemoryCallbacks {
     PFN_vmaAllocateDeviceMemoryFunction pfnAllocate;
     PFN_vmaFreeDeviceMemoryFunction pfnFree;
     void * pUserData;
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PFNALLOCATE	The struct member offsets.
static final int	PFNFREE	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VmaDeviceMemoryCallbacks	calloc()	Returns a new VmaDeviceMemoryCallbacks instance allocated with memCalloc.
static VmaDeviceMemoryCallbacks.Buffer	calloc(int capacity)	Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated with memCalloc.
static VmaDeviceMemoryCallbacks.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaDeviceMemoryCallbacks	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VmaDeviceMemoryCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaDeviceMemoryCallbacks	callocStack()	Deprecated.
static VmaDeviceMemoryCallbacks.Buffer	callocStack(int capacity)	Deprecated.
static VmaDeviceMemoryCallbacks.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VmaDeviceMemoryCallbacks	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VmaDeviceMemoryCallbacks	create()	Returns a new VmaDeviceMemoryCallbacks instance allocated with BufferUtils.
static VmaDeviceMemoryCallbacks.Buffer	create(int capacity)	Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated with BufferUtils.
static VmaDeviceMemoryCallbacks	create(long address)	Returns a new VmaDeviceMemoryCallbacks instance for the specified memory address.
static VmaDeviceMemoryCallbacks.Buffer	create(long address, int capacity)	Create a VmaDeviceMemoryCallbacks.Buffer instance at the specified memory.
static @Nullable VmaDeviceMemoryCallbacks	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VmaDeviceMemoryCallbacks.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VmaDeviceMemoryCallbacks	malloc()	Returns a new VmaDeviceMemoryCallbacks instance allocated with memAlloc.
static VmaDeviceMemoryCallbacks.Buffer	malloc(int capacity)	Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated with memAlloc.
static VmaDeviceMemoryCallbacks.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated on the specified MemoryStack.
static VmaDeviceMemoryCallbacks	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VmaDeviceMemoryCallbacks instance allocated on the specified MemoryStack.
static VmaDeviceMemoryCallbacks	mallocStack()	Deprecated.
static VmaDeviceMemoryCallbacks.Buffer	mallocStack(int capacity)	Deprecated.
static VmaDeviceMemoryCallbacks.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VmaDeviceMemoryCallbacks	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static @Nullable VmaAllocateDeviceMemoryFunction	npfnAllocate(long struct)	Unsafe version of pfnAllocate().
static void	npfnAllocate(long struct, @Nullable VmaAllocateDeviceMemoryFunctionI value)	Unsafe version of pfnAllocate.
static @Nullable VmaFreeDeviceMemoryFunction	npfnFree(long struct)	Unsafe version of pfnFree().
static void	npfnFree(long struct, @Nullable VmaFreeDeviceMemoryFunctionI value)	Unsafe version of pfnFree.
static long	npUserData(long struct)	Unsafe version of pUserData().
static void	npUserData(long struct, long value)	Unsafe version of pUserData.
@Nullable VmaAllocateDeviceMemoryFunction	pfnAllocate()
VmaDeviceMemoryCallbacks	pfnAllocate(@Nullable VmaAllocateDeviceMemoryFunctionI value)	Sets the specified value to the pfnAllocate field.
@Nullable VmaFreeDeviceMemoryFunction	pfnFree()
VmaDeviceMemoryCallbacks	pfnFree(@Nullable VmaFreeDeviceMemoryFunctionI value)	Sets the specified value to the pfnFree field.
long	pUserData()
VmaDeviceMemoryCallbacks	pUserData(long value)	Sets the specified value to the pUserData field.
VmaDeviceMemoryCallbacks	set(VmaAllocateDeviceMemoryFunctionI pfnAllocate, VmaFreeDeviceMemoryFunctionI pfnFree, long pUserData)	Initializes this struct with the specified values.
VmaDeviceMemoryCallbacks	set(VmaDeviceMemoryCallbacks src)	Copies the specified struct data to this struct.
int	sizeof()

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.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.

PFNALLOCATE

public static final int PFNALLOCATE

The struct member offsets.

PFNFREE

public static final int PFNFREE

The struct member offsets.

PUSERDATA

public static final int PUSERDATA

The struct member offsets.

Constructor Details

VmaDeviceMemoryCallbacks

public VmaDeviceMemoryCallbacks(ByteBuffer container)

Creates a VmaDeviceMemoryCallbacks 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VmaDeviceMemoryCallbacks>

pfnAllocate

public @Nullable VmaAllocateDeviceMemoryFunction pfnAllocate()

Returns:

the value of the pfnAllocate field.

pfnFree

public @Nullable VmaFreeDeviceMemoryFunction pfnFree()

Returns:

the value of the pfnFree field.

pUserData

public long pUserData()

Returns:

the value of the pUserData field.

pfnAllocate

public VmaDeviceMemoryCallbacks pfnAllocate(@Nullable VmaAllocateDeviceMemoryFunctionI value)

Sets the specified value to the pfnAllocate field.

pfnFree

public VmaDeviceMemoryCallbacks pfnFree(@Nullable VmaFreeDeviceMemoryFunctionI value)

Sets the specified value to the pfnFree field.

pUserData

public VmaDeviceMemoryCallbacks pUserData(long value)

Sets the specified value to the pUserData field.

set

public VmaDeviceMemoryCallbacks set(VmaAllocateDeviceMemoryFunctionI pfnAllocate,
 VmaFreeDeviceMemoryFunctionI pfnFree,
 long pUserData)

Initializes this struct with the specified values.

set

public VmaDeviceMemoryCallbacks set(VmaDeviceMemoryCallbacks src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VmaDeviceMemoryCallbacks malloc()

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

calloc

public static VmaDeviceMemoryCallbacks calloc()

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

create

public static VmaDeviceMemoryCallbacks create()

Returns a new VmaDeviceMemoryCallbacks instance allocated with BufferUtils.

create

public static VmaDeviceMemoryCallbacks create(long address)

Returns a new VmaDeviceMemoryCallbacks instance for the specified memory address.

createSafe

public static @Nullable VmaDeviceMemoryCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VmaDeviceMemoryCallbacks.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VmaDeviceMemoryCallbacks.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VmaDeviceMemoryCallbacks.Buffer create(int capacity)

Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VmaDeviceMemoryCallbacks.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VmaDeviceMemoryCallbacks mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VmaDeviceMemoryCallbacks callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VmaDeviceMemoryCallbacks mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VmaDeviceMemoryCallbacks callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VmaDeviceMemoryCallbacks.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VmaDeviceMemoryCallbacks.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VmaDeviceMemoryCallbacks malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VmaDeviceMemoryCallbacks instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VmaDeviceMemoryCallbacks calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VmaDeviceMemoryCallbacks.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VmaDeviceMemoryCallbacks.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VmaDeviceMemoryCallbacks.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

npfnAllocate

public static @Nullable VmaAllocateDeviceMemoryFunction npfnAllocate(long struct)

Unsafe version of pfnAllocate().

npfnFree

public static @Nullable VmaFreeDeviceMemoryFunction npfnFree(long struct)

Unsafe version of pfnFree().

npUserData

public static long npUserData(long struct)

Unsafe version of pUserData().

npfnAllocate

public static void npfnAllocate(long struct,
 @Nullable VmaAllocateDeviceMemoryFunctionI value)

Unsafe version of pfnAllocate.

npfnFree

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

Unsafe version of pfnFree.

npUserData

public static void npUserData(long struct,
 long value)

Unsafe version of pUserData.