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
|
<?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>glPushDebugGroup - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="refentry"><a id="glPushDebugGroup"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glPushDebugGroup — push a named debug group into the command stream</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">void <strong class="fsfunc">glPushDebugGroup</strong>(</code></td><td>GLenum <var class="pdparam">source</var>, </td></tr><tr><td> </td><td>GLuint <var class="pdparam">id</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">length</var>, </td></tr><tr><td> </td><td>const char * <var class="pdparam">message</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>source</code></em></span></dt><dd><p>
The source of the debug message.
</p></dd><dt><span class="term"><em class="parameter"><code>id</code></em></span></dt><dd><p>
The identifier of the message.
</p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
The length of the message to be sent to the debug output stream.
</p></dd><dt><span class="term"><em class="parameter"><code>message</code></em></span></dt><dd><p>
The a string containing the message to be sent to the debug output stream.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glPushDebugGroup</code> pushes a debug group described by the string
<em class="parameter"><code>message</code></em> into the command stream. The value of
<em class="parameter"><code>id</code></em> specifies the ID of messages generated. The parameter
<em class="parameter"><code>length</code></em> contains the number of characters in <em class="parameter"><code>message</code></em>.
If <em class="parameter"><code>length</code></em> is negative, it is implied that <em class="parameter"><code>message</code></em>
contains a null terminated string. The message has the specified <em class="parameter"><code>source</code></em>
and <em class="parameter"><code>id</code></em>, the <em class="parameter"><code>type</code></em> <code class="constant">GL_DEBUG_TYPE_PUSH_GROUP</code>, and <em class="parameter"><code>severity</code></em>
<code class="constant">GL_DEBUG_SEVERITY_NOTIFICATION</code>. The GL will put a new debug group
on top of the debug group stack which inherits the control of the
volume of debug output of the debug group previously residing on the
top of the debug group stack. Because debug groups are strictly
hierarchical, any additional control of the debug output volume will
only apply within the active debug group and the debug groups pushed
on top of the active debug group.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if the value of <em class="parameter"><code>source</code></em> is
neither <code class="constant">GL_DEBUG_SOURCE_APPLICATION</code> nor <code class="constant">GL_DEBUG_SOURCE_THIRD_PARTY</code>.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>length</code></em> is negative
and the number of characters in <em class="parameter"><code>message</code></em>, excluding the null-terminator,
is not less than the value of <code class="constant">GL_MAX_DEBUG_MESSAGE_LENGTH</code>.
</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_MAX_DEBUG_MESSAGE_LENGTH</code>.
</p></div><div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glPopDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
<a class="citerefentry" href="glObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glObjectLabel</span></span></a>,
<a class="citerefentry" href="glObjectPtrLabel.xml"><span class="citerefentry"><span class="refentrytitle">glObjectPtrLabel</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>
|
