Interface VkAllocationFunctionI
-
- All Superinterfaces:
org.lwjgl.system.CallbackI
,org.lwjgl.system.CallbackI.P
,org.lwjgl.system.Pointer
- All Known Implementing Classes:
VkAllocationFunction
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface VkAllocationFunctionI extends org.lwjgl.system.CallbackI.P
Application-defined memory allocation function.C Specification
The type of
pfnAllocation
is:typedef void* (VKAPI_PTR *PFN_vkAllocationFunction)( void* pUserData, size_t size, size_t alignment, VkSystemAllocationScope allocationScope);
Description
If
pfnAllocation
is unable to allocate the requested memory, it must returnNULL
. If the allocation was successful, it must return a valid pointer to memory allocation containing at leastsize
bytes, and with the pointer value being a multiple ofalignment
.Note
Correct Vulkan operation cannot be assumed if the application does not follow these rules.
For example,
pfnAllocation
(orpfnReallocation
) 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 affectedVkInstance
objects are going to operate correctly (evenDestroyInstance
), and the application must ensure it cleans up properly via other means (e.g. process termination).If
pfnAllocation
returnsNULL
, and if the implementation is unable to continue correct processing of the current command without the requested allocation, it must treat this as a run-time error, and generateERROR_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.See Also
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.lwjgl.system.CallbackI
org.lwjgl.system.CallbackI.B, org.lwjgl.system.CallbackI.D, org.lwjgl.system.CallbackI.F, org.lwjgl.system.CallbackI.I, org.lwjgl.system.CallbackI.J, org.lwjgl.system.CallbackI.N, org.lwjgl.system.CallbackI.P, org.lwjgl.system.CallbackI.S, org.lwjgl.system.CallbackI.V, org.lwjgl.system.CallbackI.Z
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SIGNATURE
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default long
callback(long args)
default java.lang.String
getSignature()
long
invoke(long pUserData, long size, long alignment, int allocationScope)
Application-defined memory allocation function.
-
-
-
Method Detail
-
getSignature
default java.lang.String getSignature()
- Specified by:
getSignature
in interfaceorg.lwjgl.system.CallbackI
-
callback
default long callback(long args)
- Specified by:
callback
in interfaceorg.lwjgl.system.CallbackI.P
-
invoke
long invoke(long pUserData, long size, long alignment, int allocationScope)
Application-defined memory allocation function.- Parameters:
pUserData
- the value specified forVkAllocationCallbacks
::pUserData
in the allocator specified by the application.size
- the size in bytes of the requested allocation.alignment
- the requested alignment of the allocation in bytes and must be a power of two.allocationScope
- aVkSystemAllocationScope
value specifying the allocation scope of the lifetime of the allocation, as described here.
-
-