rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glGetFragDataIndex.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glGetFragDataIndex - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetFragDataIndex"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetFragDataIndex — query the bindings of color indices to user-defined varying out variables</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">GLint <b class="fsfunc">glGetFragDataIndex</b>(</code></td><td>GLuint  </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>const char *  </td><td><var class="pdparam">name</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>program</code></em></span></dt><dd><p>
5 The name of the program containing varying out variable whose binding to query
6 </p></dd><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
7 The name of the user-defined varying out variable whose index to query
8 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
9 <code class="function">glGetFragDataIndex</code> returns the index of the fragment color to which the variable <em class="parameter"><code>name</code></em>
10 was bound when the program object <em class="parameter"><code>program</code></em> was last linked. If <em class="parameter"><code>name</code></em> is not a varying out
11 variable of <em class="parameter"><code>program</code></em>, or if an error occurs, -1 will be returned.
12 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
13 <code class="function">glGetFragDataIndex</code> is available only if the GL version is 3.3 or greater.
14 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
15 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>program</code></em> is not the name of a program object.
16 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
17 <a href="glCreateProgram.xml"><span class="citerefentry"><span class="refentrytitle">glCreateProgram</span></span></a>,
18 <a href="glBindFragDataLocation.xml"><span class="citerefentry"><span class="refentrytitle">glBindFragDataLocation</span></span></a>,
19 <a href="glBindFragDataLocationIndexed.xml"><span class="citerefentry"><span class="refentrytitle">glBindFragDataLocationIndexed</span></span></a>,
20 <a href="glGetFragDataLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetFragDataLocation</span></span></a>
21 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
22 Copyright <span class="trademark"></span>© 2010 Khronos Group.
23 This material may be distributed subject to the terms and conditions set forth in
24 the Open Publication License, v 1.0, 8 June 1999.
25 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
26 </p></div></div></body></html>