mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-26 06:35:29 +00:00
120 lines
5.3 KiB
XML
120 lines
5.3 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
|
<refentry id="glGetObjectPtrLabel">
|
|
<refentryinfo>
|
|
<copyright>
|
|
<year>2013</year>
|
|
<holder>Khronos Group</holder>
|
|
</copyright>
|
|
</refentryinfo>
|
|
<refmeta>
|
|
<refentrytitle>glGetObjectPtrLabel</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glGetObjectPtrLabel</refname>
|
|
<refpurpose>retrieve the label of a sync object identified by a pointer</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glGetObjectPtrLabel</function></funcdef>
|
|
<paramdef>void * <parameter>ptr</parameter></paramdef>
|
|
<paramdef>GLsizei <parameter>bifSize</parameter></paramdef>
|
|
<paramdef>GLsizei * <parameter>length</parameter></paramdef>
|
|
<paramdef>char * <parameter>label</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>ptr</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The name of the sync object whose label to retrieve.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>bufSize</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The length of the buffer whose address is in <parameter>label</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>length</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The address of a variable to receive the length of the object label.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>label</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The address of a string that will receive the object label.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para>
|
|
<function>glGetObjectPtrLabel</function> retrieves the label of the sync object identified by
|
|
<parameter>ptr</parameter>.
|
|
</para>
|
|
<para>
|
|
<parameter>label</parameter> is the address of a string that will be used to store the object label.
|
|
<parameter>bufSize</parameter> specifies the number of characters in the array identified by <parameter>label</parameter>.
|
|
<parameter>length</parameter> contains the address of a variable which will receive the the number of characters in the object label.
|
|
If <parameter>length</parameter> is NULL, then it is ignored and no data is written. Likewise, if <parameter>label</parameter>
|
|
is NULL, or if <parameter>bufSize</parameter> is zero then no data is written to <parameter>label</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_ENUM</constant> is generated if <parameter>identifier</parameter>
|
|
is not one of the accepted object types.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>ptr</parameter>
|
|
is not the name of an existing sync object.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>bufSize</parameter> is
|
|
zero.
|
|
</para>
|
|
<para>
|
|
If not NULL, <parameter>length</parameter> and <parameter>label</parameter> should be addresses
|
|
to which the client has write access, otherwise undefined behavior, including process termination
|
|
may occur.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_LABEL_LENGTH</constant>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glPopDebugGroup</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGetObjectLabel</refentrytitle></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 2013 Khronos Group.
|
|
This material may be distributed subject to the terms and conditions set forth in
|
|
the Open Publication License, v 1.0, 8 June 1999.
|
|
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|