upstream-doc/man4/xhtml/glBindFragDataLocationIndexed.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>glBindFragDataLocationIndexed - 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="glBindFragDataLocationIndexed"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBindFragDataLocationIndexed — bind a user-defined varying out variable to a fragment shader color number and index</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">glBindFragDataLocationIndexed</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>GLuint  </td><td><var class="pdparam">index</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>index</code></em></span></dt><dd><p>
   9                     The index of the color input to bind the user-defined varying out variable to
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
  11                     The name of the user-defined varying out variable whose binding to modify
  12                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  13             <code class="function">glBindFragDataLocationIndexed</code> specifies that the varying out variable <em class="parameter"><code>name</code></em> in
  14             <em class="parameter"><code>program</code></em> should be bound to fragment color <em class="parameter"><code>colorNumber</code></em> when the program is next
  15             linked. <em class="parameter"><code>index</code></em> may be zero or one to specify that the color be used as either the first or second color
  16             input to the blend equation, respectively.
  17         </p><p>
  18             The bindings specified by <code class="function">glBindFragDataLocationIndexed</code> have no effect until <em class="parameter"><code>program</code></em>
  19             is next linked. Bindings may be specified at any time after <em class="parameter"><code>program</code></em> has been created. Specifically,
  20             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>,
  21             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
  22             reserved by the GL.
  23         </p><p>
  24             If <em class="parameter"><code>name</code></em> was bound previously, its assigned binding is replaced with <em class="parameter"><code>colorNumber</code></em> and
  25             <em class="parameter"><code>index</code></em>. <em class="parameter"><code>name</code></em> must be a null-terminated string. <em class="parameter"><code>index</code></em> must be less than or equal to one,
  26             and <em class="parameter"><code>colorNumber</code></em> must be less than the value of <code class="constant">GL_MAX_DRAW_BUFFERS</code> if <em class="parameter"><code>index</code></em>
  27             is zero, and less than the value of <code class="constant">GL_MAX_DUAL_SOURCE_DRAW_BUFFERS</code> if index is greater than or equal to one.
  28         </p><p>
  29             In addition to the errors generated by <code class="function">glBindFragDataLocationIndexed</code>, the
  30             program <em class="parameter"><code>program</code></em> will fail to link if:
  31             </p><div class="itemizedlist"><ul type="disc"><li><p>
  32                         The number of active outputs is greater than the value <code class="constant">GL_MAX_DRAW_BUFFERS</code>.
  33                     </p></li><li><p>
  34                         More than one varying out variable is bound to the same color number.
  35                     </p></li></ul></div><p>
  36         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  37             Varying out varyings may have locations assigned explicitly in the shader text using a <code class="code">location</code>
  38             layout qualifier. If a shader statically assigns a location to a varying out variable in the shader text,
  39             that location is used and any location assigned with <code class="function">glBindFragDataLocation</code> is ignored.
  40         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  41             <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>.
  42         </p><p>
  43             <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_DUAL_SOURCE_DRAW_BUFFERS</code>
  44             and <em class="parameter"><code>index</code></em> is greater than or equal to one.
  45         </p><p>
  46             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater than one.
  47         </p><p>
  48             <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.
  49         </p><p>
  50             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">program</code> is not the name of a program object.
  51         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  52             <a href="glGetFragDataLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetFragDataLocation</span></span></a> with a valid program object
  53             and the the name of a user-defined varying out variable
  54         </p><p>
  55             <a href="glGetFragDataIndex.xml"><span class="citerefentry"><span class="refentrytitle">glGetFragDataIndex</span></span></a> with a valid program object
  56             and the the name of a user-defined varying out variable
  57         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  58             <a href="glCreateProgram.xml"><span class="citerefentry"><span class="refentrytitle">glCreateProgram</span></span></a>,
  59             <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>
  60             <a href="glGetFragDataLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetFragDataLocation</span></span></a>,
  61             <a href="glGetFragDataIndex.xml"><span class="citerefentry"><span class="refentrytitle">glGetFragDataIndex</span></span></a>
  62             <a href="glBindFragDataLocation.xml"><span class="citerefentry"><span class="refentrytitle">glBindFragDataLocation</span></span></a>
  63         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  64             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  65             This material may be distributed subject to the terms and conditions set forth in
  66             the Open Publication License, v 1.0, 8 June 1999.
  67             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  68         </p></div></div></body></html>