rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glUniformSubroutines.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>glUniformSubroutines - 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="glUniformSubroutines"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glUniformSubroutines — load active subroutine uniforms</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">glUniformSubroutinesuiv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">shadertype</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>const GLuint * </td><td><var class="pdparam">indices</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>shadertype</code></em></span></dt><dd><p>
5 Specifies the shader stage from which to query for subroutine uniform index.
6 <em class="parameter"><code>shadertype</code></em>
7 must be one of <code class="constant">GL_VERTEX_SHADER</code>, <code class="constant">GL_TESS_CONTROL_SHADER</code>,
8 <code class="constant">GL_TESS_EVALUATION_SHADER</code>, <code class="constant">GL_GEOMETRY_SHADER</code> or
9 <code class="constant">GL_FRAGMENT_SHADER</code>.
10 </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
11 Specifies the number of uniform indices stored in <em class="parameter"><code>indices</code></em>.
12 </p></dd><dt><span class="term"><em class="parameter"><code>indices</code></em></span></dt><dd><p>
13 Specifies the address of an array holding the indices to load into the shader subroutine variables.
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">glUniformSubroutines</code> loads all active subroutine uniforms for shader stage
16 <em class="parameter"><code>shadertype</code></em> of the current program with subroutine indices from <em class="parameter"><code>indices</code></em>,
17 storing <em class="parameter"><code>indices[i]</code></em> into the uniform at location <em class="parameter"><code>i</code></em>.
18 <em class="parameter"><code>count</code></em> must be equal to the value of <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_LOCATIONS</code>
19 for the program currently in use at shader stage <em class="parameter"><code>shadertype</code></em>. Furthermore, all values in
20 <em class="parameter"><code>indices</code></em> must be less than the value of <code class="constant">GL_ACTIVE_SUBROUTINES</code>
21 for the shader stage.
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 no program object is current.
24 </p><p>
25 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>count</code></em> is not equal to the value
26 of <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_LOCATIONS</code> for the shader stage <em class="parameter"><code>shadertype</code></em>
27 of the current program.
28 </p><p>
29 <code class="constant">GL_INVALID_VALUE</code> is generated if any value in <em class="parameter"><code>indices</code></em> is geater
30 than or equal to the value of <code class="constant">GL_ACTIVE_SUBROUTINES</code> for the shader stage <em class="parameter"><code>shadertype</code></em>
31 of the current program.
32 </p><p>
33 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>shadertype</code></em> is not one of the accepted values.
34 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
35 <a href="glGetProgramStage.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramStage</span></span></a> with argument <code class="constant">GL_ACTIVE_SUBROUTINES</code>
36 </p><p>
37 <a href="glGetProgramStage.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramStage</span></span></a> with argument <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_LOCATIONS</code>
38 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
39 <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
40 <a href="glGetActiveSubroutineUniform.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniform</span></span></a>,
41 <a href="glGetActiveSubroutineUniformName.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniformName</span></span></a>,
42 <a href="glGetProgramStage.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramStage</span></span></a>
43 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
44 Copyright <span class="trademark"></span>© 2010 Khronos Group.
45 This material may be distributed subject to the terms and conditions set forth in
46 the Open Publication License, v 1.0, 8 June 1999.
47 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
48 </p></div></div></body></html>