The type of pfnAllocation is:
typedef void* (VKAPI_PTR *PFN_vkAllocationFunction)(
void* pUserData,
size_t size,
size_t alignment,
VkSystemAllocationScope allocationScope);If pfnAllocation is unable to allocate the requested memory, it must return NULL. If the allocation was successful, it must return a valid pointer to memory allocation containing at least size bytes, and with the pointer value being a multiple of alignment.
Correct Vulkan operation cannot be assumed if the application does not follow these rules.
For example, pfnAllocation (or pfnReallocation) could cause termination of running Vulkan instance(s) on a failed allocation for debugging purposes, either directly or indirectly. In these circumstances, it cannot be assumed that any part of any affected VkInstance objects are going to operate correctly (even DestroyInstance), and the application must ensure it cleans up properly via other means (e.g. process termination).
If pfnAllocation returns NULL, and if the implementation is unable to continue correct processing of the current command without the requested allocation, it must treat this as a runtime error, and generate ERROR_OUT_OF_HOST_MEMORY at the appropriate time for the command in which the condition was detected, as described in Return Codes.
If the implementation is able to continue correct processing of the current command without the requested allocation, then it may do so, and must not generate ERROR_OUT_OF_HOST_MEMORY as a result of this failed allocation.
| Modifier and Type | Class and Description |
|---|---|
| private static class |
| Access | Constructor and Description |
|---|---|
| protected | |
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public static VkAllocationFunction | Returns: the newVkAllocationFunctionCreates a |
| public static VkAllocationFunction | create(VkAllocationFunctionI instance)
Creates a |
| public static VkAllocationFunction |
| VkAllocationFunction | back to summary |
|---|---|
| protected VkAllocationFunction() | |
| VkAllocationFunction | back to summary |
|---|---|
| pack-priv VkAllocationFunction(long functionPointer) | |
| create | back to summary |
|---|---|
| public static VkAllocationFunction create(long functionPointer) Creates a
| |
| create | back to summary |
|---|---|
| public static VkAllocationFunction create(VkAllocationFunctionI instance) Creates a | |
| createSafe | back to summary |
|---|---|
| public static VkAllocationFunction createSafe(long functionPointer) Like
| |
| Modifier and Type | Field and Description |
|---|---|
| private final VkAllocationFunctionI |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public long | invoke(long
the value specified for pUserData, long VkAllocationCallbacks::pUserData in the allocator specified by the application.the size in bytes of the requested allocation. size, long the requested alignment of the allocation in bytes and must be a power of two. alignment, int a allocationScope)VkSystemAllocationScope value specifying the allocation scope of the lifetime of the allocation, as described here.Implements org. |
| delegate | back to summary |
|---|---|
| private final VkAllocationFunctionI delegate | |
| Container | back to summary |
|---|---|
| pack-priv Container(long functionPointer, VkAllocationFunctionI delegate) | |
| invoke | back to summary |
|---|---|
| public long invoke(long pUserData, long size, long alignment, int allocationScope) Implements org. Doc from org. Application-defined memory allocation function.
| |