Top Description Inners Fields Constructors Methods
org.lwjgl.util.vma

public Class VmaDeviceMemoryCallbacks

extends Struct<VmaDeviceMemoryCallbacks>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
VmaDeviceMemoryCallbacks.Buffer

An array of VmaDeviceMemoryCallbacks structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PFNALLOCATE

The struct member offsets.

public static final int
PFNFREE

The struct member offsets.

public static final int
PUSERDATA

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VmaDeviceMemoryCallbacks(long address, ByteBuffer container)

public
VmaDeviceMemoryCallbacks(ByteBuffer container)

Creates a VmaDeviceMemoryCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VmaDeviceMemoryCallbacks
calloc()

Returns a new VmaDeviceMemoryCallbacks instance allocated with memCalloc.

public static VmaDeviceMemoryCallbacks.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated with memCalloc.

public static VmaDeviceMemoryCallbacks
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VmaDeviceMemoryCallbacks.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VmaDeviceMemoryCallbacks
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDeviceMemoryCallbacks
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDeviceMemoryCallbacks.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDeviceMemoryCallbacks.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VmaDeviceMemoryCallbacks
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VmaDeviceMemoryCallbacks
create()

Returns a new VmaDeviceMemoryCallbacks instance allocated with BufferUtils.

public static VmaDeviceMemoryCallbacks
create(long address)

Returns a new VmaDeviceMemoryCallbacks instance for the specified memory address.

public static VmaDeviceMemoryCallbacks.Buffer
create(int
the buffer capacity
capacity)

Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated with BufferUtils.

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

Create a VmaDeviceMemoryCallbacks.Buffer instance at the specified memory.

public static VmaDeviceMemoryCallbacks
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VmaDeviceMemoryCallbacks
malloc()

Returns a new VmaDeviceMemoryCallbacks instance allocated with memAlloc.

public static VmaDeviceMemoryCallbacks.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated with memAlloc.

public static VmaDeviceMemoryCallbacks
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VmaDeviceMemoryCallbacks instance allocated on the specified MemoryStack.

public static VmaDeviceMemoryCallbacks.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VmaDeviceMemoryCallbacks
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDeviceMemoryCallbacks
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDeviceMemoryCallbacks.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDeviceMemoryCallbacks.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaAllocateDeviceMemoryFunction
npfnAllocate(long struct)

Unsafe version of pfnAllocate.

public static void
npfnAllocate(long struct, VmaAllocateDeviceMemoryFunctionI value)

Unsafe version of pfnAllocate.

public static VmaFreeDeviceMemoryFunction
npfnFree(long struct)

Unsafe version of pfnFree.

public static void
npfnFree(long struct, VmaFreeDeviceMemoryFunctionI value)

Unsafe version of pfnFree.

public static long
npUserData(long struct)

Unsafe version of pUserData.

public static void
npUserData(long struct, long value)

Unsafe version of pUserData.

public VmaAllocateDeviceMemoryFunction

Returns:

the value of the pfnAllocate field.
pfnAllocate()

public VmaDeviceMemoryCallbacks
pfnAllocate(VmaAllocateDeviceMemoryFunctionI value)

Sets the specified value to the pfnAllocate field.

public VmaFreeDeviceMemoryFunction

Returns:

the value of the pfnFree field.
pfnFree()

public VmaDeviceMemoryCallbacks
pfnFree(VmaFreeDeviceMemoryFunctionI value)

Sets the specified value to the pfnFree field.

public long

Returns:

the value of the pUserData field.
pUserData()

public VmaDeviceMemoryCallbacks
pUserData(long value)

Sets the specified value to the pUserData field.

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

Initializes this struct with the specified values.

public VmaDeviceMemoryCallbacks

Returns:

