Top Description Fields Methods
org.lwjgl.opencl

public Interface CLContextCallbackI

extends CallbackI
Known Direct Implementers
org.lwjgl.opencl.CLContextCallback
Annotations
@FunctionalInterface
@NativeType:void (*) (cl_char const *, void const *, size_t, void *)
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Instances of this interface may be passed to the CreateContext and CreateContextFromType methods.

Type


void (*invoke) (
    cl_char const *errinfo,
    void const *private_info,
    size_t cb,
    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 pointer to the message string representation
errinfo, long
a pointer to binary data that is returned by the OpenCL implementation that can be used to log additional information helpful in debugging the error
private_info, long
the number of bytes in the private_info pointer
cb, long
the user-specified value that was passed when calling CreateContext or CreateContextFromType
user_data)

Will be called when a debug message is generated.

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 errinfo, long private_info, long cb, long user_data)

Will be called when a debug message is generated.

Parameters
errinfo:long

a pointer to the message string representation

private_info:long

a pointer to binary data that is returned by the OpenCL implementation that can be used to log additional information helpful in debugging the error

cb:long

the number of bytes in the private_info pointer

user_data:long

the user-specified value that was passed when calling CreateContext or CreateContextFromType