Opentk/Source/Bind/Specifications/Docs/glGetFragDataIndex.xml
2010-12-04 21:51:40 +00:00

82 lines
3.7 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="glGetFragDataIndex">
<refmeta>
<refmetainfo>
<copyright>
<year>2010</year>
<holder>Khronos Group</holder>
</copyright>
</refmetainfo>
<refentrytitle>glGetFragDataIndex</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetFragDataIndex</refname>
<refpurpose>query the bindings of color indices to user-defined varying out variables</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLint <function>glGetFragDataIndex</function></funcdef>
<paramdef>GLuint <parameter>program</parameter></paramdef>
<paramdef>const char * <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>program</parameter></term>
<listitem>
<para>
The name of the program containing varying out variable whose binding to query
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the user-defined varying out variable whose index to query
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glGetFragDataIndex</function> returns the index of the fragment color to which the variable <parameter>name</parameter>
was bound when the program object <parameter>program</parameter> was last linked. If <parameter>name</parameter> is not a varying out
variable of <parameter>program</parameter>, or if an error occurs, -1 will be returned.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
<function>glGetFragDataIndex</function> is available only if the GL version is 3.3 or greater.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>program</parameter> is not the name of a program object.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glBindFragDataLocation</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glBindFragDataLocationIndexed</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGetFragDataLocation</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2010 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>