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>glGetShader
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.75.2" /></head><body><div class=
"refentry" title=
"glGetShader"><a id=
"glGetShader"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetShaderiv — Returns a parameter from a shader object
</p></div><div class=
"refsynopsisdiv" title=
"C Specification"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0" class=
"funcprototype-table"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetShaderiv
</b>(
</code></td><td>GLuint
<var class=
"pdparam">shader
</var>,
</td></tr><tr><td> </td><td>GLenum
<var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLint *
<var class=
"pdparam">params
</var><code>)
</code>;
</td></tr></table><div class=
"funcprototype-spacer"> </div></div></div><div class=
"refsect1" title=
"Parameters"><a id=
"parameters"></a><h2>Parameters
</h2><div class=
"variablelist"><dl><dt><span class=
"term"><em class=
"parameter"><code>shader
</code></em></span></dt><dd><p>Specifies the shader object to be
5 queried.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>pname
</code></em></span></dt><dd><p>Specifies the object parameter. Accepted
7 <code class=
"constant">GL_SHADER_TYPE
</code>,
8 <code class=
"constant">GL_DELETE_STATUS
</code>,
9 <code class=
"constant">GL_COMPILE_STATUS
</code>,
10 <code class=
"constant">GL_INFO_LOG_LENGTH
</code>,
11 <code class=
"constant">GL_SHADER_SOURCE_LENGTH
</code>.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>params
</code></em></span></dt><dd><p>Returns the requested object parameter.
</p></dd></dl></div></div><div class=
"refsect1" title=
"Description"><a id=
"description"></a><h2>Description
</h2><p><code class=
"function">glGetShader
</code>
12 returns in
<em class=
"parameter"><code>params
</code></em>
13 the value of a parameter for a specific shader object. The
14 following parameters are defined:
</p><div class=
"variablelist"><dl><dt><span class=
"term"><code class=
"constant">GL_SHADER_TYPE
</code></span></dt><dd><p> <em class=
"parameter"><code>params
</code></em> returns
15 <code class=
"constant">GL_VERTEX_SHADER
</code> if
16 <em class=
"parameter"><code>shader
</code></em> is a vertex shader
17 object,
<code class=
"constant">GL_GEOMETRY_SHADER
</code> if
<em class=
"parameter"><code>shader
</code></em>
18 is a geometry shader object, and
<code class=
"constant">GL_FRAGMENT_SHADER
</code>
19 if
<em class=
"parameter"><code>shader
</code></em> is a fragment
20 shader object.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_DELETE_STATUS
</code></span></dt><dd><p> <em class=
"parameter"><code>params
</code></em> returns
21 <code class=
"constant">GL_TRUE
</code> if
22 <em class=
"parameter"><code>shader
</code></em> is currently flagged
23 for deletion, and
<code class=
"constant">GL_FALSE
</code>
24 otherwise.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_COMPILE_STATUS
</code></span></dt><dd><p> <em class=
"parameter"><code>params
</code></em> returns
25 <code class=
"constant">GL_TRUE
</code> if the last compile
26 operation on
<em class=
"parameter"><code>shader
</code></em> was
27 successful, and
<code class=
"constant">GL_FALSE
</code>
28 otherwise.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_INFO_LOG_LENGTH
</code></span></dt><dd><p> <em class=
"parameter"><code>params
</code></em> returns the
29 number of characters in the information log for
30 <em class=
"parameter"><code>shader
</code></em> including the null
31 termination character (i.e., the size of the
32 character buffer required to store the information
33 log). If
<em class=
"parameter"><code>shader
</code></em> has no
34 information log, a value of
0 is returned.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_SHADER_SOURCE_LENGTH
</code></span></dt><dd><p> <em class=
"parameter"><code>params
</code></em> returns the
35 length of the concatenation of the source strings
36 that make up the shader source for the
37 <em class=
"parameter"><code>shader
</code></em>, including the null
38 termination character. (i.e., the size of the
39 character buffer required to store the shader
40 source). If no source code exists,
0 is
41 returned.
</p></dd></dl></div></div><div class=
"refsect1" title=
"Notes"><a id=
"notes"></a><h2>Notes
</h2><p>If an error is generated, no change is made to the
42 contents of
<em class=
"parameter"><code>params
</code></em>.
</p></div><div class=
"refsect1" title=
"Errors"><a id=
"errors"></a><h2>Errors
</h2><p><code class=
"constant">GL_INVALID_VALUE
</code> is generated if
43 <em class=
"parameter"><code>shader
</code></em> is not a value generated by
44 OpenGL.
</p><p><code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
45 <em class=
"parameter"><code>shader
</code></em> does not refer to a shader
46 object.
</p><p><code class=
"constant">GL_INVALID_ENUM
</code> is generated if
47 <em class=
"parameter"><code>pname
</code></em> is not an accepted value.
</p></div><div class=
"refsect1" title=
"Associated Gets"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p><a class=
"citerefentry" href=
"glGetShaderInfoLog.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetShaderInfoLog
</span></span></a>
48 with argument
<em class=
"parameter"><code>shader
</code></em></p><p><a class=
"citerefentry" href=
"glGetShaderSource.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetShaderSource
</span></span></a>
49 with argument
<em class=
"parameter"><code>shader
</code></em></p><p><a class=
"citerefentry" href=
"glIsShader.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIsShader
</span></span></a></p></div><div class=
"refsect1" title=
"See Also"><a id=
"seealso"></a><h2>See Also
</h2><p><a class=
"citerefentry" href=
"glCompileShader.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompileShader
</span></span></a>,
50 <a class=
"citerefentry" href=
"glCreateShader.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCreateShader
</span></span></a>,
51 <a class=
"citerefentry" href=
"glDeleteShader.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDeleteShader
</span></span></a>,
52 <a class=
"citerefentry" href=
"glGetProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetProgram
</span></span></a>,
53 <a class=
"citerefentry" href=
"glShaderSource.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glShaderSource
</span></span></a></p></div><div class=
"refsect1" title=
"Copyright"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
54 Copyright
<span class=
"trademark"></span>©
2003-
2005 3Dlabs Inc. Ltd.
55 This material may be distributed subject to the terms and conditions set forth in
56 the Open Publication License, v
1.0,
8 June
1999.
57 <a class=
"ulink" href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
58 </p></div></div></body></html>