Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
4 | <refentry id="glDebugMessageControl">\r | |
5 | <refmeta>\r | |
6 | <refmetainfo>\r | |
7 | <copyright>\r | |
8 | <year>2012</year>\r | |
9 | <holder>Khronos Group</holder>\r | |
10 | </copyright>\r | |
11 | </refmetainfo>\r | |
12 | <refentrytitle>glDebugMessageControl</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>glDebugMessageControl</refname>\r | |
17 | <refpurpose>control the reporting of debug messages in a debug context</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>C Specification</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>void <function>glDebugMessageControl</function></funcdef>\r | |
23 | <paramdef>GLenum <parameter>source</parameter></paramdef>\r | |
24 | <paramdef>GLenum <parameter>type</parameter></paramdef>\r | |
25 | <paramdef>GLenum <parameter>severity</parameter></paramdef>\r | |
26 | <paramdef>GLsizei <parameter>count</parameter></paramdef>\r | |
27 | <paramdef>const GLuint *<parameter>ids</parameter></paramdef>\r | |
28 | <paramdef>GLboolean <parameter>enabled</parameter></paramdef>\r | |
29 | </funcprototype>\r | |
30 | </funcsynopsis>\r | |
31 | </refsynopsisdiv>\r | |
32 | <refsect1 id="parameters"><title>Parameters</title>\r | |
33 | <variablelist>\r | |
34 | <varlistentry>\r | |
35 | <term><parameter>source</parameter></term>\r | |
36 | <listitem>\r | |
37 | <para>\r | |
38 | The source of debug messages to enable or disable.\r | |
39 | </para>\r | |
40 | </listitem>\r | |
41 | </varlistentry>\r | |
42 | <varlistentry>\r | |
43 | <term><parameter>type</parameter></term>\r | |
44 | <listitem>\r | |
45 | <para>\r | |
46 | The type of debug messages to enable or disable.\r | |
47 | </para>\r | |
48 | </listitem>\r | |
49 | </varlistentry>\r | |
50 | <varlistentry>\r | |
51 | <term><parameter>severity</parameter></term>\r | |
52 | <listitem>\r | |
53 | <para>\r | |
54 | The severity of debug messages to enable or disable.\r | |
55 | </para>\r | |
56 | </listitem>\r | |
57 | </varlistentry>\r | |
58 | <varlistentry>\r | |
59 | <term><parameter>count</parameter></term>\r | |
60 | <listitem>\r | |
61 | <para>\r | |
62 | The length of the array <parameter>ids</parameter>.\r | |
63 | </para>\r | |
64 | </listitem>\r | |
65 | </varlistentry>\r | |
66 | <varlistentry>\r | |
67 | <term><parameter>ids</parameter></term>\r | |
68 | <listitem>\r | |
69 | <para>\r | |
70 | The address of an array of unsigned integers contianing the ids of the messages to enable or disable.\r | |
71 | </para>\r | |
72 | </listitem>\r | |
73 | </varlistentry>\r | |
74 | <varlistentry>\r | |
75 | <term><parameter>enabled</parameter></term>\r | |
76 | <listitem>\r | |
77 | <para>\r | |
78 | A Boolean flag determining whether the selected messages should be enabled or disabled.\r | |
79 | </para>\r | |
80 | </listitem>\r | |
81 | </varlistentry>\r | |
82 | </variablelist>\r | |
83 | </refsect1>\r | |
84 | <refsect1 id="description"><title>Description</title>\r | |
85 | <para>\r | |
86 | <function>glDebugMessageControl</function> controls the reporting of debug messages generated by a debug\r | |
87 | context. The parameters <parameter>source</parameter>, <parameter>type</parameter> and <parameter>severity</parameter>\r | |
88 | form a filter to select messages from the pool of potential messages generated by the GL.\r | |
89 | </para>\r | |
90 | <para>\r | |
91 | <parameter>source</parameter> may be <constant>GL_DEBUG_SOURCE_API</constant>, <constant>GL_DEBUG_SOURCE_WINDOW_SYSTEM_</constant>,\r | |
92 | <constant>GL_DEBUG_SOURCE_SHADER_COMPILER</constant>, <constant>GL_DEBUG_SOURCE_THIRD_PARTY</constant>,\r | |
93 | <constant>GL_DEBUG_SOURCE_APPLICATION</constant>, <constant>GL_DEBUG_SOURCE_OTHER</constant> to select messages generated by\r | |
94 | usage of the GL API, the window system, the shader compiler, third party tools or libraries, explicitly by the application\r | |
95 | or by some other source, respectively. It may also take the value <constant>GL_DONT_CARE</constant>. If <parameter>source</parameter>\r | |
96 | is not <constant>GL_DONT_CARE</constant> then only messages whose source matches <parameter>source</parameter> will be referenced.\r | |
97 | </para>\r | |
98 | <para>\r | |
99 | <parameter>type</parameter> may be one of <constant>GL_DEBUG_TYPE_ERROR</constant>, <constant>GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR</constant>,\r | |
100 | <constant>GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR</constant>, <constant>GL_DEBUG_TYPE_PORTABILITY</constant>,\r | |
101 | <constant>GL_DEBUG_TYPE_PERFORMANCE</constant>, <constant>GL_DEBUG_TYPE_OTHER</constant> to indicate the type of messages describing\r | |
102 | GL errors, attempted use of deprecated features, triggering of undefined behavior, portability issues, performance notifications and other\r | |
103 | types of messages. It may also take the value <constant>GL_DONT_CARE</constant>. If <parameter>type</parameter> is not <constant>GL_DONT_CARE</constant>\r | |
104 | then only messages whose type matches <parameter>type</parameter> will be referenced.\r | |
105 | </para>\r | |
106 | <para>\r | |
107 | <parameter>severity</parameter> may be one of <constant>GL_DEBUG_SEVERITY_LOW</constant>, <constant>GL_DEBUG_SEVERITY_MEDIUM</constant>,\r | |
108 | or <constant>GL_DEBUG_SEVERITY_HIGH</constant> to select messages of low, medium or high severity messages. It may also take the\r | |
109 | value <constant>GL_DONT_CARE</constant>. If <parameter>severity</parameter> is not <constant>GL_DONT_CARE</constant> then only\r | |
110 | messages whose severity matches <parameter>severity</parameter> will be referenced.\r | |
111 | </para>\r | |
112 | <para>\r | |
113 | <parameter>ids</parameter> contains a list of <parameter>count</parameter> message identifiers to select specific messages from the pool\r | |
114 | of available messages. If <parameter>count</parameter> is zero then the value of <parameter>ids</parameter> is ignored. Otherwise,\r | |
115 | only messages appearing in this list are selected. In this case, <parameter>source</parameter> and <parameter>type</parameter>\r | |
116 | may not be <constant>GL_DONT_CARE</constant> and <parameter>severity</parameter> must be <constant>GL_DONT_CARE</constant>.\r | |
117 | </para>\r | |
118 | <para>\r | |
119 | If <parameter>enabled</parameter> is <constant>GL_TRUE</constant> then messages that match the filter formed by\r | |
120 | <parameter>source</parameter>, <parameter>type</parameter>, <parameter>severity</parameter> and <parameter>ids</parameter>\r | |
121 | are enabled. Otherwise, those messages are disabled.\r | |
122 | </para>\r | |
123 | </refsect1>\r | |
124 | <refsect1 id="notes"><title>Notes</title>\r | |
125 | <para>\r | |
126 | Although debug messages may be enabled in a non-debug context, the quantity and detail of such messages may be substantially\r | |
127 | inferior to those in a debug context. In particular, a valid implementation of the debug message queue in a non-debug context\r | |
128 | may produce no messages at all.\r | |
129 | </para>\r | |
130 | </refsect1>\r | |
131 | <refsect1 id="errors"><title>Errors</title>\r | |
132 | <para>\r | |
133 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> is negative.\r | |
134 | </para>\r | |
135 | <para>\r | |
136 | <constant>GL_INVALID_ENUM</constant> is generated if any of <parameter>source</parameter>, <parameter>type</parameter>\r | |
137 | or <parameter>severity</parameter> is not one of the accepted interface types.\r | |
138 | </para>\r | |
139 | <para>\r | |
140 | <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>count</parameter> is non-zero\r | |
141 | and either <parameter>source</parameter> or <parameter>type</parameter> is <constant>GL_DONT_CARE</constant>\r | |
142 | or if <parameter>severity</parameter> is not <constant>GL_DONT_CARE</constant>.\r | |
143 | </para>\r | |
144 | </refsect1>\r | |
145 | <refsect1 id="seealso"><title>See Also</title>\r | |
146 | <para>\r | |
147 | <citerefentry><refentrytitle>glDebugMessageInsert</refentrytitle></citerefentry>,\r | |
148 | <citerefentry><refentrytitle>glDebugMessageCallback</refentrytitle></citerefentry>,\r | |
149 | <citerefentry><refentrytitle>glGetDebugMessageLog</refentrytitle></citerefentry>.\r | |
150 | </para>\r | |
151 | </refsect1>\r | |
152 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
153 | <para>\r | |
154 | Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r | |
155 | This material may be distributed subject to the terms and conditions set forth in \r | |
156 | the Open Publication License, v 1.0, 8 June 1999.\r | |
157 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
158 | </para>\r | |
159 | </refsect1>\r | |
160 | </refentry>\r |