Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

gldebugmessagecallback(3g) [centos man page]

GLDEBUGMESSAGECALLBA(3G)					   OpenGL Manual					  GLDEBUGMESSAGECALLBA(3G)

NAME

       glDebugMessageCallback - specify a callback to receive debugging messages from the GL

C SPECIFICATION

       void glDebugMessageCallback(DEBUGPROC callback, void * userParam);

PARAMETERS

       callback
	   The address of a callback function that will be called when a debug message is generated.

       userParam
	   A user supplied pointer that will be passed on each invocation of callback.

DESCRIPTION

       glDebugMessageInsert sets the current debug output callback function to the function whose address is given in callback. The callback
       function should have the following prototype (in C), or be otherwise compatible with such a prototype:

		   typedef void (APIENTRY *DEBUGPROC)(GLenum source,
						      GLenum type,
						      GLuint id,
						      GLenum severity,
						      GLsizei length,
						      const GLchar* message,
						      void* userParam);

       This function is defined to have the same calling convention as the GL API functions. In most cases this is defined as APIENTRY, although
       it will vary depending on platform, language and compiler.

       Each time a debug message is generated the debug callback function will be invoked with source, type, id, and severity associated with the
       message, and length set to the length of debug message whose character string is in the array pointed to by messageuserParam will be set to
       the value passed in the userParam parameter to the most recent call to glDebugMessageInsert.

NOTES

       When the GL is in use remotely, the server may not be able to call functions in the client's address space. In such cases, the callback
       function may not be invoked and the user should retrieve debug messages from the context's debug message log by calling
       glGetDebugMessageLog().

SEE ALSO

       glDebugMessageControl(), glDebugMessageInsert(), glGetDebugMessageLog().

COPYRIGHT

       Copyright (C) 2012 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication
       License, v 1.0, 8 June 1999.  http://opencontent.org/openpub/.

AUTHORS

       opengl.org

opengl.org							    06/10/2014						  GLDEBUGMESSAGECALLBA(3G)

Check Out this Related Man Page

GLPUSHDEBUGGROUP(3G)						   OpenGL Manual					      GLPUSHDEBUGGROUP(3G)

NAME

       glPushDebugGroup - push a named debug group into the command stream

C SPECIFICATION

       void glPushDebugGroup(GLenum source, GLuint id, GLsizei length, const char * message);

PARAMETERS

       source
	   The source of the debug message.

       id
	   The identifier of the message.

       length
	   The length of the message to be sent to the debug output stream.

       message
	   The a string containing the message to be sent to the debug output stream.

DESCRIPTION

       glPushDebugGroup pushes a debug group described by the string message into the command stream. The value of id specifies the ID of messages
       generated. The parameter length contains the number of characters in message. If length is negative, it is implied that message contains a
       null terminated string. The message has the specified source and id, the typeGL_DEBUG_TYPE_PUSH_GROUP, and
       severityGL_DEBUG_SEVERITY_NOTIFICATION. The GL will put a new debug group on top of the debug group stack which inherits the control of the
       volume of debug output of the debug group previously residing on the top of the debug group stack. Because debug groups are strictly
       hierarchical, any additional control of the debug output volume will only apply within the active debug group and the debug groups pushed
       on top of the active debug group.

ERRORS

       GL_INVALID_ENUM is generated if the value of source is neither GL_DEBUG_SOURCE_APPLICATION nor GL_DEBUG_SOURCE_THIRD_PARTY.

       GL_INVALID_VALUE is generated if length is negative and the number of characters in message, excluding the null-terminator, is not less
       than the value of GL_MAX_DEBUG_MESSAGE_LENGTH.

ASSOCIATED GETS

       glGet() with argument GL_MAX_DEBUG_MESSAGE_LENGTH.

SEE ALSO

       glPopDebugGroup(), glObjectLabel(), glObjectPtrLabel().

COPYRIGHT

       Copyright (C) 2012 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication
       License, v 1.0, 8 June 1999.  http://opencontent.org/openpub/.

AUTHORS

       opengl.org

opengl.org							    06/10/2014						      GLPUSHDEBUGGROUP(3G)
Man Page