rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glUniformBlockBinding.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>glUniformBlockBinding - 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="glUniformBlockBinding"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glUniformBlockBinding — assign a binding point to an active uniform block</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">glUniformBlockBinding</b>(</code></td><td>GLuint  </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">uniformBlockIndex</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">uniformBlockBinding</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 a program object containing the active uniform block whose binding to assign.
6 </p></dd><dt><span class="term"><em class="parameter"><code>uniformBlockIndex</code></em></span></dt><dd><p>
7 The index of the active uniform block within <em class="parameter"><code>program</code></em> whose binding to assign.
8 </p></dd><dt><span class="term"><em class="parameter"><code>uniformBlockBinding</code></em></span></dt><dd><p>
9 Specifies the binding point to which to bind the uniform block with index <em class="parameter"><code>uniformBlockIndex</code></em> within <em class="parameter"><code>program</code></em>.
10 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
11 Binding points for active uniform blocks are assigned using <code class="function">glUniformBlockBinding</code>. Each of a program's active uniform
12 blocks has a corresponding uniform buffer binding point. <em class="parameter"><code>program</code></em> is the name of a program object for which the command
13 <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a> has been issued in the past.
14 </p><p>
15 If successful, <code class="function">glUniformBlockBinding</code> specifies that <em class="parameter"><code>program</code></em> will use the data store of the
16 buffer object bound to the binding point <em class="parameter"><code>uniformBlockBinding</code></em> to extract the values of the uniforms in the
17 uniform block identified by <em class="parameter"><code>uniformBlockIndex</code></em>.
18 </p><p>
19 When a program object is linked or re-linked, the uniform buffer object binding point assigned to each of its active uniform blocks is reset to zero.
20 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
21 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>uniformBlockIndex</code></em> is not an active uniform block index of <em class="parameter"><code>program</code></em>.
22 </p><p>
23 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>uniformBlockBinding</code></em> is greater than or equal to the value of <code class="constant">GL_MAX_UNIFORM_BUFFER_BINDINGS</code>.
24 </p><p>
25 <code class="constant">GL_INVALID_VALUE</code> is generated <em class="parameter"><code>program</code></em> is not the name of a program object generated by the GL.
26 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
27 <code class="function">glUniformBlockBinding</code> is available only if the GL version is 3.1 or greater.
28 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
29 <a href="glGetActiveUniformBlock.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveUniformBlock</span></span></a> with argument <code class="constant">GL_UNIFORM_BLOCK_BINDING</code>
30 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
31 <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>,
32 <a href="glBindBufferBase.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>,
33 <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>,
34 <a href="glGetActiveUniformBlock.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveUniformBlock</span></span></a>
35 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
36 Copyright <span class="trademark"></span>© 2010 Khronos Group.
37 This material may be distributed subject to the terms and conditions set forth in
38 the Open Publication License, v 1.0, 8 June 1999.
39 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
40 </p></div></div></body></html>