LWJGL 3.3.3 · org.lwjgl.vulkan.VkFreeFunctionI

Application-defined memory free function.

C Specification

The type of pfnFree is:


typedef void (VKAPI_PTR *PFN_vkFreeFunction)(
    void*                                       pUserData,
    void*                                       pMemory);

Description

pMemory may be NULL, which the callback must handle safely. If pMemory is non-NULL, it must be a pointer previously allocated by pfnAllocation or pfnReallocation. The application should free this memory.

Field Summary

Modifier and Type	Field and Description
public static final FFICIF	CIF

Method Summary

Modifier and Type	Method 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 void	invoke(long the value specified for `VkAllocationCallbacks::pUserData` in the allocator specified by the application. pUserData, long the allocation to be freed. pMemory) Application-defined memory free function.

Inherited from org.lwjgl.system.CallbackI:: address

Field Detail

CIF	back to summary
public static final FFICIF CIF

Method Detail

callback back to summary

callback	back 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

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

getCallInterface	back 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

getCallInterface

back 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

invoke back to summary

invoke	back to summary
public void invoke(long pUserData, long pMemory) Application-defined memory free function. Parameters pUserData:long the value specified for `VkAllocationCallbacks::pUserData` in the allocator specified by the application. pMemory:long the allocation to be freed.

public void invoke(long pUserData, long pMemory)