upstream-doc/man4/glGetFragDataLocation.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="glGetFragDataLocation">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGetFragDataLocation</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGetFragDataLocation</refname>
  17         <refpurpose>query the bindings of color numbers to user-defined varying out variables</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>GLint <function>glGetFragDataLocation</function></funcdef>
  23                 <paramdef>GLuint <parameter>program</parameter></paramdef>
  24                 <paramdef>const char * <parameter>name</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>program</parameter></term>
  32             <listitem>
  33                 <para>
  34                     The name of the program containing varying out variable whose binding to query
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>name</parameter></term>
  40             <listitem>
  41                 <para>
  42                     The name of the user-defined varying out variable whose binding to query
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glGetFragDataLocation</function> retrieves the assigned color number binding for the user-defined
  51             varying out variable <parameter>name</parameter> for program <parameter>program</parameter>. <parameter>program</parameter>
  52             must have previously been linked. <parameter>name</parameter> must be a null-terminated string. If <parameter>name</parameter>
  53             is not the name of an active user-defined varying out fragment shader variable within <parameter>program</parameter>, -1 will
  54             be returned.
  55         </para>
  56     </refsect1>
  57     <refsect1 id="errors"><title>Errors</title>
  58         <para>
  59             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>program</parameter> is not the name of a program object.
  60         </para>
  61     </refsect1>
  62     <refsect1 id="seealso"><title>See Also</title>
  63         <para>
  64             <citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry>,
  65             <citerefentry><refentrytitle>glBindFragDataLocation</refentrytitle></citerefentry>
  66         </para>
  67     </refsect1>
  68     <refsect1 id="Copyright"><title>Copyright</title>
  69         <para>
  70             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  71             This material may be distributed subject to the terms and conditions set forth in
  72             the Open Publication License, v 1.0, 8 June 1999.
  73             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  74         </para>
  75     </refsect1>
  76 </refentry>