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>glGetUniformBlockIndex - 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=
"glGetUniformBlockIndex"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetUniformBlockIndex — retrieve the index of a named 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">GLuint
<b class=
"fsfunc">glGetUniformBlockIndex
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">program
</var>,
</td></tr><tr><td> </td><td>const GLchar *
</td><td><var class=
"pdparam">uniformBlockName
</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 Specifies the name of a program containing the uniform block.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>uniformBlockName
</code></em></span></dt><dd><p>
7 Specifies the address an array of characters to containing the name of the uniform block whose index to retrieve.
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">glGetUniformBlockIndex
</code> retrieves the index of a uniform block within
<em class=
"parameter"><code>program
</code></em>.
11 <em class=
"parameter"><code>program
</code></em> must be the name of a program object for which the command
12 <a href=
"glLinkProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glLinkProgram
</span></span></a> must have been called in the past, although it is not required that
13 <a href=
"glLinkProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glLinkProgram
</span></span></a> must have succeeded. The link could have failed because the number
14 of active uniforms exceeded the limit.
16 <em class=
"parameter"><code>uniformBlockName
</code></em> must contain a nul-terminated string specifying the name of the uniform block.
18 <code class=
"function">glGetUniformBlockIndex
</code> returns the uniform block index for the uniform block named
<em class=
"parameter"><code>uniformBlockName
</code></em>
19 of
<em class=
"parameter"><code>program
</code></em>. If
<em class=
"parameter"><code>uniformBlockName
</code></em> does not identify an active uniform block of
<em class=
"parameter"><code>program
</code></em>,
20 <code class=
"function">glGetUniformBlockIndex
</code> returns the special identifier,
<code class=
"constant">GL_INVALID_INDEX
</code>. Indices of the active uniform
21 blocks of a program are assigned in consecutive order, beginning with zero.
22 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
23 <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 for which
24 <a href=
"glLinkProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glLinkProgram
</span></span></a> has been called in the past.
25 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p>
26 <code class=
"function">glGetUniformBlockIndex
</code> is available only if the GL version is
3.1 or greater.
27 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
28 <a href=
"glGetActiveUniformBlockName.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetActiveUniformBlockName
</span></span></a>,
29 <a href=
"glGetActiveUniformBlock.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetActiveUniformBlock
</span></span></a>,
30 <a href=
"glLinkProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glLinkProgram
</span></span></a>
31 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
32 Copyright
<span class=
"trademark"></span>©
2010 Khronos Group.
33 This material may be distributed subject to the terms and conditions set forth in
34 the Open Publication License, v
1.0,
8 June
1999.
35 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
36 </p></div></div></body></html>