this struct
set(VmaDeviceMemoryCallbacks
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PFNALLOCATEback to summary
public static final int PFNALLOCATE

The struct member offsets.

PFNFREEback to summary
public static final int PFNFREE

The struct member offsets.

PUSERDATAback to summary
public static final int PUSERDATA

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VmaDeviceMemoryCallbacksback to summary
protected VmaDeviceMemoryCallbacks(long address, ByteBuffer container)
VmaDeviceMemoryCallbacksback to summary
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 Detail

callocback to summary
public static VmaDeviceMemoryCallbacks calloc()

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

callocback to summary
public static VmaDeviceMemoryCallbacks.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VmaDeviceMemoryCallbacks calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VmaDeviceMemoryCallbacks.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VmaDeviceMemoryCallbacks callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VmaDeviceMemoryCallbacks callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VmaDeviceMemoryCallbacks.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VmaDeviceMemoryCallbacks.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VmaDeviceMemoryCallbacks create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VmaDeviceMemoryCallbacks create()

Returns a new VmaDeviceMemoryCallbacks instance allocated with BufferUtils.

createback to summary
public static VmaDeviceMemoryCallbacks create(long address)

Returns a new VmaDeviceMemoryCallbacks instance for the specified memory address.

createback to summary
public static VmaDeviceMemoryCallbacks.Buffer create(int capacity)

Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VmaDeviceMemoryCallbacks.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VmaDeviceMemoryCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VmaDeviceMemoryCallbacks.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VmaDeviceMemoryCallbacks malloc()

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

mallocback to summary
public static VmaDeviceMemoryCallbacks.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VmaDeviceMemoryCallbacks malloc(MemoryStack stack)

Returns a new VmaDeviceMemoryCallbacks instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VmaDeviceMemoryCallbacks.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VmaDeviceMemoryCallbacks mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VmaDeviceMemoryCallbacks mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
npfnAllocateback to summary
public static VmaAllocateDeviceMemoryFunction npfnAllocate(long struct)

Unsafe version of pfnAllocate.

Annotations
@Nullable
npfnAllocateback to summary
public static void npfnAllocate(long struct, VmaAllocateDeviceMemoryFunctionI value)

Unsafe version of pfnAllocate.

npfnFreeback to summary
public static VmaFreeDeviceMemoryFunction npfnFree(long struct)

Unsafe version of pfnFree.

Annotations
@Nullable
npfnFreeback to summary
public static void npfnFree(long struct, VmaFreeDeviceMemoryFunctionI value)

Unsafe version of pfnFree.

npUserDataback to summary
public static long npUserData(long struct)

Unsafe version of pUserData.

npUserDataback to summary
public static void npUserData(long struct, long value)

Unsafe version of pUserData.

pfnAllocateback to summary
public VmaAllocateDeviceMemoryFunction pfnAllocate()
Returns:VmaAllocateDeviceMemoryFunction

the value of the pfnAllocate field.

Annotations
@Nullable
@NativeType:PFN_vmaAllocateDeviceMemoryFunction
pfnAllocateback to summary
public VmaDeviceMemoryCallbacks pfnAllocate(VmaAllocateDeviceMemoryFunctionI value)

Sets the specified value to the pfnAllocate field.

pfnFreeback to summary
public VmaFreeDeviceMemoryFunction pfnFree()
Returns:VmaFreeDeviceMemoryFunction

the value of the pfnFree field.

Annotations
@Nullable
@NativeType:PFN_vmaFreeDeviceMemoryFunction
pfnFreeback to summary
public VmaDeviceMemoryCallbacks pfnFree(VmaFreeDeviceMemoryFunctionI value)

Sets the specified value to the pfnFree field.

pUserDataback to summary
public long pUserData()
Returns:long

the value of the pUserData field.

Annotations
@NativeType:void *
pUserDataback to summary
public VmaDeviceMemoryCallbacks pUserData(long value)

Sets the specified value to the pUserData field.

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

Initializes this struct with the specified values.

setback to summary
public VmaDeviceMemoryCallbacks set(VmaDeviceMemoryCallbacks src)

Copies the specified struct data to this struct.

Parameters
src:VmaDeviceMemoryCallbacks

the source struct

Returns:VmaDeviceMemoryCallbacks

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.util.vma back to summary

public Class VmaDeviceMemoryCallbacks.Buffer

extends StructBuffer<VmaDeviceMemoryCallbacks, VmaDeviceMemoryCallbacks.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VmaDeviceMemoryCallbacks structs.

Field Summary

Modifier and TypeField and Description
private static final VmaDeviceMemoryCallbacks
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VmaDeviceMemoryCallbacks.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VmaDeviceMemoryCallbacks
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public VmaAllocateDeviceMemoryFunction

Returns:

the value of the pfnAllocate field.
pfnAllocate()

public VmaDeviceMemoryCallbacks.Buffer
pfnAllocate(VmaAllocateDeviceMemoryFunctionI value)

Sets the specified value to the pfnAllocate field.

public VmaFreeDeviceMemoryFunction

Returns:

the value of the pfnFree field.
pfnFree()

public VmaDeviceMemoryCallbacks.Buffer
pfnFree(VmaFreeDeviceMemoryFunctionI value)

Sets the specified value to the pfnFree field.

public long

Returns:

the value of the pUserData field.
pUserData()

public VmaDeviceMemoryCallbacks.Buffer
pUserData(long value)

Sets the specified value to the pUserData field.

protected VmaDeviceMemoryCallbacks.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VmaDeviceMemoryCallbacks ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VmaDeviceMemoryCallbacks.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VmaDeviceMemoryCallbacks#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VmaDeviceMemoryCallbacks getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pfnAllocateback to summary
public VmaAllocateDeviceMemoryFunction pfnAllocate()
Returns:VmaAllocateDeviceMemoryFunction

the value of the pfnAllocate field.

Annotations
@Nullable
@NativeType:PFN_vmaAllocateDeviceMemoryFunction
pfnAllocateback to summary
public VmaDeviceMemoryCallbacks.Buffer pfnAllocate(VmaAllocateDeviceMemoryFunctionI value)

Sets the specified value to the pfnAllocate field.

pfnFreeback to summary
public VmaFreeDeviceMemoryFunction pfnFree()
Returns:VmaFreeDeviceMemoryFunction

the value of the pfnFree field.

Annotations
@Nullable
@NativeType:PFN_vmaFreeDeviceMemoryFunction
pfnFreeback to summary
public VmaDeviceMemoryCallbacks.Buffer pfnFree(VmaFreeDeviceMemoryFunctionI value)

Sets the specified value to the pfnFree field.

pUserDataback to summary
public long pUserData()
Returns:long

the value of the pUserData field.

Annotations
@NativeType:void *
pUserDataback to summary
public VmaDeviceMemoryCallbacks.Buffer pUserData(long value)

Sets the specified value to the pUserData field.

selfback to summary
protected VmaDeviceMemoryCallbacks.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override