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>glGetAttachedShaders</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetAttachedShaders"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetAttachedShaders — Returns the handles of the shader objects attached to a program object</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">glGetAttachedShaders</b>(</code></td><td>GLuint </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">maxCount</var>, </td></tr><tr><td> </td><td>GLsizei * </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>GLuint * </td><td><var class="pdparam">shaders</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>Specifies the program object to be | |
5 | queried.</p></dd><dt><span class="term"><em class="parameter"><code>maxCount</code></em></span></dt><dd><p>Specifies the size of the array for storing | |
6 | the returned object names.</p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>Returns the number of names actually returned | |
7 | in <em class="parameter"><code>objects</code></em>.</p></dd><dt><span class="term"><em class="parameter"><code>shaders</code></em></span></dt><dd><p>Specifies an array that is used to return the | |
8 | names of attached shader objects.</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p><code class="function">glGetAttachedShaders</code> returns the | |
9 | names of the shader objects attached to | |
10 | <em class="parameter"><code>program</code></em>. The names of shader objects that | |
11 | are attached to <em class="parameter"><code>program</code></em> will be returned | |
12 | in <em class="parameter"><code>shaders.</code></em> The actual number of shader | |
13 | names written into <em class="parameter"><code>shaders</code></em> is returned in | |
14 | <em class="parameter"><code>count.</code></em> If no shader objects are attached | |
15 | to <em class="parameter"><code>program</code></em>, <em class="parameter"><code>count</code></em> | |
16 | is set to 0. The maximum number of shader names that may be | |
17 | returned in <em class="parameter"><code>shaders</code></em> is specified by | |
18 | <em class="parameter"><code>maxCount</code></em>. </p><p>If the number of names actually returned is not required | |
19 | (for instance, if it has just been obtained by calling | |
20 | <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>), | |
21 | a value of <code class="constant">NULL</code> may be passed for count. If | |
22 | no shader objects are attached to | |
23 | <em class="parameter"><code>program</code></em>, a value of 0 will be returned in | |
24 | <em class="parameter"><code>count</code></em>. The actual number of attached | |
25 | shaders can be obtained by calling | |
26 | <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a> | |
27 | with the value <code class="constant">GL_ATTACHED_SHADERS</code>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_VALUE</code> is generated if | |
28 | <em class="parameter"><code>program</code></em> is not a value generated by | |
29 | OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if | |
30 | <em class="parameter"><code>program</code></em> is not a program object.</p><p><code class="constant">GL_INVALID_VALUE</code> is generated if | |
31 | <em class="parameter"><code>maxCount</code></em> is less than 0.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a> | |
32 | with argument <code class="constant">GL_ATTACHED_SHADERS</code></p><p><a href="glIsProgram.xml"><span class="citerefentry"><span class="refentrytitle">glIsProgram</span></span></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p><a href="glAttachShader.xml"><span class="citerefentry"><span class="refentrytitle">glAttachShader</span></span></a>, | |
33 | <a href="glDetachShader.xml"><span class="citerefentry"><span class="refentrytitle">glDetachShader</span></span></a></p>. | |
34 | </div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
35 | Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd. | |
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> |