rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man2 / xhtml / glGetAttachedShaders.xml
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
2 <!-- saved from url=(0013)about:internet -->
3 <?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" /><title>glGetAttachedShaders</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></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
4 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
5 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
6 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
7 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
8 names of the shader objects attached to
9 <em class="parameter"><code>program</code></em>. The names of shader objects that
10 are attached to <em class="parameter"><code>program</code></em> will be returned
11 in <em class="parameter"><code>shaders.</code></em> The actual number of shader
12 names written into <em class="parameter"><code>shaders</code></em> is returned in
13 <em class="parameter"><code>count.</code></em> If no shader objects are attached
14 to <em class="parameter"><code>program</code></em>, <em class="parameter"><code>count</code></em>
15 is set to 0. The maximum number of shader names that may be
16 returned in <em class="parameter"><code>shaders</code></em> is specified by
17 <em class="parameter"><code>maxCount</code></em>. </p><p>If the number of names actually returned is not required
18 (for instance, if it has just been obtained by calling
19 <a class="citerefentry" href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>),
20 a value of <code class="constant">NULL</code> may be passed for count. If
21 no shader objects are attached to
22 <em class="parameter"><code>program</code></em>, a value of 0 will be returned in
23 <em class="parameter"><code>count</code></em>. The actual number of attached
24 shaders can be obtained by calling
25 <a class="citerefentry" href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>
26 with the value <code class="constant">GL_ATTACHED_SHADERS</code>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p><code class="function">glGetAttachedShaders</code>
27 is available only if the GL version is 2.0 or greater.</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><p><code class="constant">GL_INVALID_OPERATION</code> is generated if
32 <a class="citerefentry" href="glGetAttachedShaders.xml"><span class="citerefentry"><span class="refentrytitle">glGetAttachedShaders</span></span></a>
33 is executed between the execution of
34 <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
35 and the corresponding execution of
36 <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a class="citerefentry" href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>
37 with argument <code class="constant">GL_ATTACHED_SHADERS</code></p><p><a class="citerefentry" 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 class="citerefentry" href="glAttachShader.xml"><span class="citerefentry"><span class="refentrytitle">glAttachShader</span></span></a>,
38 <a class="citerefentry" href="glDetachShader.xml"><span class="citerefentry"><span class="refentrytitle">glDetachShader</span></span></a></p>.
39 </div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
40 Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd.
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 class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
44 </p></div></div></body></html>