The GLDebugMessageHandler, handling GL_ARB_debug_output or GL_AMD_debug_output debug messages.

An instance must be bound to the current thread's GLContext to achieve thread safety.

A native callback function is registered at enable(true), which forwards received messages to the added GLDebugListener directly. Hence the GLDebugListener#messageSent(GLDebugMessage) implementation shall return as fast as possible.

In case no GL_ARB_debug_output is available, but GL_AMD_debug_output, the messages are translated to ARB GLDebugMessage, using GLDebugMessage#translateAMDEvent(com.jogamp.opengl.GLContext, long, int, int, int, String).

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	GLDebugMessageHandler.StdErrGLDebugListener

Field Summary

Modifier and Type	Field and Description
private final GLContextImpl	ctx
private static final boolean	DEBUG
private static final int	EXT_AMD
private static final int	EXT_ARB
private static final int	EXT_KHR
private boolean	extAvailable
private String	extName
private String	extSuffix
private int	extType
private long	glDebugMessageCallbackProcAddress
private long	handle
private final ListenerSyncedImplStub<GLDebugListener>	listenerImpl
private boolean	synchronous

Constructor Summary

Access	Constructor and Description
public	GLDebugMessageHandler(final GLContextImpl the associated GLContext ctx)

Method Summary

Modifier and Type	Method and Description
public final void	addListener(final GLDebugListener listener)
public final void	addListener(final int index, final GLDebugListener listener)
public final void	enable(final boolean enable)
pack-priv final void	enableImpl(final boolean enable)
private final long	getAddressFor(final ProcAddressTable table, final String functionName)
public final String	Returns: The extension implementing the GLDebugMessage feature, either `GL_ARB_debug_output` or `GL_AMD_debug_output`. If unavailable null is returned. getExtension()
protected final void	glDebugMessageAMD(final int id, final int category, final int severity, final String msg)
protected final void	glDebugMessageARB(final int source, final int type, final int id, final int severity, final String msg)
public void	init(final boolean enable)
public void	init()
private static native boolean	initIDs0()
public final boolean	isAvailable()
public final boolean	isEnabled()
public final boolean	isExtensionAMD()
public final boolean	isExtensionARB()
public final boolean	isExtensionKHR()
public final boolean	isExtensionKHRARB()
public final boolean	isSynchronous()
public final int	listenerSize()
private native long	register0(long glDebugMessageCallbackProcAddress, int extType)
public final void	removeListener(final GLDebugListener listener)
private final void	sendMessage(final GLDebugMessage msg)
public final void	setSynchronous(final boolean synchronous)
private final void	setSynchronousImpl()
private native void	unregister0(long glDebugMessageCallbackProcAddress, long handle)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ctx	back to summary
private final GLContextImpl ctx

DEBUG	back to summary
private static final boolean DEBUG

EXT_AMD	back to summary
private static final int EXT_AMD

EXT_ARB	back to summary
private static final int EXT_ARB

EXT_KHR	back to summary
private static final int EXT_KHR

extAvailable	back to summary
private boolean extAvailable

extName	back to summary
private String extName

extSuffix	back to summary
private String extSuffix

extType	back to summary
private int extType

glDebugMessageCallbackProcAddress	back to summary
private long glDebugMessageCallbackProcAddress

handle	back to summary
private long handle

listenerImpl	back to summary
private final ListenerSyncedImplStub<GLDebugListener> listenerImpl

synchronous	back to summary
private boolean synchronous

Constructor Detail

GLDebugMessageHandler	back to summary
public GLDebugMessageHandler(final GLContextImpl ctx) Parameters ctx:GLContextImpl the associated GLContext

Method Detail

addListener	back to summary
public final void addListener(final GLDebugListener listener)

addListener	back to summary
public final void addListener(final int index, final GLDebugListener listener)

enable	back to summary
public final void enable(final boolean enable) throws GLException See Also `com.jogamp.opengl.GLContext#enableGLDebugMessage(boolean)`

enableImpl	back to summary
pack-priv final void enableImpl(final boolean enable) throws GLException

getAddressFor	back to summary
private final long getAddressFor(final ProcAddressTable table, final String functionName)

getExtension	back to summary
public final String getExtension() Returns:String The extension implementing the GLDebugMessage feature, either `GL_ARB_debug_output` or `GL_AMD_debug_output`. If unavailable null is returned.

glDebugMessageAMD	back to summary
protected final void glDebugMessageAMD(final int id, final int category, final int severity, final String msg)

glDebugMessageARB	back to summary
protected final void glDebugMessageARB(final int source, final int type, final int id, final int severity, final String msg)

init	back to summary
public void init(final boolean enable)

init	back to summary
public void init()

initIDs0	back to summary
private static native boolean initIDs0()

isAvailable	back to summary
public final boolean isAvailable()

isEnabled	back to summary
public final boolean isEnabled()

isExtensionAMD	back to summary
public final boolean isExtensionAMD()

isExtensionARB	back to summary
public final boolean isExtensionARB()

isExtensionKHR	back to summary
public final boolean isExtensionKHR()

isExtensionKHRARB	back to summary
public final boolean isExtensionKHRARB()

isSynchronous	back to summary
public final boolean isSynchronous() See Also `com.jogamp.opengl.GLContext#isGLDebugSynchronous()`

listenerSize	back to summary
public final int listenerSize()

register0	back to summary
private native long register0(long glDebugMessageCallbackProcAddress, int extType)

removeListener	back to summary
public final void removeListener(final GLDebugListener listener)

sendMessage	back to summary
private final void sendMessage(final GLDebugMessage msg)

setSynchronous	back to summary
public final void setSynchronous(final boolean synchronous) See Also `com.jogamp.opengl.GLContext#setGLDebugSynchronous(boolean)`

setSynchronousImpl	back to summary
private final void setSynchronousImpl()

unregister0	back to summary
private native void unregister0(long glDebugMessageCallbackProcAddress, long handle)

jogamp.opengl back to summary

public Class GLDebugMessageHandler.StdErrGLDebugListener

Class Inheritance

extends Object
implements GLDebugListener

java.lang.Object
jogamp.opengl.GLDebugMessageHandler.StdErrGLDebugListener

All Implemented Interfaces

com.jogamp.opengl.GLDebugListener

Field Summary

Modifier and Type	Field and Description
pack-priv boolean	threadDump

Constructor Summary

Access	Constructor and Description
public	StdErrGLDebugListener(final boolean threadDump)

Method Summary

Modifier and Type	Method and Description
public void	messageSent(final GLDebugMessage event) Implements com.jogamp.opengl.GLDebugListener.messageSent. Handle `GLDebugMessage` message sent from native GL implementation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

threadDump	back to summary
pack-priv boolean threadDump

Constructor Detail

StdErrGLDebugListener	back to summary
public StdErrGLDebugListener(final boolean threadDump)

Method Detail

messageSent back to summary

messageSent	back to summary
public void messageSent(final GLDebugMessage event) Implements com.jogamp.opengl.GLDebugListener.messageSent. Doc from com.jogamp.opengl.GLDebugListener.messageSent. Handle `GLDebugMessage` message sent from native GL implementation. Since this method is invoked directly by the GL implementation, it shall return as fast as possible. Annotations @Override

public void messageSent(final GLDebugMessage event)

Implements com.jogamp.opengl.GLDebugListener.messageSent.

Doc from com.jogamp.opengl.GLDebugListener.messageSent.

Handle GLDebugMessage message sent from native GL implementation.

Since this method is invoked directly by the GL implementation, it shall return as fast as possible.

Annotations

@Override