Top Description Fields Methods
org.lwjgl.glfw

public Interface GLFWReallocateCallbackI

extends CallbackI
Known Direct Implementers
org.lwjgl.glfw.GLFWReallocateCallback
Annotations
@FunctionalInterface
@NativeType:GLFWreallocatefun
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
The function pointer type for memory reallocation callbacks.

This is the function pointer type for memory reallocation callbacks. A memory reallocation callback function has the following signature:


void* function_name(void* block, size_t size, void* user)

This function must return a memory block at least size bytes long, or NULL if allocation failed. Note that not all parts of GLFW handle allocation failures gracefully yet.

This function may be called during Init but before the library is flagged as initialized, as well as during Terminate after the library is no longer flagged as initialized.

Any memory allocated by this function will be deallocated during library termination or earlier.

The block address will never be NULL and the size will always be greater than zero. Reallocations of a block to size zero are converted into deallocations. Reallocations of NULL to a non-zero size are converted into regular allocations.

Note

Type


void * (*invoke) (
    void *block,
    size_t size,
    void *user
)
Since
version 3.4

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

Returns:

the address of the newly allocated or resized memory block, or NULL if an error occurred
invoke(long
the address of the memory block to reallocate
block, long
the new minimum size, in bytes, of the memory block
size, long
the user-defined pointer from the allocator
user)

Will be called for memory reallocation requests.

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 block, long size, long user)

Will be called for memory reallocation requests.

Parameters
block:long

the address of the memory block to reallocate

size:long

the new minimum size, in bytes, of the memory block

user:long

the user-defined pointer from the allocator

Returns:long

the address of the newly allocated or resized memory block, or NULL if an error occurred

Annotations
@NativeType:void *