rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glPushDebugGroup.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
<refentry id="glPushDebugGroup">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glPushDebugGroup</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glPushDebugGroup</refname>\r
        <refpurpose>push a named debug group into the command stream</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glPushDebugGroup</function></funcdef>\r
                <paramdef>GLenum <parameter>source</parameter></paramdef>\r
                <paramdef>GLuint <parameter>id</parameter></paramdef>\r
                <paramdef>GLsizei <parameter>length</parameter></paramdef>\r
                <paramdef>const char * <parameter>message</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>source</parameter></term>\r
            <listitem>\r
                <para>\r
                    The source of the debug message.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>id</parameter></term>\r
            <listitem>\r
                <para>\r
                    The identifier of the message.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>length</parameter></term>\r
            <listitem>\r
                <para>\r
                    The length of the message to be sent to the debug output stream.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>message</parameter></term>\r
            <listitem>\r
                <para>\r
                    The a string containing the message to be sent to the debug output stream.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glPushDebugGroup</function> pushes a debug group described by the string\r
            <parameter>message</parameter> into the command stream. The value of\r
            <parameter>id</parameter> specifies the ID of messages generated. The parameter\r
            <parameter>length</parameter> contains the number of characters in <parameter>message</parameter>.\r
            If <parameter>length</parameter> is negative, it is implied that <parameter>message</parameter>\r
            contains a null terminated string. The message has the specified <parameter>source</parameter> \r
            and <parameter>id</parameter>, the <parameter>type</parameter> <constant>GL_DEBUG_TYPE_PUSH_GROUP</constant>, and <parameter>severity</parameter>\r
            <constant>GL_DEBUG_SEVERITY_NOTIFICATION</constant>. The GL will put a new debug group\r
            on top of the debug group stack which inherits the control of the\r
            volume of debug output of the debug group previously residing on the\r
            top of the debug group stack. Because debug groups are strictly\r
            hierarchical, any additional control of the debug output volume will\r
            only apply within the active debug group and the debug groups pushed\r
            on top of the active debug group.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if the value of <parameter>source</parameter> is\r
            neither <constant>GL_DEBUG_SOURCE_APPLICATION</constant> nor <constant>GL_DEBUG_SOURCE_THIRD_PARTY</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>length</parameter> is negative\r
            and the number of characters in <parameter>message</parameter>, excluding the null-terminator,\r
            is not less than the value of <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glPopDebugGroup</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glObjectPtrLabel</refentrytitle></citerefentry>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
            This material may be distributed subject to the terms and conditions set forth in \r
            the Open Publication License, v 1.0, 8 June 1999.\r
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
        </para>\r
    </refsect1>\r
</refentry>\r