Top Description Fields Methods
org.lwjgl.opencl

public Interface CLSVMFreeCallbackI

extends CallbackI
Known Direct Implementers
org.lwjgl.opencl.CLSVMFreeCallback
Annotations
@FunctionalInterface
@NativeType:void (*) (cl_command_queue, cl_uint, void **, void *)
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Instances of this interface may be passed to the EnqueueSVMFree method.

Type


void (*invoke) (
    cl_command_queue queue,
    cl_uint num_svm_pointers,
    void **svm_pointers,
    void *user_data
)

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 void
invoke(long
a valid host command-queue
queue, int
the number of pointers in the svm_pointers array
num_svm_pointers, long
an array of shared virtual memory pointers to be freed
svm_pointers, long
the user-specified value that was passed when calling EnqueueSVMFree
user_data)

Will be called to free shared virtual memory pointers.

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 void invoke(long queue, int num_svm_pointers, long svm_pointers, long user_data)

Will be called to free shared virtual memory pointers.

Parameters
queue:long

a valid host command-queue

num_svm_pointers:int

the number of pointers in the svm_pointers array

svm_pointers:long

an array of shared virtual memory pointers to be freed

user_data:long

the user-specified value that was passed when calling EnqueueSVMFree