Top Description Fields Methods
org.lwjgl.opencl

public Interface CLEventCallbackI

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

Type


void (*invoke) (
    cl_event event,
    cl_int event_command_exec_status,
    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
the event
event, int
represents the execution status of command for which this callback function is invoked. If the callback is called as the result of the command associated with event being abnormally terminated, an appropriate error code for the error that caused the termination will be passed to event_command_exec_status instead.
event_command_exec_status, long
the user-specified value that was passed when calling SetEventCallback
user_data)

Will be called when the execution status of the command associated with event changes to an execution status equal or past the status specified by command_exec_status.

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 event, int event_command_exec_status, long user_data)

Will be called when the execution status of the command associated with event changes to an execution status equal or past the status specified by command_exec_status.

Parameters
event:long

the event

event_command_exec_status:int

represents the execution status of command for which this callback function is invoked. If the callback is called as the result of the command associated with event being abnormally terminated, an appropriate error code for the error that caused the termination will be passed to event_command_exec_status instead.

user_data:long

the user-specified value that was passed when calling SetEventCallback