Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

glgetdebugmessagelog(3g) [centos man page]

GLGETDEBUGMESSAGELOG(3G)					   OpenGL Manual					  GLGETDEBUGMESSAGELOG(3G)

NAME

       glGetDebugMessageLog - retrieve messages from the debug message log

C SPECIFICATION

       GLuint glGetDebugMessageLog(GLuint count, GLsizei bufSize, GLenum *sources, Glenum *types, GLuint *ids, GLenum *severities,
				   GLsizei *lengths, GLchar *messageLog);

PARAMETERS

       count
	   The number of debug messages to retrieve from the log.

       bufSize
	   The size of the buffer whose address is given by messageLog.

       sources
	   The address of an array of variables to receive the sources of the retrieved messages.

       types
	   The address of an array of variables to receive the types of the retrieved messages.

       ids
	   The address of an array of unsigned integers to receive the ids of the retrieved messages.

       severities
	   The address of an array of variables to receive the severites of the retrieved messages.

       lengths
	   The address of an array of variables to receive the lengths of the received messages.

       messageLog
	   The address of an array of characters that will receive the messages.

DESCRIPTION

       glGetDebugMessageLog retrieves messages from the debug message log. A maximum of count messages are retrieved from the log. If sources is
       not NULL then the source of each message is written into up to count elements of the array. If types is not NULL then the type of each
       message is written into up to count elements of the array. If id is not NULL then the identifier of each message is written into up to
       count elements of the array. If severities is not NULL then the severity of each message is written into up to count elements of the array.
       If lengths is not NULL then the length of each message is written into up to count elements of the array.

       messageLog specifies the address of a character array into which the debug messages will be written. Each message will be concatenated onto
       the array starting at the first element of messageLog.  bufSize specifies the size of the array messageLog. If a message will not fit into
       the remaining space in messageLog then the function terminates and returns the number of messages written so far, which may be zero.

       If glGetDebugMessageLog returns zero then no messages are present in the debug log, or there was not enough space in messageLog to retrieve
       the first message in the queue. If messageLog is NULL then no messages are written and the value of bufSize is ignored.

NOTES

       Although debug messages may be enabled in a non-debug context, the quantity and detail of such messages may be substantially inferior to
       those in a debug context. In particular, a valid implementation of the debug message queue in a non-debug context may produce no messages
       at all.

ERRORS

       GL_INVALID_VALUE is generated if count or bufSize is negative.

ASSOCIATED GETS

       glGet() with argument GL_DEBUG_LOGGED_MESSAGES

       glGet() with argument GL_DEBUG_NEXT_LOGGED_MESSAGE_LENGTH

       glGet() with argument GL_MAX_DEBUG_MESSAGE_LENGTH

       glGet() with argument GL_MAX_DEBUG_LOGGED_MESSAGES

SEE ALSO

       glDebugMessageInsert(), glDebugMessageCallback(), glDebugMessageControl().

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						  GLGETDEBUGMESSAGELOG(3G)

Check Out this Related Man Page

GLGETOBJECTPTRLABEL(3G) 					   OpenGL Manual					   GLGETOBJECTPTRLABEL(3G)

NAME

       glGetObjectPtrLabel - retrieve the label of a sync object identified by a pointer

C SPECIFICATION

       void glGetObjectPtrLabel(void * ptr, GLsizei bifSize, GLsizei * length, char * label);

PARAMETERS

       ptr
	   The name of the sync object whose label to retrieve.

       bufSize
	   The length of the buffer whose address is in label.

       length
	   The address of a variable to receive the length of the object label.

       label
	   The address of a string that will receive the object label.

DESCRIPTION

       glGetObjectPtrLabel retrieves the label of the sync object identified by ptr.

       label is the address of a string that will be used to store the object label.  bufSize specifies the number of characters in the array
       identified by label.  length contains the address of a variable which will receive the the number of characters in the object label. If
       length is NULL, then it is ignored and no data is written. Likewise, if label is NULL, or if bufSize is zero then no data is written to
       label.

ERRORS

       GL_INVALID_ENUM is generated if identifier is not one of the accepted object types.

       GL_INVALID_VALUE is generated if ptr is not the name of an existing sync object.

       GL_INVALID_VALUE is generated if bufSize is zero.

       If not NULL, length and label should be addresses to which the client has write access, otherwise undefined behavior, including process
       termination may occur.

ASSOCIATED GETS

       glGet() with argument GL_MAX_LABEL_LENGTH.

SEE ALSO

       glPushDebugGroup(), glPopDebugGroup(), glObjectLabel(), glGetObjectLabel().

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						   GLGETOBJECTPTRLABEL(3G)
Man Page