VkAllocationCallbacks (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkAllocationCallbacks
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure containing callback function pointers for memory allocation.
Valid Usage
- pfnAllocation must be a valid pointer to a valid user-defined VkAllocationFunction
- pfnReallocation must be a valid pointer to a valid user-defined VkReallocationFunction
- pfnFree must be a valid pointer to a valid user-defined VkFreeFunction
- If either of pfnInternalAllocation or pfnInternalFree is not NULL, both must be valid callbacks
See Also

VkAllocationFunction, VkFreeFunction, VkInternalAllocationNotification, VkInternalFreeNotification, VkReallocationFunction, AllocateMemory, CreateAccelerationStructureNV, CreateBuffer, CreateBufferView, CreateCommandPool, CreateComputePipelines, CreateDebugReportCallbackEXT, CreateDebugUtilsMessengerEXT, CreateDescriptorPool, CreateDescriptorSetLayout, CreateDescriptorUpdateTemplate, CreateDescriptorUpdateTemplateKHR, CreateDevice, CreateDisplayModeKHR, CreateDisplayPlaneSurfaceKHR, CreateEvent, CreateFence, CreateFramebuffer, CreateGraphicsPipelines, CreateHeadlessSurfaceEXT, CreateImage, CreateImageView, CreateIndirectCommandsLayoutNVX, CreateInstance, CreateMacOSSurfaceMVK, CreateMetalSurfaceEXT, CreateObjectTableNVX, CreatePipelineCache, CreatePipelineLayout, CreateQueryPool, CreateRayTracingPipelinesNV, CreateRenderPass, CreateRenderPass2KHR, CreateSampler, CreateSamplerYcbcrConversion, CreateSamplerYcbcrConversionKHR, CreateSemaphore, CreateShaderModule, CreateSharedSwapchainsKHR, CreateSwapchainKHR, CreateValidationCacheEXT, CreateWaylandSurfaceKHR, CreateWin32SurfaceKHR, CreateXlibSurfaceKHR, DestroyAccelerationStructureNV, DestroyBuffer, DestroyBufferView, DestroyCommandPool, DestroyDebugReportCallbackEXT, DestroyDebugUtilsMessengerEXT, DestroyDescriptorPool, DestroyDescriptorSetLayout, DestroyDescriptorUpdateTemplate, DestroyDescriptorUpdateTemplateKHR, DestroyDevice, DestroyEvent, DestroyFence, DestroyFramebuffer, DestroyImage, DestroyImageView, DestroyIndirectCommandsLayoutNVX, DestroyInstance, DestroyObjectTableNVX, DestroyPipeline, DestroyPipelineCache, DestroyPipelineLayout, DestroyQueryPool, DestroyRenderPass, DestroySampler, DestroySamplerYcbcrConversion, DestroySamplerYcbcrConversionKHR, DestroySemaphore, DestroyShaderModule, DestroySurfaceKHR, DestroySwapchainKHR, DestroyValidationCacheEXT, FreeMemory, RegisterDeviceEventEXT, RegisterDisplayEventEXT

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 VkAllocationFunction pointer to an application-defined memory allocation function.
- pfnReallocation – a VkReallocationFunction pointer to an application-defined memory reallocation function.
- pfnFree – a VkFreeFunction pointer to an application-defined memory free function.
- pfnInternalAllocation – a VkInternalAllocationNotification pointer to an application-defined function that is called by the implementation when the implementation makes internal allocations.
- pfnInternalFree – a VkInternalFreeNotification pointer to an application-defined function that is called by the implementation when the implementation frees internal allocations.
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
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PFNALLOCATION` The struct member offsets.
`static int`	`PFNFREE` The struct member offsets.
`static int`	`PFNINTERNALALLOCATION` The struct member offsets.
`static int`	`PFNINTERNALFREE` The struct member offsets.
`static int`	`PFNREALLOCATION` The struct member offsets.
`static int`	`PUSERDATA` 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
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAllocationCallbacks.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAllocationCallbacks`	`callocStack(org.lwjgl.system.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.
`static VkAllocationCallbacks.Buffer`	`create(long address, int capacity)` Create a `VkAllocationCallbacks.Buffer` instance at the specified memory.
`static VkAllocationCallbacks`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkAllocationCallbacks.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAllocationCallbacks.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAllocationCallbacks`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAllocationCallbacks` instance allocated on the specified `MemoryStack`.
`static VkAllocationFunction`	`npfnAllocation(long struct)` Unsafe version of `pfnAllocation()`.
`static void`	`npfnAllocation(long struct, VkAllocationFunctionI value)` Unsafe version of `pfnAllocation`.
`static VkFreeFunction`	`npfnFree(long struct)` Unsafe version of `pfnFree()`.
`static void`	`npfnFree(long struct, VkFreeFunctionI value)` Unsafe version of `pfnFree`.
`static VkInternalAllocationNotification`	`npfnInternalAllocation(long struct)` Unsafe version of `pfnInternalAllocation()`.
`static void`	`npfnInternalAllocation(long struct, VkInternalAllocationNotificationI value)` Unsafe version of `pfnInternalAllocation`.
`static VkInternalFreeNotification`	`npfnInternalFree(long struct)` Unsafe version of `pfnInternalFree()`.
`static void`	`npfnInternalFree(long struct, VkInternalFreeNotificationI value)` Unsafe version of `pfnInternalFree`.
`static VkReallocationFunction`	`npfnReallocation(long struct)` Unsafe version of `pfnReallocation()`.
`static void`	`npfnReallocation(long struct, VkReallocationFunctionI value)` Unsafe version of `pfnReallocation`.
`static long`	`npUserData(long struct)` Unsafe version of `pUserData()`.
`static void`	`npUserData(long struct, long value)` Unsafe version of `pUserData`.
`VkAllocationFunction`	`pfnAllocation()` Returns the value of the `pfnAllocation` field.
`VkAllocationCallbacks`	`pfnAllocation(VkAllocationFunctionI value)` Sets the specified value to the `pfnAllocation` field.
`VkFreeFunction`	`pfnFree()` Returns the value of the `pfnFree` field.
`VkAllocationCallbacks`	`pfnFree(VkFreeFunctionI value)` Sets the specified value to the `pfnFree` field.
`VkInternalAllocationNotification`	`pfnInternalAllocation()` Returns the value of the `pfnInternalAllocation` field.
`VkAllocationCallbacks`	`pfnInternalAllocation(VkInternalAllocationNotificationI value)` Sets the specified value to the `pfnInternalAllocation` field.
`VkInternalFreeNotification`	`pfnInternalFree()` Returns the value of the `pfnInternalFree` field.
`VkAllocationCallbacks`	`pfnInternalFree(VkInternalFreeNotificationI value)` Sets the specified value to the `pfnInternalFree` field.
`VkReallocationFunction`	`pfnReallocation()` Returns the value of the `pfnReallocation` field.
`VkAllocationCallbacks`	`pfnReallocation(VkReallocationFunctionI value)` Sets the specified value 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()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
- PUSERDATA
```
public static final int PUSERDATA
```
  The struct member offsets.
- PFNALLOCATION
```
public static final int PFNALLOCATION
```
  The struct member offsets.
- PFNREALLOCATION
```
public static final int PFNREALLOCATION
```
  The struct member offsets.
- PFNFREE
```
public static final int PFNFREE
```
  The struct member offsets.
- PFNINTERNALALLOCATION
```
public static final int PFNINTERNALALLOCATION
```
  The struct member offsets.
- PFNINTERNALFREE
```
public static final int PFNINTERNALFREE
```
  The struct member offsets.

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()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

pUserData
```
public long pUserData()
```
Returns the value of the pUserData field.

pfnAllocation
```
public VkAllocationFunction pfnAllocation()
```
Returns the value of the pfnAllocation field.

pfnReallocation
```
public VkReallocationFunction pfnReallocation()
```
Returns the value of the pfnReallocation field.

pfnFree
```
public VkFreeFunction pfnFree()
```
Returns the value of the pfnFree field.

pfnInternalAllocation

@Nullable
public VkInternalAllocationNotification pfnInternalAllocation()

Returns the value of the pfnInternalAllocation field.

pfnInternalFree

@Nullable
public VkInternalFreeNotification pfnInternalFree()

Returns the value of 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 specified value to the pfnAllocation field.

pfnReallocation

public VkAllocationCallbacks pfnReallocation(VkReallocationFunctionI value)

Sets the specified value to the pfnReallocation field.

pfnFree

public VkAllocationCallbacks pfnFree(VkFreeFunctionI value)

Sets the specified value to the pfnFree field.

pfnInternalAllocation

public VkAllocationCallbacks pfnInternalAllocation(@Nullable
                                                   VkInternalAllocationNotificationI value)

Sets the specified value to the pfnInternalAllocation field.

pfnInternalFree

public VkAllocationCallbacks pfnInternalFree(@Nullable
                                             VkInternalFreeNotificationI value)

Sets the specified value 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.

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.

createSafe

@Nullable
public static VkAllocationCallbacks createSafe(long address)

Like create, but returns null if 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

createSafe

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

Like create, but returns null if address is NULL.

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(org.lwjgl.system.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(org.lwjgl.system.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,
                                                       org.lwjgl.system.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,
                                                       org.lwjgl.system.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

npUserData

public static long npUserData(long struct)

Unsafe version of pUserData().

npfnAllocation

public static VkAllocationFunction npfnAllocation(long struct)

Unsafe version of pfnAllocation().

npfnReallocation

public static VkReallocationFunction npfnReallocation(long struct)

Unsafe version of pfnReallocation().

npfnFree

public static VkFreeFunction npfnFree(long struct)

Unsafe version of pfnFree().

npfnInternalAllocation

@Nullable
public static VkInternalAllocationNotification npfnInternalAllocation(long struct)

Unsafe version of pfnInternalAllocation().

npfnInternalFree

@Nullable
public static VkInternalFreeNotification npfnInternalFree(long struct)

Unsafe version of pfnInternalFree().

npUserData

public static void npUserData(long struct,
                              long value)

Unsafe version of pUserData.

npfnAllocation

public static void npfnAllocation(long struct,
                                  VkAllocationFunctionI value)

Unsafe version of pfnAllocation.

npfnReallocation

public static void npfnReallocation(long struct,
                                    VkReallocationFunctionI value)

Unsafe version of pfnReallocation.

npfnFree

public static void npfnFree(long struct,
                            VkFreeFunctionI value)

Unsafe version of pfnFree.

npfnInternalAllocation

public static void npfnInternalAllocation(long struct,
                                          @Nullable
                                          VkInternalAllocationNotificationI value)

Unsafe version of pfnInternalAllocation.

npfnInternalFree

public static void npfnInternalFree(long struct,
                                    @Nullable
                                    VkInternalFreeNotificationI value)

Unsafe version of pfnInternalFree.

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 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

See Also

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

ALIGNOF

PUSERDATA

PFNALLOCATION

PFNREALLOCATION

PFNFREE

PFNINTERNALALLOCATION

PFNINTERNALFREE

Constructor Detail

VkAllocationCallbacks

Method Detail

sizeof

pUserData

pfnAllocation

pfnReallocation

pfnFree

pfnInternalAllocation

pfnInternalFree

pUserData

pfnAllocation

pfnReallocation

pfnFree

pfnInternalAllocation

pfnInternalFree

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

npUserData

npfnAllocation

npfnReallocation

npfnFree

npfnInternalAllocation

npfnInternalFree

npUserData

npfnAllocation

npfnReallocation

npfnFree

npfnInternalAllocation

npfnInternalFree

validate

validate