Top Description Fields Methods
org.lwjgl.opencl

public Interface CLReportLiveObjectsAlteraCallbackI

extends CallbackI
Known Direct Implementers
org.lwjgl.opencl.CLReportLiveObjectsAlteraCallback
Annotations
@FunctionalInterface
@NativeType:void (*) (void *, void *, char const *, cl_uint)
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*

Instances of this interface may be passed to the ReportLiveObjectsAltera method.

Type


void (*invoke) (
    void *user_data,
    void *obj_ptr,
    char const *type_name,
    cl_uint refcount
)

Field Summary

Modifier and TypeField and Description
public static final FFICIF

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 user_data argument specified to ReportLiveObjectsAltera
user_data
,
long
a pointer to the live object
obj_ptr
,
long
a C string corresponding to the OpenCL API object type. For example, a leaked cl_mem object will have "cl_mem" as its type string.
type_name
,
int
an instantaneous reference count for the object. Consider it to be immediately stale.
refcount
)

Reports a live OpenCL API object.

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 user_data, long obj_ptr, long type_name, int refcount)

Reports a live OpenCL API object.

Parameters
user_data:long

the user_data argument specified to ReportLiveObjectsAltera

obj_ptr:long

a pointer to the live object

type_name:long

a C string corresponding to the OpenCL API object type. For example, a leaked cl_mem object will have "cl_mem" as its type string.

refcount:int

an instantaneous reference count for the object. Consider it to be immediately stale.