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>glGetDebugMessageLog - 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="glGetDebugMessageLog"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetDebugMessageLog — retrieve messages from the debug message log</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">GLuint <b class="fsfunc">glGetDebugMessageLog</b>(</code></td><td>GLuint </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">bufSize</var>, </td></tr><tr><td> </td><td>GLenum * </td><td><var class="pdparam">sources</var>, </td></tr><tr><td> </td><td>Glenum * </td><td><var class="pdparam">types</var>, </td></tr><tr><td> </td><td>GLuint * </td><td><var class="pdparam">ids</var>, </td></tr><tr><td> </td><td>GLenum * </td><td><var class="pdparam">severities</var>, </td></tr><tr><td> </td><td>GLsizei * </td><td><var class="pdparam">lengths</var>, </td></tr><tr><td> </td><td>GLchar * </td><td><var class="pdparam">messageLog</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>count</code></em></span></dt><dd><p> | |
5 | The number of debug messages to retrieve from the log. | |
6 | </p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p> | |
7 | The size of the buffer whose address is given by <em class="parameter"><code>messageLog</code></em>. | |
8 | </p></dd><dt><span class="term"><em class="parameter"><code>sources</code></em></span></dt><dd><p> | |
9 | The address of an array of variables to receive the sources of the retrieved messages. | |
10 | </p></dd><dt><span class="term"><em class="parameter"><code>types</code></em></span></dt><dd><p> | |
11 | The address of an array of variables to receive the types of the retrieved messages. | |
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 to receive the ids of the retrieved messages. | |
14 | </p></dd><dt><span class="term"><em class="parameter"><code>severities</code></em></span></dt><dd><p> | |
15 | The address of an array of variables to receive the severites of the retrieved messages. | |
16 | </p></dd><dt><span class="term"><em class="parameter"><code>lengths</code></em></span></dt><dd><p> | |
17 | The address of an array of variables to receive the lengths of the received messages. | |
18 | </p></dd><dt><span class="term"><em class="parameter"><code>messageLog</code></em></span></dt><dd><p> | |
19 | The address of an array of characters that will receive the messages. | |
20 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
21 | <code class="function">glGetDebugMessageLog</code> retrieves messages from the debug message log. A maximum of | |
22 | <em class="parameter"><code>count</code></em> messages are retrieved from the log. If <em class="parameter"><code>sources</code></em> | |
23 | is not NULL then the source of each message is written into up to <em class="parameter"><code>count</code></em> elements | |
24 | of the array. If <em class="parameter"><code>types</code></em> | |
25 | is not NULL then the type of each message is written into up to <em class="parameter"><code>count</code></em> elements | |
26 | of the array. If <em class="parameter"><code>id</code></em> | |
27 | is not NULL then the identifier of each message is written into up to <em class="parameter"><code>count</code></em> elements | |
28 | of the array. If <em class="parameter"><code>severities</code></em> | |
29 | is not NULL then the severity of each message is written into up to <em class="parameter"><code>count</code></em> elements | |
30 | of the array. If <em class="parameter"><code>lengths</code></em> | |
31 | is not NULL then the length of each message is written into up to <em class="parameter"><code>count</code></em> elements | |
32 | of the array. | |
33 | </p><p> | |
34 | <em class="parameter"><code>messageLog</code></em> specifies the address of a character array into which the debug messages | |
35 | will be written. Each message will be concatenated onto the array starting at the first element of <em class="parameter"><code>messageLog</code></em>. | |
36 | <em class="parameter"><code>bufSize</code></em> specifies the size of the array <em class="parameter"><code>messageLog</code></em>. If a message will not | |
37 | fit into the remaining space in <em class="parameter"><code>messageLog</code></em> then the function terminates and returns the number | |
38 | of messages written so far, which may be zero. | |
39 | </p><p> | |
40 | If <code class="function">glGetDebugMessageLog</code> returns zero then no messages are present in the debug log, or there | |
41 | was not enough space in <em class="parameter"><code>messageLog</code></em> to retrieve the first message in the queue. If <em class="parameter"><code>messageLog</code></em> | |
42 | is NULL then no messages are written and the value of <em class="parameter"><code>bufSize</code></em> is ignored. | |
43 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
44 | Although debug messages may be enabled in a non-debug context, the quantity and detail of such messages may be substantially | |
45 | inferior to those in a debug context. In particular, a valid implementation of the debug message queue in a non-debug context | |
46 | may produce no messages at all. | |
47 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
48 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>count</code></em> or <em class="parameter"><code>bufSize</code></em> is negative. | |
49 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
50 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEBUG_LOGGED_MESSAGES</code> | |
51 | </p><p> | |
52 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEBUG_NEXT_LOGGED_MESSAGE_LENGTH</code> | |
53 | </p><p> | |
54 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_DEBUG_MESSAGE_LENGTH</code> | |
55 | </p><p> | |
56 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_DEBUG_LOGGED_MESSAGES</code> | |
57 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
58 | <a href="glDebugMessageInsert.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageInsert</span></span></a>, | |
59 | <a href="glDebugMessageCallback.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageCallback</span></span></a>, | |
60 | <a href="glDebugMessageControl.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageControl</span></span></a>. | |
61 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
62 | Copyright <span class="trademark"></span>© 2012 Khronos Group. | |
63 | This material may be distributed subject to the terms and conditions set forth in | |
64 | the Open Publication License, v 1.0, 8 June 1999. | |
65 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
66 | </p></div></div></body></html> |