Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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>glGetActiveSubroutineUniformName - 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="glGetActiveSubroutineUniformName"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetActiveSubroutineUniformName — query the name of an active shader subroutine uniform</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">glGetActiveSubroutineUniformName</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>GLuint </td><td><var class="pdparam">index</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">bufsize</var>, </td></tr><tr><td> </td><td>GLsizei * </td><td><var class="pdparam">length</var>, </td></tr><tr><td> </td><td>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 the subroutine. | |
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 the subroutine parameter. <em class="parameter"><code>shadertype</code></em> | |
8 | must be one of <code class="constant">GL_VERTEX_SHADER</code>, <code class="constant">GL_TESS_CONTROL_SHADER</code>, | |
9 | <code class="constant">GL_TESS_EVALUATION_SHADER</code>, <code class="constant">GL_GEOMETRY_SHADER</code> or | |
10 | <code class="constant">GL_FRAGMENT_SHADER</code>. | |
11 | </p></dd><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p> | |
12 | Specifies the index of the shader subroutine uniform. | |
13 | </p></dd><dt><span class="term"><em class="parameter"><code>bufsize</code></em></span></dt><dd><p> | |
14 | Specifies the size of the buffer whose address is given in <em class="parameter"><code>name</code></em>. | |
15 | </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p> | |
16 | Specifies the address of a variable into which is written the number of characters copied into <em class="parameter"><code>name</code></em>. | |
17 | </p></dd><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p> | |
18 | Specifies the address of a buffer that will receive the name of the specified shader subroutine uniform. | |
19 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
20 | <code class="function">glGetActiveSubroutineUniformName</code> retrieves the name of an active shader subroutine uniform. | |
21 | <em class="parameter"><code>program</code></em> contains the name of the program containing the uniform. <em class="parameter"><code>shadertype</code></em> | |
22 | specifies the stage for which which the uniform location, given by <em class="parameter"><code>index</code></em>, is valid. <em class="parameter"><code>index</code></em> | |
23 | must be between zero and the value of <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORMS</code> minus one for the | |
24 | shader stage. | |
25 | </p><p> | |
26 | The uniform name is returned as a null-terminated string in <em class="parameter"><code>name</code></em>. The actual number of characters | |
27 | written into <em class="parameter"><code>name</code></em>, excluding the null terminator is returned in <em class="parameter"><code>length</code></em>. | |
28 | If <em class="parameter"><code>length</code></em> is <code class="constant">NULL</code>, no length is returned. The maximum number of characters | |
29 | that may be written into <em class="parameter"><code>name</code></em>, including the null terminator, is specified by <em class="parameter"><code>bufsize</code></em>. | |
30 | The length of the longest subroutine uniform name in <em class="parameter"><code>program</code></em> and <em class="parameter"><code>shadertype</code></em> is given | |
31 | by the value of <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_MAX_LENGTH</code>, which can be queried with | |
32 | <a href="glGetProgramStage.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramStage</span></span></a>. | |
33 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
34 | <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> | |
35 | is not one of the accepted values. | |
36 | </p><p> | |
37 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater than or equal to | |
38 | the value of <code class="constant">GL_ACTIVE_SUBROUTINES</code>. | |
39 | </p><p> | |
40 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>program</code></em> is not the name of an | |
41 | existing program object. | |
42 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
43 | <a href="glGetProgramStage.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramStage</span></span></a> with argument <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORMS</code> | |
44 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
45 | <a href="glGetSubroutineIndex.xml"><span class="citerefentry"><span class="refentrytitle">glGetSubroutineIndex</span></span></a>, | |
46 | <a href="glGetActiveSubroutineUniform.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniform</span></span></a>, | |
47 | <a href="glGetProgramStage.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramStage</span></span></a> | |
48 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
49 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
50 | This material may be distributed subject to the terms and conditions set forth in | |
51 | the Open Publication License, v 1.0, 8 June 1999. | |
52 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
53 | </p></div></div></body></html> |