upstream-man-pages/man4/glPushDebugGroup.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="glPushDebugGroup">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glPushDebugGroup</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glPushDebugGroup</refname>
  17         <refpurpose>push a named debug group into the command stream</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glPushDebugGroup</function></funcdef>
  23                 <paramdef>GLenum <parameter>source</parameter></paramdef>
  24                 <paramdef>GLuint <parameter>id</parameter></paramdef>
  25                 <paramdef>GLsizei <parameter>length</parameter></paramdef>
  26                 <paramdef>const char * <parameter>message</parameter></paramdef>
  27             </funcprototype>
  28         </funcsynopsis>
  29     </refsynopsisdiv>
  30     <refsect1 id="parameters"><title>Parameters</title>
  31         <variablelist>
  32         <varlistentry>
  33             <term><parameter>source</parameter></term>
  34             <listitem>
  35                 <para>
  36                     The source of the debug message.
  37                 </para>
  38             </listitem>
  39         </varlistentry>
  40         <varlistentry>
  41             <term><parameter>id</parameter></term>
  42             <listitem>
  43                 <para>
  44                     The identifier of the message.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>length</parameter></term>
  50             <listitem>
  51                 <para>
  52                     The length of the message to be sent to the debug output stream.
  53                 </para>
  54             </listitem>
  55         </varlistentry>
  56         <varlistentry>
  57             <term><parameter>message</parameter></term>
  58             <listitem>
  59                 <para>
  60                     The a string containing the message to be sent to the debug output stream.
  61                 </para>
  62             </listitem>
  63         </varlistentry>
  64         </variablelist>
  65     </refsect1>
  66     <refsect1 id="description"><title>Description</title>
  67         <para>
  68             <function>glPushDebugGroup</function> pushes a debug group described by the string
  69             <parameter>message</parameter> into the command stream. The value of
  70             <parameter>id</parameter> specifies the ID of messages generated. The parameter
  71             <parameter>length</parameter> contains the number of characters in <parameter>message</parameter>.
  72             If <parameter>length</parameter> is negative, it is implied that <parameter>message</parameter>
  73             contains a null terminated string. The message has the specified <parameter>source</parameter>
  74             and <parameter>id</parameter>, the <parameter>type</parameter> <constant>GL_DEBUG_TYPE_PUSH_GROUP</constant>, and <parameter>severity</parameter>
  75             <constant>GL_DEBUG_SEVERITY_NOTIFICATION</constant>. The GL will put a new debug group
  76             on top of the debug group stack which inherits the control of the
  77             volume of debug output of the debug group previously residing on the
  78             top of the debug group stack. Because debug groups are strictly
  79             hierarchical, any additional control of the debug output volume will
  80             only apply within the active debug group and the debug groups pushed
  81             on top of the active debug group.
  82         </para>
  83     </refsect1>
  84     <refsect1 id="errors"><title>Errors</title>
  85         <para>
  86             <constant>GL_INVALID_ENUM</constant> is generated if the value of <parameter>source</parameter> is
  87             neither <constant>GL_DEBUG_SOURCE_APPLICATION</constant> nor <constant>GL_DEBUG_SOURCE_THIRD_PARTY</constant>.
  88         </para>
  89         <para>
  90             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>length</parameter> is negative
  91             and the number of characters in <parameter>message</parameter>, excluding the null-terminator,
  92             is not less than the value of <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.
  93         </para>
  94     </refsect1>
  95     <refsect1 id="associatedgets"><title>Associated Gets</title>
  96         <para>
  97             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.
  98         </para>
  99     </refsect1>
 100     <refsect1 id="seealso"><title>See Also</title>
 101         <para>
 102             <citerefentry><refentrytitle>glPopDebugGroup</refentrytitle></citerefentry>,
 103             <citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>,
 104             <citerefentry><refentrytitle>glObjectPtrLabel</refentrytitle></citerefentry>.
 105         </para>
 106     </refsect1>
 107     <refsect1 id="Copyright"><title>Copyright</title>
 108         <para>
 109             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
 110             This material may be distributed subject to the terms and conditions set forth in
 111             the Open Publication License, v 1.0, 8 June 1999.
 112             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 113         </para>
 114     </refsect1>
 115 </refentry>