upstream-man-pages/man4/glPopDebugGroup.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glPopDebugGroup">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glPopDebugGroup</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glPopDebugGroup</refname>
  17         <refpurpose>pop the active debug group</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glPopDebugGroup</function></funcdef>
  23                 <paramdef>void</paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="description"><title>Description</title>
  28         <para>
  29             <function>glPopDebugGroup</function> pops the active debug group.
  30             After popping a debug group, the GL will also generate a debug
  31             output message describing its cause based on the <parameter>message</parameter>
  32             string, the source <parameter>source</parameter>, and an ID <parameter>id</parameter>
  33             submitted to the corresponding <citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>
  34             command. <constant>GL_DEBUG_TYPE_PUSH_GROUP</constant> and <constant>GL_DEBUG_TYPE_POP_GROUP</constant>
  35             share a single namespace for message <parameter>id</parameter>.
  36             <parameter>severity</parameter> has the value <constant>GL_DEBUG_SEVERITY_NOTIFICATION</constant>. The <parameter>type</parameter>
  37             has the value <constant>GL_DEBUG_TYPE_POP_GROUP</constant>. Popping a debug group restores
  38             the debug output volume control of the parent debug group.
  39         </para>
  40     </refsect1>
  41     <refsect1 id="errors"><title>Errors</title>
  42         <para>
  43             <constant>GL_STACK_UNDERFLOW</constant> is generated if an attempt is made to pop the default debug
  44             group from the stack.
  45         </para>
  46     </refsect1>
  47     <refsect1 id="associatedgets"><title>Associated Gets</title>
  48         <para>
  49             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.
  50         </para>
  51     </refsect1>
  52     <refsect1 id="seealso"><title>See Also</title>
  53         <para>
  54             <citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>,
  55             <citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>,
  56             <citerefentry><refentrytitle>glObjectPtrLabel</refentrytitle></citerefentry>.
  57         </para>
  58     </refsect1>
  59     <refsect1 id="Copyright"><title>Copyright</title>
  60         <para>
  61             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
  62             This material may be distributed subject to the terms and conditions set forth in
  63             the Open Publication License, v 1.0, 8 June 1999.
  64             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  65         </para>
  66     </refsect1>
  67 </refentry>