Interface VkReallocationFunctionI
- All Known Implementing Classes:
VkReallocationFunction
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
C Specification
The type of pfnReallocation
is:
typedef void* (VKAPI_PTR *PFN_vkReallocationFunction)(
void* pUserData,
void* pOriginal,
size_t size,
size_t alignment,
VkSystemAllocationScope allocationScope);
Description
If the reallocation was successful, pfnReallocation
must return an allocation with enough space for size
bytes, and the contents of the original allocation from bytes zero to min(original size, new size) - 1
must be preserved in the returned allocation. If size
is larger than the old size, the contents of the additional space are undefined. If satisfying these requirements involves creating a new allocation, then the old allocation should be freed.
If pOriginal
is NULL
, then pfnReallocation
must behave equivalently to a call to VkAllocationFunction
with the same parameter values (without pOriginal
).
If size
is zero, then pfnReallocation
must behave equivalently to a call to VkFreeFunction
with the same pUserData
parameter value, and pMemory
equal to pOriginal
.
If pOriginal
is non-NULL
, the implementation must ensure that alignment
is equal to the alignment
used to originally allocate pOriginal
.
If this function fails and pOriginal
is non-NULL
the application must not free the old allocation.
pfnReallocation
must follow the same rules for return values as PFN_vkAllocationFunction
.
See Also
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
callback
(long ret, long args) The Java method that will be called from native code when the native callback function is invoked.default FFICIF
Returns the libffi Call Interface for this callback function.long
invoke
(long pUserData, long pOriginal, long size, long alignment, int allocationScope) Application-defined memory reallocation function.
-
Field Details
-
CIF
-
-
Method Details
-
getCallInterface
Description copied from interface:CallbackI
Returns the libffi Call Interface for this callback function. [INTERNAL API]- Specified by:
getCallInterface
in interfaceCallbackI
- Returns:
- the CIF structure for this callback function
-
callback
default void callback(long ret, long args) Description copied from interface:CallbackI
The Java method that will be called from native code when the native callback function is invoked.- Specified by:
callback
in interfaceCallbackI
- Parameters:
ret
- a pointer to the memory used for the function's return value.If the function is declared as returning
void
, then this value is garbage and should not be used.Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as
LibFFI.ffi_call(org.lwjgl.system.libffi.FFICIF, long, java.nio.ByteBuffer, org.lwjgl.PointerBuffer)
. That is, in most cases,ret
points to an object of exactly the size of the type specified whenCIF
was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume thatret
points to anffi_arg
object.args
- a vector of pointers to memory holding the arguments to the function
-
invoke
long invoke(long pUserData, long pOriginal, long size, long alignment, int allocationScope) Application-defined memory reallocation function.- Parameters:
pUserData
- the value specified forVkAllocationCallbacks
::pUserData
in the allocator specified by the application.pOriginal
- must be eitherNULL
or a pointer previously returned bypfnReallocation
orpfnAllocation
of a compatible allocator.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.
-