1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<?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.78.1" /></head><body><div class="refentry"><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" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">GLuint <strong class="fsfunc">glGetDebugMessageLog</strong>(</code></td><td>GLuint <var class="pdparam">count</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">bufSize</var>, </td></tr><tr><td> </td><td>GLenum *<var class="pdparam">sources</var>, </td></tr><tr><td> </td><td>Glenum *<var class="pdparam">types</var>, </td></tr><tr><td> </td><td>GLuint *<var class="pdparam">ids</var>, </td></tr><tr><td> </td><td>GLenum *<var class="pdparam">severities</var>, </td></tr><tr><td> </td><td>GLsizei *<var class="pdparam">lengths</var>, </td></tr><tr><td> </td><td>GLchar *<var class="pdparam">messageLog</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
The number of debug messages to retrieve from the log.
</p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p>
The size of the buffer whose address is given by <em class="parameter"><code>messageLog</code></em>.
</p></dd><dt><span class="term"><em class="parameter"><code>sources</code></em></span></dt><dd><p>
The address of an array of variables to receive the sources of the retrieved messages.
</p></dd><dt><span class="term"><em class="parameter"><code>types</code></em></span></dt><dd><p>
The address of an array of variables to receive the types of the retrieved messages.
</p></dd><dt><span class="term"><em class="parameter"><code>ids</code></em></span></dt><dd><p>
The address of an array of unsigned integers to receive the ids of the retrieved messages.
</p></dd><dt><span class="term"><em class="parameter"><code>severities</code></em></span></dt><dd><p>
The address of an array of variables to receive the severites of the retrieved messages.
</p></dd><dt><span class="term"><em class="parameter"><code>lengths</code></em></span></dt><dd><p>
The address of an array of variables to receive the lengths of the received messages.
</p></dd><dt><span class="term"><em class="parameter"><code>messageLog</code></em></span></dt><dd><p>
The address of an array of characters that will receive the messages.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glGetDebugMessageLog</code> retrieves messages from the debug message log. A maximum of
<em class="parameter"><code>count</code></em> messages are retrieved from the log. If <em class="parameter"><code>sources</code></em>
is not NULL then the source of each message is written into up to <em class="parameter"><code>count</code></em> elements
of the array. If <em class="parameter"><code>types</code></em>
is not NULL then the type of each message is written into up to <em class="parameter"><code>count</code></em> elements
of the array. If <em class="parameter"><code>id</code></em>
is not NULL then the identifier of each message is written into up to <em class="parameter"><code>count</code></em> elements
of the array. If <em class="parameter"><code>severities</code></em>
is not NULL then the severity of each message is written into up to <em class="parameter"><code>count</code></em> elements
of the array. If <em class="parameter"><code>lengths</code></em>
is not NULL then the length of each message is written into up to <em class="parameter"><code>count</code></em> elements
of the array.
</p><p>
<em class="parameter"><code>messageLog</code></em> specifies the address of a character array into which the debug messages
will be written. Each message will be concatenated onto the array starting at the first element of <em class="parameter"><code>messageLog</code></em>.
<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
fit into the remaining space in <em class="parameter"><code>messageLog</code></em> then the function terminates and returns the number
of messages written so far, which may be zero.
</p><p>
If <code class="function">glGetDebugMessageLog</code> returns zero then no messages are present in the debug log, or there
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>
is NULL then no messages are written and the value of <em class="parameter"><code>bufSize</code></em> is ignored.
</p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
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.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<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.
</p></div><div class="refsect1"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEBUG_LOGGED_MESSAGES</code>
</p><p>
<a class="citerefentry" 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>
</p><p>
<a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_DEBUG_MESSAGE_LENGTH</code>
</p><p>
<a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_DEBUG_LOGGED_MESSAGES</code>
</p></div><div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glDebugMessageInsert.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageInsert</span></span></a>,
<a class="citerefentry" href="glDebugMessageCallback.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageCallback</span></span></a>,
<a class="citerefentry" href="glDebugMessageControl.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageControl</span></span></a>.
</p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
Copyright <span class="trademark"></span>© 2013 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.
<a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p></div></div></body></html>
|
