java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkAllocationCallbacks

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkAllocationCallbacks
extends Struct
```
Khronos Reference Page
Vulkan Specification
Contains pointers to callback functions that are used to create, reallocate and free host memory allocations on behalf of a Vulkan implementation.

Valid Usage
- pfnAllocation must be a pointer to a valid user-defined PFN_vkAllocationFunction
- pfnReallocation must be a pointer to a valid user-defined PFN_vkReallocationFunction
- pfnFree must be a pointer to a valid user-defined PFN_vkFreeFunction
- If either of pfnInternalAllocation or pfnInternalFree is not NULL, both must be valid callbacks
Member documentation
- pUserData – a value to be interpreted by the implementation of the callbacks. When any of the callbacks in VkAllocationCallbacks are called, the Vulkan implementation will pass this value as the first parameter to the callback. This value can vary each time an allocator is passed into a command, even when the same object takes an allocator in multiple commands.
- pfnAllocation – a pointer to an application-defined memory allocation function of type PFN_vkAllocationFunction
- pfnReallocation – a pointer to an application-defined memory reallocation function of type PFN_vkReallocationFunction
- pfnFree – a pointer to an application-defined memory free function of type PFN_vkFreeFunction
- pfnInternalAllocation – a pointer to an application-defined function that is called by the implementation when the implementation makes internal allocations, and it is of type PFN_vkInternalAllocationNotification
- pfnInternalFree – a pointer to an application-defined function that is called by the implementation when the implementation frees internal allocations, and it is of type PFN_vkInternalFreeNotification
Layout
```
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 and Description

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

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkAllocationCallbacks(java.nio.ByteBuffer container)` Creates a `VkAllocationCallbacks` 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 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`	`callocStack()` Returns a new `VkAllocationCallbacks` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAllocationCallbacks.Buffer`	`callocStack(int capacity)` Returns a new `VkAllocationCallbacks.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAllocationCallbacks.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkAllocationCallbacks.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAllocationCallbacks`	`callocStack(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 or `null` if the address is `NULL`.
`static VkAllocationCallbacks.Buffer`	`create(long address, int capacity)` Create a `VkAllocationCallbacks.Buffer` instance at the specified memory.
`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`	`mallocStack()` Returns a new `VkAllocationCallbacks` instance allocated on the thread-local `MemoryStack`.
`static VkAllocationCallbacks.Buffer`	`mallocStack(int capacity)` Returns a new `VkAllocationCallbacks.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkAllocationCallbacks.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkAllocationCallbacks.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAllocationCallbacks`	`mallocStack(MemoryStack stack)` Returns a new `VkAllocationCallbacks` instance allocated on the specified `MemoryStack`.
`VkAllocationCallbacks`	`nset(long struct)` Unsafe version of `set`.
`VkAllocationFunction`	`pfnAllocation()` Returns the `VkAllocationFunction` instance at the `pfnAllocation` field.
`VkAllocationCallbacks`	`pfnAllocation(VkAllocationFunctionI value)` Sets the address of the specified `VkAllocationFunctionI` to the `pfnAllocation` field.
`VkFreeFunction`	`pfnFree()` Returns the `VkFreeFunction` instance at the `pfnFree` field.
`VkAllocationCallbacks`	`pfnFree(VkFreeFunctionI value)` Sets the address of the specified `VkFreeFunctionI` to the `pfnFree` field.
`VkInternalAllocationNotification`	`pfnInternalAllocation()` Returns the `VkInternalAllocationNotification` instance at the `pfnInternalAllocation` field.
`VkAllocationCallbacks`	`pfnInternalAllocation(VkInternalAllocationNotificationI value)` Sets the address of the specified `VkInternalAllocationNotificationI` to the `pfnInternalAllocation` field.
`VkInternalFreeNotification`	`pfnInternalFree()` Returns the `VkInternalFreeNotification` instance at the `pfnInternalFree` field.
`VkAllocationCallbacks`	`pfnInternalFree(VkInternalFreeNotificationI value)` Sets the address of the specified `VkInternalFreeNotificationI` to the `pfnInternalFree` field.
`VkReallocationFunction`	`pfnReallocation()` Returns the `VkReallocationFunction` instance at the `pfnReallocation` field.
`VkAllocationCallbacks`	`pfnReallocation(VkReallocationFunctionI value)` Sets the address of the specified `VkReallocationFunctionI` to the `pfnReallocation` field.
`long`	`pUserData()` Returns the value of the `pUserData` field.
`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 the `sizeof(struct)`.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `VkAllocationCallbacks.validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkAllocationCallbacks
```
public VkAllocationCallbacks(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - pUserData
```
public long pUserData()
```
    Returns the value of the pUserData field.
  - pfnAllocation
```
public VkAllocationFunction pfnAllocation()
```
    Returns the VkAllocationFunction instance at the pfnAllocation field.
  - pfnReallocation
```
public VkReallocationFunction pfnReallocation()
```
    Returns the VkReallocationFunction instance at the pfnReallocation field.
  - pfnFree
```
public VkFreeFunction pfnFree()
```
    Returns the VkFreeFunction instance at the pfnFree field.
  - pfnInternalAllocation
```
public VkInternalAllocationNotification pfnInternalAllocation()
```
    Returns the VkInternalAllocationNotification instance at the pfnInternalAllocation field.
  - pfnInternalFree
```
public VkInternalFreeNotification pfnInternalFree()
```
    Returns the VkInternalFreeNotification instance at the pfnInternalFree field.
  - pUserData
```
public VkAllocationCallbacks pUserData(long value)
```
    Sets the specified value to the pUserData field.
  - pfnAllocation
```
public VkAllocationCallbacks pfnAllocation(VkAllocationFunctionI value)
```
    Sets the address of the specified VkAllocationFunctionI to the pfnAllocation field.
  - pfnReallocation
```
public VkAllocationCallbacks pfnReallocation(VkReallocationFunctionI value)
```
    Sets the address of the specified VkReallocationFunctionI to the pfnReallocation field.
  - pfnFree
```
public VkAllocationCallbacks pfnFree(VkFreeFunctionI value)
```
    Sets the address of the specified VkFreeFunctionI to the pfnFree field.
  - pfnInternalAllocation
```
public VkAllocationCallbacks pfnInternalAllocation(VkInternalAllocationNotificationI value)
```
    Sets the address of the specified VkInternalAllocationNotificationI to the pfnInternalAllocation field.
  - pfnInternalFree
```
public VkAllocationCallbacks pfnInternalFree(VkInternalFreeNotificationI value)
```
    Sets the address of the specified VkInternalFreeNotificationI 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.
  - nset
```
public VkAllocationCallbacks nset(long struct)
```
    Unsafe version of set.
  - 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 or null if the 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
  - mallocStack
```
public static VkAllocationCallbacks mallocStack()
```
    Returns a new VkAllocationCallbacks instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkAllocationCallbacks callocStack()
```
    Returns a new VkAllocationCallbacks instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkAllocationCallbacks mallocStack(MemoryStack stack)
```
    Returns a new VkAllocationCallbacks instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkAllocationCallbacks callocStack(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
  - mallocStack
```
public static VkAllocationCallbacks.Buffer mallocStack(int capacity)
```
    Returns a new VkAllocationCallbacks.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAllocationCallbacks.Buffer callocStack(int capacity)
```
    Returns a new VkAllocationCallbacks.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkAllocationCallbacks.Buffer mallocStack(int capacity,
                                                       MemoryStack stack)
```
    Returns a new VkAllocationCallbacks.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAllocationCallbacks.Buffer callocStack(int capacity,
                                                       MemoryStack stack)
```
    Returns a new VkAllocationCallbacks.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
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls VkAllocationCallbacks.validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkAllocationCallbacks

Valid Usage

Member documentation

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

Constructor Detail

VkAllocationCallbacks

Method Detail

sizeof

pUserData

pfnAllocation

pfnReallocation

pfnFree

pfnInternalAllocation

pfnInternalFree

pUserData

pfnAllocation

pfnReallocation

pfnFree

pfnInternalAllocation

pfnInternalFree

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

validate

validate