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>glGetActiveSubroutineName - 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="glGetActiveSubroutineName"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetActiveSubroutineName — query the name of an active shader subroutine</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">glGetActiveSubroutineName</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 the subroutine name. | |
8 | </p></dd><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p> | |
9 | Specifies the index of the shader subroutine uniform. | |
10 | </p></dd><dt><span class="term"><em class="parameter"><code>bufsize</code></em></span></dt><dd><p> | |
11 | Specifies the size of the buffer whose address is given in <em class="parameter"><code>name</code></em>. | |
12 | </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p> | |
13 | Specifies the address of a variable which is to receive the length of the shader subroutine uniform name. | |
14 | </p></dd><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p> | |
15 | Specifies the address of an array into which the name of the shader subroutine uniform will be written. | |
16 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
17 | <code class="function">glGetActiveSubroutineName</code> queries the name of an active shader subroutine uniform from the | |
18 | program object given in <em class="parameter"><code>program</code></em>. <em class="parameter"><code>index</code></em> specifies the index of | |
19 | the shader subroutine uniform within the shader stage given by <em class="parameter"><code>stage</code></em>, and must between | |
20 | zero and the value of <code class="constant">GL_ACTIVE_SUBROUTINES</code> minus one for the shader stage. | |
21 | </p><p> | |
22 | The name of the selected subroutine is returned as a null-terminated string in <em class="parameter"><code>name</code></em>. The | |
23 | actual number of characters written into <em class="parameter"><code>name</code></em>, not including the null-terminator, is | |
24 | is returned in <em class="parameter"><code>length</code></em>. If <em class="parameter"><code>length</code></em> is <code class="constant">NULL</code>, | |
25 | no length is returned. The maximum number of characters that may be written into <em class="parameter"><code>name</code></em>, | |
26 | including the null-terminator, is given in <em class="parameter"><code>bufsize</code></em>. | |
27 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
28 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater than or equal to | |
29 | the value of <code class="constant">GL_ACTIVE_SUBROUTINES</code>. | |
30 | </p><p> | |
31 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>program</code></em> is not the name of an | |
32 | existing program object. | |
33 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
34 | <a href="glGetProgramStage.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramStage</span></span></a> with argument <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_MAX_LENGTH</code> | |
35 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
36 | <a href="glGetSubroutineIndex.xml"><span class="citerefentry"><span class="refentrytitle">glGetSubroutineIndex</span></span></a>, | |
37 | <a href="glGetActiveSubroutineUniform.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniform</span></span></a>, | |
38 | <a href="glGetProgramStage.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramStage</span></span></a> | |
39 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
40 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
41 | This material may be distributed subject to the terms and conditions set forth in | |
42 | the Open Publication License, v 1.0, 8 June 1999. | |
43 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
44 | </p></div></div></body></html> |