Top Description Fields Methods
org.lwjgl.vulkan

public Interface VkReallocationFunctionI

extends CallbackI
Known Direct Implementers
org.lwjgl.vulkan.VkReallocationFunction
Annotations
@FunctionalInterface
@NativeType:PFN_vkReallocationFunction
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Application-defined memory reallocation function.
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

VkAllocationCallbacks

Field Summary

Modifier and TypeField and Description
public static final FFICIF
CIF

Method Summary

Modifier and TypeMethod and Description
public default void
callback(long
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. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

ret, long
a vector of pointers to memory holding the arguments to the function
args)

Implements org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.
public default FFICIF
getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function.
public long
invoke(long
the value specified for VkAllocationCallbacks::pUserData in the allocator specified by the application.
pUserData, long
must be either NULL or a pointer previously returned by pfnReallocation or pfnAllocation of a compatible allocator.
pOriginal, long
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 VkSystemAllocationScope value specifying the allocation scope of the lifetime of the allocation, as described here.
allocationScope)

Application-defined memory reallocation function.

Inherited from org.lwjgl.system.CallbackI:
address

Field Detail

CIFback to summary
public static final FFICIF CIF

Method Detail

callbackback to summary
public default void callback(long ret, long args)

Implements org.lwjgl.system.CallbackI.callback.

Doc from org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.

Parameters
ret:long

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. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

args:long

a vector of pointers to memory holding the arguments to the function

Annotations
@Override
getCallInterfaceback to summary
public default FFICIF getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Doc from org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function. [INTERNAL API]

Returns:FFICIF

the CIF structure for this callback function

Annotations
@Override
invokeback to summary
public long invoke(long pUserData, long pOriginal, long size, long alignment, int allocationScope)

Application-defined memory reallocation function.

Parameters
pUserData:long

the value specified for VkAllocationCallbacks::pUserData in the allocator specified by the application.

pOriginal:long

must be either NULL or a pointer previously returned by pfnReallocation or pfnAllocation of a compatible allocator.

size:long

the size in bytes of the requested allocation.

alignment:long

the requested alignment of the allocation in bytes and must be a power of two.

allocationScope:int

a VkSystemAllocationScope value specifying the allocation scope of the lifetime of the allocation, as described here.

Annotations
@NativeType:void *