Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
3 | <!-- saved from url=(0013)about:internet --> | |
4 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glDebugMessageControl - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glDebugMessageControl"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDebugMessageControl — control the reporting of debug messages in a debug context</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glDebugMessageControl</b>(</code></td><td>GLenum </td><td><var class="pdparam">source</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">severity</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>const GLuint * </td><td><var class="pdparam">ids</var>, </td></tr><tr><td> </td><td>GLboolean </td><td><var class="pdparam">enabled</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>source</code></em></span></dt><dd><p> | |
5 | The source of debug messages to enable or disable. | |
6 | </p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p> | |
7 | The type of debug messages to enable or disable. | |
8 | </p></dd><dt><span class="term"><em class="parameter"><code>severity</code></em></span></dt><dd><p> | |
9 | The severity of debug messages to enable or disable. | |
10 | </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p> | |
11 | The length of the array <em class="parameter"><code>ids</code></em>. | |
12 | </p></dd><dt><span class="term"><em class="parameter"><code>ids</code></em></span></dt><dd><p> | |
13 | The address of an array of unsigned integers contianing the ids of the messages to enable or disable. | |
14 | </p></dd><dt><span class="term"><em class="parameter"><code>enabled</code></em></span></dt><dd><p> | |
15 | A Boolean flag determining whether the selected messages should be enabled or disabled. | |
16 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
17 | <code class="function">glDebugMessageControl</code> controls the reporting of debug messages generated by a debug | |
18 | context. The parameters <em class="parameter"><code>source</code></em>, <em class="parameter"><code>type</code></em> and <em class="parameter"><code>severity</code></em> | |
19 | form a filter to select messages from the pool of potential messages generated by the GL. | |
20 | </p><p> | |
21 | <em class="parameter"><code>source</code></em> may be <code class="constant">GL_DEBUG_SOURCE_API</code>, <code class="constant">GL_DEBUG_SOURCE_WINDOW_SYSTEM_</code>, | |
22 | <code class="constant">GL_DEBUG_SOURCE_SHADER_COMPILER</code>, <code class="constant">GL_DEBUG_SOURCE_THIRD_PARTY</code>, | |
23 | <code class="constant">GL_DEBUG_SOURCE_APPLICATION</code>, <code class="constant">GL_DEBUG_SOURCE_OTHER</code> to select messages generated by | |
24 | usage of the GL API, the window system, the shader compiler, third party tools or libraries, explicitly by the application | |
25 | or by some other source, respectively. It may also take the value <code class="constant">GL_DONT_CARE</code>. If <em class="parameter"><code>source</code></em> | |
26 | is not <code class="constant">GL_DONT_CARE</code> then only messages whose source matches <em class="parameter"><code>source</code></em> will be referenced. | |
27 | </p><p> | |
28 | <em class="parameter"><code>type</code></em> may be one of <code class="constant">GL_DEBUG_TYPE_ERROR</code>, <code class="constant">GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR</code>, | |
29 | <code class="constant">GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR</code>, <code class="constant">GL_DEBUG_TYPE_PORTABILITY</code>, | |
c7b31271 DH |
30 | <code class="constant">GL_DEBUG_TYPE_PERFORMANCE</code>, <code class="constant">GL_DEBUG_TYPE_MARKER</code>, <code class="constant">GL_DEBUG_TYPE_PUSH_GROUP</code>, |
31 | <code class="constant">GL_DEBUG_TYPE_POP_GROUP</code>, or <code class="constant">GL_DEBUG_TYPE_OTHER</code> to indicate the type of messages describing | |
32 | GL errors, attempted use of deprecated features, triggering of undefined behavior, portability issues, performance notifications, markers, | |
33 | group push and pop events, and other | |
34 | types of messages, respectively. It may also take the value <code class="constant">GL_DONT_CARE</code>. If <em class="parameter"><code>type</code></em> is not <code class="constant">GL_DONT_CARE</code> | |
7faf1d71 AW |
35 | then only messages whose type matches <em class="parameter"><code>type</code></em> will be referenced. |
36 | </p><p> | |
37 | <em class="parameter"><code>severity</code></em> may be one of <code class="constant">GL_DEBUG_SEVERITY_LOW</code>, <code class="constant">GL_DEBUG_SEVERITY_MEDIUM</code>, | |
c7b31271 DH |
38 | or <code class="constant">GL_DEBUG_SEVERITY_HIGH</code> to select messages of low, medium or high severity messages or to |
39 | <code class="constant">GL_DEBUG_SEVERITY_NOTIFICATION</code> for notifications. It may also take the | |
7faf1d71 AW |
40 | value <code class="constant">GL_DONT_CARE</code>. If <em class="parameter"><code>severity</code></em> is not <code class="constant">GL_DONT_CARE</code> then only |
41 | messages whose severity matches <em class="parameter"><code>severity</code></em> will be referenced. | |
42 | </p><p> | |
43 | <em class="parameter"><code>ids</code></em> contains a list of <em class="parameter"><code>count</code></em> message identifiers to select specific messages from the pool | |
44 | of available messages. If <em class="parameter"><code>count</code></em> is zero then the value of <em class="parameter"><code>ids</code></em> is ignored. Otherwise, | |
45 | only messages appearing in this list are selected. In this case, <em class="parameter"><code>source</code></em> and <em class="parameter"><code>type</code></em> | |
46 | may not be <code class="constant">GL_DONT_CARE</code> and <em class="parameter"><code>severity</code></em> must be <code class="constant">GL_DONT_CARE</code>. | |
47 | </p><p> | |
48 | If <em class="parameter"><code>enabled</code></em> is <code class="constant">GL_TRUE</code> then messages that match the filter formed by | |
49 | <em class="parameter"><code>source</code></em>, <em class="parameter"><code>type</code></em>, <em class="parameter"><code>severity</code></em> and <em class="parameter"><code>ids</code></em> | |
50 | are enabled. Otherwise, those messages are disabled. | |
51 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
52 | Although debug messages may be enabled in a non-debug context, the quantity and detail of such messages may be substantially | |
53 | inferior to those in a debug context. In particular, a valid implementation of the debug message queue in a non-debug context | |
54 | may produce no messages at all. | |
c7b31271 DH |
55 | </p><p> |
56 | <code class="constant">GL_DEBUG_TYPE_MARKER</code>, <code class="constant">GL_DEBUG_TYPE_PUSH_GROUP</code>, <code class="constant">GL_DEBUG_TYPE_POP_GROUP</code>, and <code class="constant">GL_DEBUG_SEVERITY_NOTIFICATION</code> | |
57 | are available only if the GL version is 4.3 or higher. | |
7faf1d71 AW |
58 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> |
59 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>count</code></em> is negative. | |
60 | </p><p> | |
61 | <code class="constant">GL_INVALID_ENUM</code> is generated if any of <em class="parameter"><code>source</code></em>, <em class="parameter"><code>type</code></em> | |
62 | or <em class="parameter"><code>severity</code></em> is not one of the accepted interface types. | |
63 | </p><p> | |
64 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>count</code></em> is non-zero | |
65 | and either <em class="parameter"><code>source</code></em> or <em class="parameter"><code>type</code></em> is <code class="constant">GL_DONT_CARE</code> | |
66 | or if <em class="parameter"><code>severity</code></em> is not <code class="constant">GL_DONT_CARE</code>. | |
67 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
68 | <a href="glDebugMessageInsert.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageInsert</span></span></a>, | |
69 | <a href="glDebugMessageCallback.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageCallback</span></span></a>, | |
70 | <a href="glGetDebugMessageLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetDebugMessageLog</span></span></a>. | |
71 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
72 | Copyright <span class="trademark"></span>© 2012 Khronos Group. | |
73 | This material may be distributed subject to the terms and conditions set forth in | |
74 | the Open Publication License, v 1.0, 8 June 1999. | |
75 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
76 | </p></div></div></body></html> |