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="glGetDebugMessageLog">\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>glGetDebugMessageLog</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>glGetDebugMessageLog</refname>\r | |
17 | <refpurpose>retrieve messages from the debug message log</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>C Specification</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>GLuint <function>glGetDebugMessageLog</function></funcdef>\r | |
23 | <paramdef>GLuint <parameter>count</parameter></paramdef>\r | |
24 | <paramdef>GLsizei <parameter>bufSize</parameter></paramdef>\r | |
25 | <paramdef>GLenum *<parameter>sources</parameter></paramdef>\r | |
26 | <paramdef>Glenum *<parameter>types</parameter></paramdef>\r | |
27 | <paramdef>GLuint *<parameter>ids</parameter></paramdef>\r | |
28 | <paramdef>GLenum *<parameter>severities</parameter></paramdef>\r | |
29 | <paramdef>GLsizei *<parameter>lengths</parameter></paramdef>\r | |
30 | <paramdef>GLchar *<parameter>messageLog</parameter></paramdef>\r | |
31 | </funcprototype>\r | |
32 | </funcsynopsis>\r | |
33 | </refsynopsisdiv>\r | |
34 | <refsect1 id="parameters"><title>Parameters</title>\r | |
35 | <variablelist>\r | |
36 | <varlistentry>\r | |
37 | <term><parameter>count</parameter></term>\r | |
38 | <listitem>\r | |
39 | <para>\r | |
40 | The number of debug messages to retrieve from the log.\r | |
41 | </para>\r | |
42 | </listitem>\r | |
43 | </varlistentry>\r | |
44 | <varlistentry>\r | |
45 | <term><parameter>bufSize</parameter></term>\r | |
46 | <listitem>\r | |
47 | <para>\r | |
48 | The size of the buffer whose address is given by <parameter>messageLog</parameter>.\r | |
49 | </para>\r | |
50 | </listitem>\r | |
51 | </varlistentry>\r | |
52 | <varlistentry>\r | |
53 | <term><parameter>sources</parameter></term>\r | |
54 | <listitem>\r | |
55 | <para>\r | |
56 | The address of an array of variables to receive the sources of the retrieved messages.\r | |
57 | </para>\r | |
58 | </listitem>\r | |
59 | </varlistentry>\r | |
60 | <varlistentry>\r | |
61 | <term><parameter>types</parameter></term>\r | |
62 | <listitem>\r | |
63 | <para>\r | |
64 | The address of an array of variables to receive the types of the retrieved messages.\r | |
65 | </para>\r | |
66 | </listitem>\r | |
67 | </varlistentry>\r | |
68 | <varlistentry>\r | |
69 | <term><parameter>ids</parameter></term>\r | |
70 | <listitem>\r | |
71 | <para>\r | |
72 | The address of an array of unsigned integers to receive the ids of the retrieved messages.\r | |
73 | </para>\r | |
74 | </listitem>\r | |
75 | </varlistentry>\r | |
76 | <varlistentry>\r | |
77 | <term><parameter>severities</parameter></term>\r | |
78 | <listitem>\r | |
79 | <para>\r | |
80 | The address of an array of variables to receive the severites of the retrieved messages.\r | |
81 | </para>\r | |
82 | </listitem>\r | |
83 | </varlistentry>\r | |
84 | <varlistentry>\r | |
85 | <term><parameter>lengths</parameter></term>\r | |
86 | <listitem>\r | |
87 | <para>\r | |
88 | The address of an array of variables to receive the lengths of the received messages.\r | |
89 | </para>\r | |
90 | </listitem>\r | |
91 | </varlistentry>\r | |
92 | <varlistentry>\r | |
93 | <term><parameter>messageLog</parameter></term>\r | |
94 | <listitem>\r | |
95 | <para>\r | |
96 | The address of an array of characters that will receive the messages.\r | |
97 | </para>\r | |
98 | </listitem>\r | |
99 | </varlistentry>\r | |
100 | </variablelist>\r | |
101 | </refsect1>\r | |
102 | <refsect1 id="description"><title>Description</title>\r | |
103 | <para>\r | |
104 | <function>glGetDebugMessageLog</function> retrieves messages from the debug message log. A maximum of\r | |
105 | <parameter>count</parameter> messages are retrieved from the log. If <parameter>sources</parameter>\r | |
106 | is not NULL then the source of each message is written into up to <parameter>count</parameter> elements\r | |
107 | of the array. If <parameter>types</parameter>\r | |
108 | is not NULL then the type of each message is written into up to <parameter>count</parameter> elements\r | |
109 | of the array. If <parameter>id</parameter>\r | |
110 | is not NULL then the identifier of each message is written into up to <parameter>count</parameter> elements\r | |
111 | of the array. If <parameter>severities</parameter>\r | |
112 | is not NULL then the severity of each message is written into up to <parameter>count</parameter> elements\r | |
113 | of the array. If <parameter>lengths</parameter>\r | |
114 | is not NULL then the length of each message is written into up to <parameter>count</parameter> elements\r | |
115 | of the array.\r | |
116 | </para>\r | |
117 | <para>\r | |
118 | <parameter>messageLog</parameter> specifies the address of a character array into which the debug messages\r | |
119 | will be written. Each message will be concatenated onto the array starting at the first element of <parameter>messageLog</parameter>.\r | |
120 | <parameter>bufSize</parameter> specifies the size of the array <parameter>messageLog</parameter>. If a message will not\r | |
121 | fit into the remaining space in <parameter>messageLog</parameter> then the function terminates and returns the number\r | |
122 | of messages written so far, which may be zero.\r | |
123 | </para>\r | |
124 | <para>\r | |
125 | If <function>glGetDebugMessageLog</function> returns zero then no messages are present in the debug log, or there\r | |
126 | was not enough space in <parameter>messageLog</parameter> to retrieve the first message in the queue. If <parameter>messageLog</parameter>\r | |
127 | is NULL then no messages are written and the value of <parameter>bufSize</parameter> is ignored.\r | |
128 | </para>\r | |
129 | </refsect1>\r | |
130 | <refsect1 id="notes"><title>Notes</title>\r | |
131 | <para>\r | |
132 | Although debug messages may be enabled in a non-debug context, the quantity and detail of such messages may be substantially\r | |
133 | inferior to those in a debug context. In particular, a valid implementation of the debug message queue in a non-debug context\r | |
134 | may produce no messages at all.\r | |
135 | </para>\r | |
136 | </refsect1>\r | |
137 | <refsect1 id="errors"><title>Errors</title>\r | |
138 | <para>\r | |
139 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> or <parameter>bufSize</parameter> is negative.\r | |
140 | </para>\r | |
141 | </refsect1>\r | |
142 | <refsect1 id="associatedgets"><title>Associated Gets</title>\r | |
143 | <para>\r | |
144 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEBUG_LOGGED_MESSAGES</constant>\r | |
145 | </para>\r | |
146 | <para>\r | |
147 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEBUG_NEXT_LOGGED_MESSAGE_LENGTH</constant>\r | |
148 | </para>\r | |
149 | <para>\r | |
150 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>\r | |
151 | </para>\r | |
152 | <para>\r | |
153 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_DEBUG_LOGGED_MESSAGES</constant>\r | |
154 | </para>\r | |
155 | </refsect1>\r | |
156 | <refsect1 id="seealso"><title>See Also</title>\r | |
157 | <para>\r | |
158 | <citerefentry><refentrytitle>glDebugMessageInsert</refentrytitle></citerefentry>,\r | |
159 | <citerefentry><refentrytitle>glDebugMessageCallback</refentrytitle></citerefentry>,\r | |
160 | <citerefentry><refentrytitle>glDebugMessageControl</refentrytitle></citerefentry>.\r | |
161 | </para>\r | |
162 | </refsect1>\r | |
163 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
164 | <para>\r | |
165 | Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r | |
166 | This material may be distributed subject to the terms and conditions set forth in \r | |
167 | the Open Publication License, v 1.0, 8 June 1999.\r | |
168 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
169 | </para>\r | |
170 | </refsect1>\r | |
171 | </refentry>\r |