upstream-doc/man4/xhtml/glGetUniformSubroutine.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>glGetUniformSubroutine - 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="glGetUniformSubroutine"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetUniformSubroutine — retrieve the value of a subroutine uniform of a given shader stage of the current 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">void <b class="fsfunc">glGetUniformSubroutineuiv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">shadertype</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">location</var>, </td></tr><tr><td> </td><td>GLuint * </td><td><var class="pdparam">values</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>location</code></em></span></dt><dd><p>
  11                     Specifies the location of the subroutine uniform.
  12                 </p></dd><dt><span class="term"><em class="parameter"><code>values</code></em></span></dt><dd><p>
  13                     Specifies the address of a variable to receive the value or values of the subroutine uniform.
  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">glGetUniformSubroutine</code> retrieves the value of the subroutine uniform at location
  16             <em class="parameter"><code>location</code></em> for shader stage <em class="parameter"><code>shadertype</code></em> of the current
  17             program. <em class="parameter"><code>location</code></em> must be less than the value of
  18             <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_LOCATIONS</code> for the shader currently in use at
  19             shader stage <em class="parameter"><code>shadertype</code></em>. The value of the subroutine uniform is returned in
  20             <em class="parameter"><code>values</code></em>.
  21         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  22             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>shadertype</code></em> is not one of the accepted values.
  23         </p><p>
  24             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>location</code></em> is greater than or equal to
  25             the value of <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_LOCATIONS</code> for the shader currently in use at
  26             shader stage <em class="parameter"><code>shadertype</code></em>.
  27         </p><p>
  28             <code class="constant">GL_INVALID_OPERATION</code> is generated if no program is active.
  29         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  30             <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
  31             <a href="glGetActiveSubroutineUniform.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniform</span></span></a>,
  32             <a href="glGetActiveSubroutineUniformName.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniformName</span></span></a>,
  33             <a href="glGetUniformLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetUniformLocation</span></span></a>
  34         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  35             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  36             This material may be distributed subject to the terms and conditions set forth in
  37             the Open Publication License, v 1.0, 8 June 1999.
  38             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  39         </p></div></div></body></html>