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>glGetSubroutineIndex - 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=
"glGetSubroutineIndex"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetSubroutineIndex — retrieve the index of a subroutine uniform of a given shader stage within a program
</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">glGetSubroutineIndex
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">program
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">shadertype
</var>,
</td></tr><tr><td> </td><td>const GLchar *
</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 Specifies the name of the program containing shader stage.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>shadertype
</code></em></span></dt><dd><p>
7 Specifies the shader stage from which to query for subroutine uniform index.
8 <em class=
"parameter"><code>shadertype
</code></em>
9 must be one of
<code class=
"constant">GL_VERTEX_SHADER
</code>,
<code class=
"constant">GL_TESS_CONTROL_SHADER
</code>,
10 <code class=
"constant">GL_TESS_EVALUATION_SHADER
</code>,
<code class=
"constant">GL_GEOMETRY_SHADER
</code> or
11 <code class=
"constant">GL_FRAGMENT_SHADER
</code>.
12 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>name
</code></em></span></dt><dd><p>
13 Specifies the name of the subroutine uniform whose index to query.
14 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
15 <code class=
"function">glGetSubroutineIndex
</code> returns the index of a subroutine uniform within a shader stage attached to a program object.
16 <em class=
"parameter"><code>program
</code></em> contains the name of the program to which the shader is attached.
<em class=
"parameter"><code>shadertype
</code></em>
17 specifies the stage from which to query shader subroutine index.
<em class=
"parameter"><code>name
</code></em> contains the null-terminated
18 name of the subroutine uniform whose name to query.
20 If
<em class=
"parameter"><code>name
</code></em> is not the name of a subroutine uniform in the shader stage,
<code class=
"constant">GL_INVALID_INDEX
</code>
21 is returned, but no error is generated. If
<em class=
"parameter"><code>name
</code></em> is the name of a subroutine uniform in the shader stage,
22 a value between zero and the value of
<code class=
"constant">GL_ACTIVE_SUBROUTINES
</code> minus one will be returned. Subroutine indices
23 are assigned using consecutive integers in the range from zero to the value of
<code class=
"constant">GL_ACTIVE_SUBROUTINES
</code> minus
24 one for the shader stage.
25 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
26 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>shadertype
</code></em> or
<em class=
"parameter"><code>pname
</code></em>
27 is not one of the accepted values.
29 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>program
</code></em> is not the name of an
30 existing program object.
31 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
32 <a href=
"glGetProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetProgram
</span></span></a>,
33 <a href=
"glGetActiveSubroutineUniform.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetActiveSubroutineUniform
</span></span></a>,
34 <a href=
"glGetActiveSubroutineUniformName.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetActiveSubroutineUniformName
</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>
HCoop / clinton / guile-figl.git / blob