Package org.lwjgl.util.vma
Class VmaDeviceMemoryCallbacks
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VmaDeviceMemoryCallbacks
extends Struct<VmaDeviceMemoryCallbacks>
implements 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/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
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
ConstructorDescriptionVmaDeviceMemoryCallbacks
(ByteBuffer container) Creates aVmaDeviceMemoryCallbacks
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VmaDeviceMemoryCallbacks
calloc()
Returns a newVmaDeviceMemoryCallbacks
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VmaDeviceMemoryCallbacks
calloc
(MemoryStack stack) Returns a newVmaDeviceMemoryCallbacks
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VmaDeviceMemoryCallbacks
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VmaDeviceMemoryCallbacks
callocStack
(MemoryStack stack) Deprecated.static VmaDeviceMemoryCallbacks
create()
Returns a newVmaDeviceMemoryCallbacks
instance allocated withBufferUtils
.create
(int capacity) Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated withBufferUtils
.static VmaDeviceMemoryCallbacks
create
(long address) Returns a newVmaDeviceMemoryCallbacks
instance for the specified memory address.create
(long address, int capacity) Create aVmaDeviceMemoryCallbacks.Buffer
instance at the specified memory.static VmaDeviceMemoryCallbacks
createSafe
(long address) createSafe
(long address, int capacity) static VmaDeviceMemoryCallbacks
malloc()
Returns a newVmaDeviceMemoryCallbacks
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated on the specifiedMemoryStack
.static VmaDeviceMemoryCallbacks
malloc
(MemoryStack stack) Returns a newVmaDeviceMemoryCallbacks
instance allocated on the specifiedMemoryStack
.static VmaDeviceMemoryCallbacks
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VmaDeviceMemoryCallbacks
mallocStack
(MemoryStack stack) Deprecated.npfnAllocate
(long struct) Unsafe version ofpfnAllocate()
.static void
npfnAllocate
(long struct, VmaAllocateDeviceMemoryFunctionI value) Unsafe version ofpfnAllocate
.static VmaFreeDeviceMemoryFunction
npfnFree
(long struct) Unsafe version ofpfnFree()
.static void
npfnFree
(long struct, VmaFreeDeviceMemoryFunctionI value) Unsafe version ofpfnFree
.static long
npUserData
(long struct) Unsafe version ofpUserData()
.static void
npUserData
(long struct, long value) Unsafe version ofpUserData
.Sets the specified value to thepfnAllocate
field.pfnFree()
Sets the specified value to thepfnFree
field.long
pUserData
(long value) Sets the specified value to thepUserData
field.set
(VmaAllocateDeviceMemoryFunctionI pfnAllocate, VmaFreeDeviceMemoryFunctionI pfnFree, long pUserData) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
PFNALLOCATE
public static final int PFNALLOCATEThe struct member offsets. -
PFNFREE
public static final int PFNFREEThe struct member offsets. -
PUSERDATA
public static final int PUSERDATAThe struct member offsets.
-
-
Constructor Details
-
VmaDeviceMemoryCallbacks
Creates aVmaDeviceMemoryCallbacks
instance at the current position of the specifiedByteBuffer
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
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VmaDeviceMemoryCallbacks>
-
pfnAllocate
- Returns:
- the value of the
pfnAllocate
field.
-
pfnFree
- Returns:
- the value of the
pfnFree
field.
-
pUserData
public long pUserData()- Returns:
- the value of the
pUserData
field.
-
pfnAllocate
Sets the specified value to thepfnAllocate
field. -
pfnFree
Sets the specified value to thepfnFree
field. -
pUserData
Sets the specified value to thepUserData
field. -
set
public VmaDeviceMemoryCallbacks set(VmaAllocateDeviceMemoryFunctionI pfnAllocate, VmaFreeDeviceMemoryFunctionI pfnFree, long pUserData) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVmaDeviceMemoryCallbacks
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVmaDeviceMemoryCallbacks
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVmaDeviceMemoryCallbacks
instance allocated withBufferUtils
. -
create
Returns a newVmaDeviceMemoryCallbacks
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVmaDeviceMemoryCallbacks.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VmaDeviceMemoryCallbacks.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVmaDeviceMemoryCallbacks
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVmaDeviceMemoryCallbacks
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVmaDeviceMemoryCallbacks.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
npfnAllocate
Unsafe version ofpfnAllocate()
. -
npfnFree
Unsafe version ofpfnFree()
. -
npUserData
public static long npUserData(long struct) Unsafe version ofpUserData()
. -
npfnAllocate
Unsafe version ofpfnAllocate
. -
npfnFree
Unsafe version ofpfnFree
. -
npUserData
public static void npUserData(long struct, long value) Unsafe version ofpUserData
.
-