Top Description Fields Methods
org.lwjgl.egl

public Interface EGLDebugMessageKHRCallbackI

extends CallbackI
Known Direct Implementers
org.lwjgl.egl.EGLDebugMessageKHRCallback
Annotations
@FunctionalInterface
@NativeType:EGLDEBUGPROCKHR
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Instances of this interface may be passed to the DebugMessageControlKHR method.

Type


void (*invoke) (
    EGLenum error,
    char const *command,
    EGLint messageType,
    EGLLabelKHR threadLabel,
    EGLLabelKHR objectLabel,
    char const *message
)

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(int
will contain an EGL error code, or SUCCESS, as applicable
error, long
will contain a pointer to a string. Example "eglBindApi".
command, int
will contain one of the debug message types
messageType, long
will contain the label attached to the current thread. The threadLabel will be NULL if not set by the application. If the message is from an internal thread, the label will be NULL.
threadLabel, long
will contain the label attached to the primary object of the message; Labels will be NULL if not set by the application. The primary object should be the object the function operates on, see table 13.2 which provides the recommended mapping between functions and their primary object. This objectLabel may be NULL even though the application labeled the object. This is because it is possible an error was raised while executing the command before the primary object was validated, therefore its label can not be included in the callback.
objectLabel, long
will contain a platform specific debug string message; This string should provide added information to the application developer regarding the condition that generated the message. The format of a message is implementation-defined, although it should represent a concise description of the event that caused the message to be generated. Message strings can be NULL and should not be assumed otherwise.
message)

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(int error, long command, int messageType, long threadLabel, long objectLabel, long message)

Will be called when a debug message is generated.

Parameters
error:int

will contain an EGL error code, or SUCCESS, as applicable

command:long

will contain a pointer to a string. Example "eglBindApi".

messageType:int

will contain one of the debug message types

threadLabel:long

will contain the label attached to the current thread. The threadLabel will be NULL if not set by the application. If the message is from an internal thread, the label will be NULL.

objectLabel:long

will contain the label attached to the primary object of the message; Labels will be NULL if not set by the application. The primary object should be the object the function operates on, see table 13.2 which provides the recommended mapping between functions and their primary object. This objectLabel may be NULL even though the application labeled the object. This is because it is possible an error was raised while executing the command before the primary object was validated, therefore its label can not be included in the callback.

message:long

will contain a platform specific debug string message; This string should provide added information to the application developer regarding the condition that generated the message. The format of a message is implementation-defined, although it should represent a concise description of the event that caused the message to be generated. Message strings can be NULL and should not be assumed otherwise.