GLAPI/glDebugMessageControl

From OpenGL.org
< GLAPI
Revision as of 21:42, 26 September 2012 by AlfonsesCategoryBot (Talk | contribs) (Bot: Adding better formatting.)

Jump to: navigation, search
glDebugMessageControl
Core in version 4.5
Core since version 4.3
Core ARB extension KHR_debug

glDebugMessageControl: control the reporting of debug messages in a debug context

Function Definition

 void glDebugMessageControl(GLenum source​, GLenum type​, GLenum severity​, GLsizei count​, const GLuint *ids​, GLboolean enabled​);
source
The source of debug messages to enable or disable.
type
The type of debug messages to enable or disable.
severity
The severity of debug messages to enable or disable.
count
The length of the array ids​.
ids
The address of an array of unsigned integers contianing the ids of the messages to enable or disable.
enabled
A Boolean flag determining whether the selected messages should be enabled or disabled.

Description

glDebugMessageControl controls the reporting of debug messages generated by a debug context. The parameters source​, type​ and severity​ form a filter to select messages from the pool of potential messages generated by the GL.

source​ may be GL_DEBUG_SOURCE_API, GL_DEBUG_SOURCE_WINDOW_SYSTEM_, GL_DEBUG_SOURCE_SHADER_COMPILER, GL_DEBUG_SOURCE_THIRD_PARTY, GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_SOURCE_OTHER to select messages generated by usage of the GL API, the window system, the shader compiler, third party tools or libraries, explicitly by the application or by some other source, respectively. It may also take the value GL_DONT_CARE. If source​ is not GL_DONT_CARE then only messages whose source matches source​ will be referenced.

type​ may be one of GL_DEBUG_TYPE_ERROR, GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR, GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR, GL_DEBUG_TYPE_PORTABILITY, GL_DEBUG_TYPE_PERFORMANCE, GL_DEBUG_TYPE_OTHER to indicate the type of messages describing GL errors, attempted use of deprecated features, triggering of undefined behavior, portability issues, performance notifications and other types of messages. It may also take the value GL_DONT_CARE. If type​ is not GL_DONT_CARE then only messages whose type matches type​ will be referenced.

severity​ may be one of GL_DEBUG_SEVERITY_LOW, GL_DEBUG_SEVERITY_MEDIUM, or GL_DEBUG_SEVERITY_HIGH to select messages of low, medium or high severity messages. It may also take the value GL_DONT_CARE. If severity​ is not GL_DONT_CARE then only messages whose severity matches severity​ will be referenced.

ids​ contains a list of count​ message identifiers to select specific messages from the pool of available messages. If count​ is zero then the value of ids​ is ignored. Otherwise, only messages appearing in this list are selected. In this case, source​ and type​ may not be GL_DONT_CARE and severity​ must be GL_DONT_CARE.

If enabled​ is GL_TRUE then messages that match the filter formed by source​, type​, severity​ and ids​ are enabled. Otherwise, those messages are disabled.

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​ is negative.

GL_INVALID_ENUM is generated if any of source​, type​ or severity​ is not one of the accepted interface types.

GL_INVALID_OPERATION is generated if count​ is non-zero and either source​ or type​ is GL_DONT_CARE or if severity​ is not GL_DONT_CARE.

See Also

glDebugMessageInsert, glDebugMessageCallback, glGetDebugMessageLog, glPushDebugGroup, glPopDebugGroup

Copyright

Copyright © 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/.