VmaDeviceMemoryCallbacks (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.vma.VmaDeviceMemoryCallbacks

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VmaDeviceMemoryCallbacks
extends org.lwjgl.system.Struct
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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VmaDeviceMemoryCallbacks.Buffer
An array of VmaDeviceMemoryCallbacks structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PFNALLOCATE` The struct member offsets.
`static int`	`PFNFREE` The struct member offsets.
`static 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 and Description
`VmaDeviceMemoryCallbacks(java.nio.ByteBuffer container)` Creates a `VmaDeviceMemoryCallbacks` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VmaDeviceMemoryCallbacks` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaDeviceMemoryCallbacks.Buffer`	`callocStack(int capacity)` Returns a new `VmaDeviceMemoryCallbacks.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaDeviceMemoryCallbacks.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaDeviceMemoryCallbacks` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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 VmaDeviceMemoryCallbacks`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static 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`	`mallocStack()` Returns a new `VmaDeviceMemoryCallbacks` instance allocated on the thread-local `MemoryStack`.
`static VmaDeviceMemoryCallbacks.Buffer`	`mallocStack(int capacity)` Returns a new `VmaDeviceMemoryCallbacks.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VmaDeviceMemoryCallbacks.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaDeviceMemoryCallbacks.Buffer` instance allocated on the specified `MemoryStack`.
`static VmaDeviceMemoryCallbacks`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaDeviceMemoryCallbacks` instance allocated on the specified `MemoryStack`.
`static VmaAllocateDeviceMemoryFunction`	`npfnAllocate(long struct)` Unsafe version of `pfnAllocate()`.
`static void`	`npfnAllocate(long struct, VmaAllocateDeviceMemoryFunctionI value)` Unsafe version of `pfnAllocate`.
`static VmaFreeDeviceMemoryFunction`	`npfnFree(long struct)` Unsafe version of `pfnFree()`.
`static void`	`npfnFree(long struct, VmaFreeDeviceMemoryFunctionI value)` Unsafe version of `pfnFree`.
`VmaAllocateDeviceMemoryFunction`	`pfnAllocate()` Returns the value of the `pfnAllocate` field.
`VmaDeviceMemoryCallbacks`	`pfnAllocate(VmaAllocateDeviceMemoryFunctionI value)` Sets the specified value to the `pfnAllocate` field.
`VmaFreeDeviceMemoryFunction`	`pfnFree()` Returns the value of the `pfnFree` field.
`VmaDeviceMemoryCallbacks`	`pfnFree(VmaFreeDeviceMemoryFunctionI value)` Sets the specified value to the `pfnFree` field.
`VmaDeviceMemoryCallbacks`	`set(VmaAllocateDeviceMemoryFunctionI pfnAllocate, VmaFreeDeviceMemoryFunctionI pfnFree)` 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

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 Detail
  - 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.
- Constructor Detail
  - VmaDeviceMemoryCallbacks
```
public VmaDeviceMemoryCallbacks(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - pfnAllocate
```
@Nullable
public VmaAllocateDeviceMemoryFunction pfnAllocate()
```
    Returns the value of the pfnAllocate field.
  - pfnFree
```
@Nullable
public VmaFreeDeviceMemoryFunction pfnFree()
```
    Returns the value of the pfnFree 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.
  - set
```
public VmaDeviceMemoryCallbacks set(VmaAllocateDeviceMemoryFunctionI pfnAllocate,
                                    VmaFreeDeviceMemoryFunctionI pfnFree)
```
    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
```
@Nullable
public static 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
```
@Nullable
public static VmaDeviceMemoryCallbacks.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VmaDeviceMemoryCallbacks mallocStack()
```
    Returns a new VmaDeviceMemoryCallbacks instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VmaDeviceMemoryCallbacks callocStack()
```
    Returns a new VmaDeviceMemoryCallbacks instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VmaDeviceMemoryCallbacks mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaDeviceMemoryCallbacks instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VmaDeviceMemoryCallbacks callocStack(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
  - mallocStack
```
public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity)
```
    Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaDeviceMemoryCallbacks.Buffer callocStack(int capacity)
```
    Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaDeviceMemoryCallbacks.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaDeviceMemoryCallbacks.Buffer callocStack(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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - npfnAllocate
```
@Nullable
public static VmaAllocateDeviceMemoryFunction npfnAllocate(long struct)
```
    Unsafe version of pfnAllocate().
  - npfnFree
```
@Nullable
public static VmaFreeDeviceMemoryFunction npfnFree(long struct)
```
    Unsafe version of pfnFree().
  - 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.

Class VmaDeviceMemoryCallbacks

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

PFNALLOCATE

PFNFREE

Constructor Detail

VmaDeviceMemoryCallbacks

Method Detail

sizeof

pfnAllocate

pfnFree

pfnAllocate

pfnFree

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

npfnAllocate

npfnFree

npfnAllocate

npfnFree