e0c623106595533e290da0d2ca287db441bd2bfa
[clinton/guile-figl.git] / upstream-man-pages / man4 / xhtml / glProgramParameter.xml
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>glProgramParameter - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glProgramParameter"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glProgramParameter — specify a parameter for 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">glProgramParameteri</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">value</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>
5 Specifies the name of a program object whose parameter to modify.
6 </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
7 Specifies the name of the parameter to modify.
8 </p></dd><dt><span class="term"><em class="parameter"><code>value</code></em></span></dt><dd><p>
9 Specifies the new value of the parameter specified by <em class="parameter"><code>pname</code></em> for <em class="parameter"><code>program</code></em>.
10 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
11 <code class="function">glProgramParameter</code> specifies a new value for the parameter nameed by
12 <em class="parameter"><code>pname</code></em> for the program object <em class="parameter"><code>program</code></em>.
13 </p><p>
14 If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_PROGRAM_BINARY_RETRIEVABLE_HINT</code>,
15 <em class="parameter"><code>value</code></em> should be <code class="constant">GL_FALSE</code> or <code class="constant">GL_TRUE</code>
16 to indicate to the implementation the intention of the application to retrieve the program's
17 binary representation with <a href="glGetProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>.
18 The implementation may use this information to store information that may be useful for a future
19 query of the program's binary. It is recommended to set <code class="constant">GL_PROGRAM_BINARY_RETRIEVABLE_HINT</code>
20 for the program to <code class="constant">GL_TRUE</code> before calling
21 <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>, and
22 using the program at run-time if the binary is to be retrieved later.
23 </p><p>
24 If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_PROGRAM_SEPARABLE</code>, <em class="parameter"><code>value</code></em>
25 must be <code class="constant">GL_TRUE</code> or <code class="constant">GL_FALSE</code> and indicates whether
26 <em class="parameter"><code>program</code></em> can be bound to individual pipeline stages via
27 <a href="glUseProgramStages.xml"><span class="citerefentry"><span class="refentrytitle">glUseProgramStages</span></span></a>. A program's
28 <code class="constant">GL_PROGRAM_SEPARABLE</code> parameter must be set to <code class="constant">GL_TRUE</code>
29 <span class="emphasis"><em>before</em></span> <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>
30 is called in order for it to be usable with a program pipeline object. The initial state of
31 <code class="constant">GL_PROGRAM_SEPARABLE</code> is <code class="constant">GL_FALSE</code>.
32 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
33 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>program</code></em> is not the
34 name of an existing program object.
35 </p><p>
36 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not one
37 of the accepted values.
38 </p><p>
39 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>value</code></em> is not a valid
40 value for the parameter named by <em class="parameter"><code>pname</code></em>.
41 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
42 <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>.
43 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
44 <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
45 <a href="glGetProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>,
46 <a href="glProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glProgramBinary</span></span></a>
47 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
48 Copyright <span class="trademark"></span>© 2010 Khronos Group.
49 This material may be distributed subject to the terms and conditions set forth in
50 the Open Publication License, v 1.0, 8 June 1999.
51 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
52 </p></div></div></body></html>