forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glGetAttachedShaders.xhtml
38 lines (38 loc) · 5.16 KB
/
glGetAttachedShaders.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<div class="refentry"><a id="glGetAttachedShaders"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetAttachedShaders — return the handles of the shader objects attached to a program object</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetAttachedShaders</strong>(</code></td><td>GLuint <var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">maxCount</var>, </td></tr><tr><td> </td><td>GLsizei *<var class="pdparam">count</var>, </td></tr><tr><td> </td><td>GLuint *<var class="pdparam">shaders</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>program</code></em></span></dt><dd><p>Specifies the program object to be
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
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
in <em class="parameter"><code>shaders</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
names of attached shader objects.</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p><code class="function">glGetAttachedShaders</code> returns the
names of the shader objects attached to
<em class="parameter"><code>program</code></em>. The names of shader objects that
are attached to <em class="parameter"><code>program</code></em> will be returned
in <em class="parameter"><code>shaders.</code></em> The actual number of shader
names written into <em class="parameter"><code>shaders</code></em> is returned in
<em class="parameter"><code>count.</code></em> If no shader objects are attached
to <em class="parameter"><code>program</code></em>, <em class="parameter"><code>count</code></em>
is set to 0. The maximum number of shader names that may be
returned in <em class="parameter"><code>shaders</code></em> is specified by
<em class="parameter"><code>maxCount</code></em>. </p><p>If the number of names actually returned is not required
(for instance, if it has just been obtained by calling
<a class="citerefentry" href="glGetProgramiv"><span class="citerefentry"><span class="refentrytitle">glGetProgramiv</span></span></a>),
a value of <code class="constant">NULL</code> may be passed for count. If
no shader objects are attached to
<em class="parameter"><code>program</code></em>, a value of 0 will be returned in
<em class="parameter"><code>count</code></em>. The actual number of attached
shaders can be obtained by calling
<a class="citerefentry" href="glGetProgramiv"><span class="citerefentry"><span class="refentrytitle">glGetProgramiv</span></span></a>
with the value <code class="constant">GL_ATTACHED_SHADERS</code>.</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_VALUE</code> is generated if
<em class="parameter"><code>program</code></em> is not a value generated by
OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if
<em class="parameter"><code>program</code></em> is not a program object.</p><p><code class="constant">GL_INVALID_VALUE</code> is generated if
<em class="parameter"><code>maxCount</code></em> is less than 0.</p></div><div class="refsect1"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a class="citerefentry" href="glGetProgramiv"><span class="citerefentry"><span class="refentrytitle">glGetProgramiv</span></span></a>
with argument <code class="constant">GL_ATTACHED_SHADERS</code></p><p><a class="citerefentry" href="glIsProgram"><span class="citerefentry"><span class="refentrytitle">glIsProgram</span></span></a></p></div>
{$pipelinestall}{$examples}
<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p><a class="citerefentry" href="glAttachShader"><span class="citerefentry"><span class="refentrytitle">glAttachShader</span></span></a>,
<a class="citerefentry" href="glDetachShader"><span class="citerefentry"><span class="refentrytitle">glDetachShader</span></span></a></p>.
</div><div class="refsect1"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 2003-2005 3Dlabs Inc. Ltd.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="ulink" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p></div></div></div>