rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / glPopDebugGroup.xml
CommitLineData
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="glPopDebugGroup">\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>glPopDebugGroup</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>glPopDebugGroup</refname>\r
17 <refpurpose>pop the active debug group</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>C Specification</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>void <function>glPopDebugGroup</function></funcdef>\r
23 <paramdef>void</paramdef>\r
24 </funcprototype>\r
25 </funcsynopsis>\r
26 </refsynopsisdiv>\r
27 <refsect1 id="description"><title>Description</title>\r
28 <para>\r
29 <function>glPopDebugGroup</function> pops the active debug group.\r
30 After popping a debug group, the GL will also generate a debug\r
31 output message describing its cause based on the <parameter>message</parameter>\r
32 string, the source <parameter>source</parameter>, and an ID <parameter>id</parameter>\r
33 submitted to the corresponding <citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>\r
34 command. <constant>GL_DEBUG_TYPE_PUSH_GROUP</constant> and <constant>GL_DEBUG_TYPE_POP_GROUP</constant>\r
35 share a single namespace for message <parameter>id</parameter>.\r
36 <parameter>severity</parameter> has the value <constant>GL_DEBUG_SEVERITY_NOTIFICATION</constant>. The <parameter>type</parameter>\r
37 has the value <constant>GL_DEBUG_TYPE_POP_GROUP</constant>. Popping a debug group restores\r
38 the debug output volume control of the parent debug group.\r
39 </para>\r
40 </refsect1>\r
41 <refsect1 id="errors"><title>Errors</title>\r
42 <para>\r
43 <constant>GL_STACK_UNDERFLOW</constant> is generated if an attempt is made to pop the default debug\r
44 group from the stack.\r
45 </para>\r
46 </refsect1>\r
47 <refsect1 id="associatedgets"><title>Associated Gets</title>\r
48 <para>\r
49 <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.\r
50 </para>\r
51 </refsect1>\r
52 <refsect1 id="seealso"><title>See Also</title>\r
53 <para>\r
54 <citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>,\r
55 <citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>,\r
56 <citerefentry><refentrytitle>glObjectPtrLabel</refentrytitle></citerefentry>.\r
57 </para>\r
58 </refsect1>\r
59 <refsect1 id="Copyright"><title>Copyright</title>\r
60 <para>\r
61 Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
62 This material may be distributed subject to the terms and conditions set forth in \r
63 the Open Publication License, v 1.0, 8 June 1999.\r
64 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
65 </para>\r
66 </refsect1>\r
67</refentry>\r