HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
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>glBindFragDataLocation - 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="glBindFragDataLocation"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBindFragDataLocation — bind a user-defined varying out variable to a fragment shader color number</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">void <b class="fsfunc">glBindFragDataLocation</b>(</code></td><td>GLuint </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLuint </td><td><var class="pdparam">colorNumber</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 modify | |
| 6 | </p></dd><dt><span class="term"><em class="parameter"><code>colorNumber</code></em></span></dt><dd><p> | |
| 7 | The color number to bind the user-defined varying out variable to | |
| 8 | </p></dd><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p> | |
| 9 | The name of the user-defined varying out variable whose binding to modify | |
| 10 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
| 11 | <code class="function">glBindFragDataLocation</code> explicitly specifies the binding of the user-defined varying out variable | |
| 12 | <em class="parameter"><code>name</code></em> to fragment shader color number <em class="parameter"><code>colorNumber</code></em> for program | |
| 13 | <em class="parameter"><code>program</code></em>. If <em class="parameter"><code>name</code></em> was bound previously, its assigned binding is replaced | |
| 14 | with <em class="parameter"><code>colorNumber</code></em>. <em class="parameter"><code>name</code></em> must be a null-terminated string. <em class="parameter"><code>colorNumber</code></em> | |
| 15 | must be less than <code class="constant">GL_MAX_DRAW_BUFFERS</code>. | |
| 16 | </p><p> | |
| 17 | The bindings specified by <code class="function">glBindFragDataLocation</code> have no effect until <em class="parameter"><code>program</code></em> | |
| 18 | is next linked. Bindings may be specified at any time after <em class="parameter"><code>program</code></em> has been created. Specifically, | |
| 19 | they may be specified before shader objects are attached to the program. Therefore, any name may be specified in <em class="parameter"><code>name</code></em>, | |
| 20 | including a name that is never used as a varying out variable in any fragment shader object. Names beginning with <code class="constant">gl_</code> are | |
| 21 | reserved by the GL. | |
| 22 | </p><p> | |
| 23 | In addition to the errors generated by <code class="function">glBindFragDataLocation</code>, the | |
| 24 | program <em class="parameter"><code>program</code></em> will fail to link if: | |
| 25 | </p><div class="itemizedlist"><ul type="disc"><li><p> | |
| 26 | The number of active outputs is greater than the value <code class="constant">GL_MAX_DRAW_BUFFERS</code>. | |
| 27 | </p></li><li><p> | |
| 28 | More than one varying out variable is bound to the same color number. | |
| 29 | </p></li></ul></div><p> | |
| 30 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
| 31 | Varying out varyings may have indexed locations assigned explicitly in the shader text using a <code class="code">location</code> | |
| 32 | layout qualifier. If a shader statically assigns a location to a varying out variable in the shader text, | |
| 33 | that location is used and any location assigned with <code class="function">glBindFragDataLocation</code> is ignored. | |
| 34 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
| 35 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>colorNumber</code></em> is greater than or equal to <code class="constant">GL_MAX_DRAW_BUFFERS</code>. | |
| 36 | </p><p> | |
| 37 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>name</code></em> starts with the reserved <code class="constant">gl_</code> prefix. | |
| 38 | </p><p> | |
| 39 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">program</code> is not the name of a program object. | |
| 40 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
| 41 | <a href="glGetFragDataLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetFragDataLocation</span></span></a> with a valid program object | |
| 42 | and the the name of a user-defined varying out variable | |
| 43 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
| 44 | <a href="glCreateProgram.xml"><span class="citerefentry"><span class="refentrytitle">glCreateProgram</span></span></a>, | |
| 45 | <a href="glGetFragDataLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetFragDataLocation</span></span></a> | |
| 46 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 47 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
| 48 | This material may be distributed subject to the terms and conditions set forth in | |
| 49 | the Open Publication License, v 1.0, 8 June 1999. | |
| 50 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 51 | </p></div></div></body></html> |