Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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>glGetProgram</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetProgram"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetProgramiv — Returns a parameter from 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">glGetProgramiv</b>(</code></td><td>GLuint </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint * </td><td><var class="pdparam">params</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>pname</code></em></span></dt><dd><p>Specifies the object parameter. Accepted | |
5 | symbolic names are | |
6 | <code class="constant">GL_DELETE_STATUS</code>, | |
7 | <code class="constant">GL_LINK_STATUS</code>, | |
8 | <code class="constant">GL_VALIDATE_STATUS</code>, | |
9 | <code class="constant">GL_INFO_LOG_LENGTH</code>, | |
10 | <code class="constant">GL_ATTACHED_SHADERS</code>, | |
11 | <code class="constant">GL_ACTIVE_ATTRIBUTES</code>, | |
12 | <code class="constant">GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</code>, | |
13 | <code class="constant">GL_ACTIVE_UNIFORMS</code>, | |
14 | <code class="constant">GL_ACTIVE_UNIFORM_MAX_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" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p><code class="function">glGetProgram</code> | |
15 | returns in <em class="parameter"><code>params</code></em> | |
16 | the value of a parameter for a specific program object. The following parameters are defined:</p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_DELETE_STATUS</code></span></dt><dd><p> | |
17 | </p><p> <em class="parameter"><code>params</code></em> returns | |
18 | <code class="constant">GL_TRUE</code> if | |
19 | <em class="parameter"><code>program</code></em> is currently flagged | |
20 | for deletion, and <code class="constant">GL_FALSE</code> | |
21 | otherwise.</p></dd><dt><span class="term"><code class="constant">GL_LINK_STATUS</code></span></dt><dd><p> | |
22 | </p><p> <em class="parameter"><code>params</code></em> returns | |
23 | <code class="constant">GL_TRUE</code> if the last link | |
24 | operation on <em class="parameter"><code>program</code></em> was | |
25 | successful, and <code class="constant">GL_FALSE</code> | |
26 | otherwise.</p></dd><dt><span class="term"><code class="constant">GL_VALIDATE_STATUS</code></span></dt><dd><p> | |
27 | </p><p> <em class="parameter"><code>params</code></em> returns | |
28 | <code class="constant">GL_TRUE</code> or if the last | |
29 | validation operation on | |
30 | <em class="parameter"><code>program</code></em> was successful, and | |
31 | <code class="constant">GL_FALSE</code> | |
32 | otherwise.</p></dd><dt><span class="term"><code class="constant">GL_INFO_LOG_LENGTH</code></span></dt><dd><p> | |
33 | </p><p> <em class="parameter"><code>params</code></em> returns the | |
34 | number of characters in the information log for | |
35 | <em class="parameter"><code>program</code></em> including the null | |
36 | termination character (i.e., the size of the | |
37 | character buffer required to store the information | |
38 | log). If <em class="parameter"><code>program</code></em> has no | |
39 | information log, a value of 0 is | |
40 | returned.</p></dd><dt><span class="term"><code class="constant">GL_ATTACHED_SHADERS</code></span></dt><dd><p> | |
41 | </p><p> <em class="parameter"><code>params</code></em> returns the | |
42 | number of shader objects attached to | |
43 | <em class="parameter"><code>program</code></em>.</p></dd><dt><span class="term"><code class="constant">GL_ACTIVE_ATTRIBUTES</code></span></dt><dd><p> | |
44 | </p><p> <em class="parameter"><code>params</code></em> returns the | |
45 | number of active attribute variables for | |
46 | <em class="parameter"><code>program</code></em>.</p></dd><dt><span class="term"><code class="constant">GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</code></span></dt><dd><p> | |
47 | </p><p> <em class="parameter"><code>params</code></em> returns the | |
48 | length of the longest active attribute name for | |
49 | <em class="parameter"><code>program</code></em>, including the null | |
50 | termination character (i.e., the size of the | |
51 | character buffer required to store the longest | |
52 | attribute name). If no active attributes exist, 0 is | |
53 | returned.</p></dd><dt><span class="term"><code class="constant">GL_ACTIVE_UNIFORMS</code></span></dt><dd><p> | |
54 | </p><p> <em class="parameter"><code>params</code></em> returns the | |
55 | number of active uniform variables for | |
56 | <em class="parameter"><code>program</code></em>.</p></dd><dt><span class="term"><code class="constant">GL_ACTIVE_UNIFORM_MAX_LENGTH</code></span></dt><dd><p> | |
57 | </p><p> <em class="parameter"><code>params</code></em> returns the | |
58 | length of the longest active uniform variable name | |
59 | for <em class="parameter"><code>program</code></em>, including the | |
60 | null termination character (i.e., the size of the | |
61 | character buffer required to store the longest | |
62 | uniform variable name). If no active uniform | |
63 | variables exist, 0 is returned.</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p><code class="function">glGetProgram</code> is available only if the | |
64 | GL version is 2.0 or greater.</p><p>If an error is generated, no change is made to the | |
65 | contents of <em class="parameter"><code>params</code></em>.</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> | |
66 | is generated if <em class="parameter"><code>program</code></em> | |
67 | is not a value generated by OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> | |
68 | is generated if <em class="parameter"><code>program</code></em> | |
69 | does not refer to a program object.</p><p><code class="constant">GL_INVALID_ENUM</code> | |
70 | is generated if <em class="parameter"><code>pname</code></em> | |
71 | is not an accepted value.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if | |
72 | <code class="function">glGetProgram</code> is executed between the | |
73 | execution of | |
74 | <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> | |
75 | and the corresponding execution of | |
76 | <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="glGetActiveAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveAttrib</span></span></a> | |
77 | with argument <em class="parameter"><code>program</code></em></p><p><a class="citerefentry" href="glGetActiveUniform.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveUniform</span></span></a> | |
78 | with argument <em class="parameter"><code>program</code></em></p><p><a class="citerefentry" href="glGetAttachedShaders.xml"><span class="citerefentry"><span class="refentrytitle">glGetAttachedShaders</span></span></a> | |
79 | with argument <em class="parameter"><code>program</code></em></p><p><a class="citerefentry" href="glGetProgramInfoLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramInfoLog</span></span></a> | |
80 | with argument <em class="parameter"><code>program</code></em></p><p><a class="citerefentry" href="glIsProgram.xml"><span class="citerefentry"><span class="refentrytitle">glIsProgram</span></span></a> | |
81 | <em class="parameter"><code></code></em></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>, | |
82 | <a class="citerefentry" href="glCreateProgram.xml"><span class="citerefentry"><span class="refentrytitle">glCreateProgram</span></span></a>, | |
83 | <a class="citerefentry" href="glDeleteProgram.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgram</span></span></a>, | |
84 | <a class="citerefentry" href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a>, | |
85 | <a class="citerefentry" href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>, | |
86 | <a class="citerefentry" href="glValidateProgram.xml"><span class="citerefentry"><span class="refentrytitle">glValidateProgram</span></span></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
87 | Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd. | |
88 | This material may be distributed subject to the terms and conditions set forth in | |
89 | the Open Publication License, v 1.0, 8 June 1999. | |
90 | <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
91 | </p></div></div></body></html> |