rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glGetObjectPtrLabel.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="glGetObjectPtrLabel">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glGetObjectPtrLabel</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glGetObjectPtrLabel</refname>\r
        <refpurpose>retrieve the label of a sync object identified by a pointer</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glGetObjectPtrLabel</function></funcdef>\r
                <paramdef>void * <parameter>ptr</parameter></paramdef>\r
                <paramdef>GLsizei <parameter>bifSize</parameter></paramdef>\r
                <paramdef>GLsizei * <parameter>length</parameter></paramdef>\r
                <paramdef>char * <parameter>label</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>ptr</parameter></term>\r
            <listitem>\r
                <para>\r
                    The name of the sync object whose label to retrieve.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>bufSize</parameter></term>\r
            <listitem>\r
                <para>\r
                    The length of the buffer whose address is in <parameter>label</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>length</parameter></term>\r
            <listitem>\r
                <para>\r
                    The address of a variable to receive the length of the object label.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>label</parameter></term>\r
            <listitem>\r
                <para>\r
                    The address of a string that will receive the object label.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glGetObjectPtrLabel</function> retrieves the label of the sync object identified by\r
            <parameter>ptr</parameter>.\r
        </para>\r
        <para>\r
            <parameter>label</parameter> is the address of a string that will be used to store the object label.\r
            <parameter>bufSize</parameter> specifies the number of characters in the array identified by <parameter>label</parameter>.\r
            <parameter>length</parameter> contains the address of a variable which will receive the the number of characters in the object label.\r
            If <parameter>length</parameter> is NULL, then it is ignored and no data is written. Likewise, if <parameter>label</parameter>\r
            is NULL, or if <parameter>bufSize</parameter> is zero then no data is written to <parameter>label</parameter>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>identifier</parameter>\r
            is not one of the accepted object types.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>ptr</parameter>\r
            is not the name of an existing sync object.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>bufSize</parameter> is\r
            zero.\r
        </para>\r
        <para>\r
            If not NULL, <parameter>length</parameter> and <parameter>label</parameter> should be addresses\r
            to which the client has write access, otherwise undefined behavior, including process termination\r
            may occur.\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_LABEL_LENGTH</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glPopDebugGroup</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGetObjectLabel</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