<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?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
		    queried.</p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>Specifies the object parameter. Accepted
		    symbolic names are
		    <code class="constant">GL_DELETE_STATUS</code>,
		    <code class="constant">GL_LINK_STATUS</code>,
		    <code class="constant">GL_VALIDATE_STATUS</code>,
		    <code class="constant">GL_INFO_LOG_LENGTH</code>,
		    <code class="constant">GL_ATTACHED_SHADERS</code>,
		    <code class="constant">GL_ACTIVE_ATTRIBUTES</code>,
		    <code class="constant">GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</code>,
		    <code class="constant">GL_ACTIVE_UNIFORMS</code>,
		    <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>
	returns in <em class="parameter"><code>params</code></em>
	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>
		    </p><p> <em class="parameter"><code>params</code></em> returns
		    <code class="constant">GL_TRUE</code> if
		    <em class="parameter"><code>program</code></em> is currently flagged
		    for deletion, and <code class="constant">GL_FALSE</code>
		    otherwise.</p></dd><dt><span class="term"><code class="constant">GL_LINK_STATUS</code></span></dt><dd><p>
		    </p><p> <em class="parameter"><code>params</code></em> returns
		    <code class="constant">GL_TRUE</code> if the last link
		    operation on <em class="parameter"><code>program</code></em> was
		    successful, and <code class="constant">GL_FALSE</code>
		    otherwise.</p></dd><dt><span class="term"><code class="constant">GL_VALIDATE_STATUS</code></span></dt><dd><p>
		    </p><p> <em class="parameter"><code>params</code></em> returns
		    <code class="constant">GL_TRUE</code> or if the last
		    validation operation on
		    <em class="parameter"><code>program</code></em> was successful, and
		    <code class="constant">GL_FALSE</code>
		    otherwise.</p></dd><dt><span class="term"><code class="constant">GL_INFO_LOG_LENGTH</code></span></dt><dd><p>
		    </p><p> <em class="parameter"><code>params</code></em> returns the
		    number of characters in the information log for
		    <em class="parameter"><code>program</code></em> including the null
		    termination character (i.e., the size of the
		    character buffer required to store the information
		    log). If <em class="parameter"><code>program</code></em> has no
		    information log, a value of 0 is
		    returned.</p></dd><dt><span class="term"><code class="constant">GL_ATTACHED_SHADERS</code></span></dt><dd><p>
		    </p><p> <em class="parameter"><code>params</code></em> returns the
		    number of shader objects attached to
		    <em class="parameter"><code>program</code></em>.</p></dd><dt><span class="term"><code class="constant">GL_ACTIVE_ATTRIBUTES</code></span></dt><dd><p>
		    </p><p> <em class="parameter"><code>params</code></em> returns the
		    number of active attribute variables for
		    <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>
		    </p><p> <em class="parameter"><code>params</code></em> returns the
		    length of the longest active attribute name for
		    <em class="parameter"><code>program</code></em>, including the null
		    termination character (i.e., the size of the
		    character buffer required to store the longest
		    attribute name). If no active attributes exist, 0 is
		    returned.</p></dd><dt><span class="term"><code class="constant">GL_ACTIVE_UNIFORMS</code></span></dt><dd><p>
		    </p><p> <em class="parameter"><code>params</code></em> returns the
		    number of active uniform variables for
		    <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>
		    </p><p> <em class="parameter"><code>params</code></em> returns the
		    length of the longest active uniform variable name
		    for <em class="parameter"><code>program</code></em>, including the
		    null termination character (i.e., the size of the
		    character buffer required to store the longest
		    uniform variable name). If no active uniform
		    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
	GL version is 2.0 or greater.</p><p>If an error is generated, no change is made to the
	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>
	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>
	does not refer to a program object.</p><p><code class="constant">GL_INVALID_ENUM</code>
	is generated if <em class="parameter"><code>pname</code></em>
	is not an accepted value.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if
	<code class="function">glGetProgram</code> is executed between the
	execution of
	<a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
	and the corresponding execution of
	<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>
	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>
	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>
	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>
	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>
	<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>,
	<a class="citerefentry" href="glCreateProgram.xml"><span class="citerefentry"><span class="refentrytitle">glCreateProgram</span></span></a>,
	<a class="citerefentry" href="glDeleteProgram.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgram</span></span></a>,
	<a class="citerefentry" href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a>,
	<a class="citerefentry" href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>,
	<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>
            Copyright <span class="trademark"></span>© 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="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p></div></div></body></html>
