8f825c6c6487de0e09e98300522cafd7d523a36d
[clinton/guile-figl.git] / upstream-man-pages / man4 / xhtml / glUseProgramStages.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>glUseProgramStages - 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="glUseProgramStages"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glUseProgramStages — bind stages of a program object to a program pipeline</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">glUseProgramStages</b>(</code></td><td>GLuint  </td><td><var class="pdparam">pipeline</var>, </td></tr><tr><td> </td><td>GLbitfield  </td><td><var class="pdparam">stages</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">program</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>pipeline</code></em></span></dt><dd><p>
5 Specifies the program pipeline object to which to bind stages from <em class="parameter"><code>program</code></em>.
6 </p></dd><dt><span class="term"><em class="parameter"><code>stages</code></em></span></dt><dd><p>
7 Specifies a set of program stages to bind to the program pipeline object.
8 </p></dd><dt><span class="term"><em class="parameter"><code>program</code></em></span></dt><dd><p>
9 Specifies the program object containing the shader executables to use in <em class="parameter"><code>pipeline</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">glUseProgramStages</code> binds executables from a program object
12 associated with a specified set of shader stages to the program pipeline object given
13 by <em class="parameter"><code>pipeline</code></em>.
14 <em class="parameter"><code>pipeline</code></em> specifies the program pipeline object to which to bind
15 the executables. <em class="parameter"><code>stages</code></em> contains a logical combination of bits
16 indicating the shader stages to use within <em class="parameter"><code>program</code></em> with the program
17 pipeline object <em class="parameter"><code>pipeline</code></em>. <em class="parameter"><code>stages</code></em> must be
18 a logical combination of <code class="constant">GL_VERTEX_SHADER_BIT</code>,
19 <code class="constant">GL_TESS_CONTROL_SHADER_BIT</code>, <code class="constant">GL_TESS_EVALUATION_SHADER_BIT</code>,
20 <code class="constant">GL_GEOMETRY_SHADER_BIT</code>, <code class="constant">GL_FRAGMENT_SHADER_BIT</code> and <code class="constant">GL_COMPUTE_SHADER_BIT</code>.
21 Additionally, the special value <code class="constant">GL_ALL_SHADER_BITS</code> may be specified to
22 indicate that all executables contained in <em class="parameter"><code>program</code></em> should be
23 installed in <em class="parameter"><code>pipeline</code></em>.
24 </p><p>
25 If <em class="parameter"><code>program</code></em> refers to a program object with a valid shader attached for
26 an indicated shader stage, <code class="function">glUseProgramStages</code> installs the executable
27 code for that stage in the indicated program pipeline object <em class="parameter"><code>pipeline</code></em>.
28 If <em class="parameter"><code>program</code></em> is zero, or refers to a program object with no valid shader
29 executable for a given stage, it is as if the pipeline object has no programmable stage configured
30 for the indicated shader stages. If <em class="parameter"><code>stages</code></em> contains bits other than those
31 listed above, and is not equal to <code class="constant">GL_ALL_SHADER_BITS</code>, an error is generated.
32 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
33 The <code class="constant">GL_COMPUTE_SHADER_BIT</code> bit is available only if the GL version is 4.3 or greater.
34 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
35 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>shaders</code></em> contains
36 set bits that are not recognized, and is not the reserved value <code class="constant">GL_ALL_SHADER_BITS</code>.
37 </p><p>
38 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>program</code></em> refers
39 to a program object that was not linked with its <code class="constant">GL_PROGRAM_SEPARABLE</code> status set.
40 </p><p>
41 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>program</code></em> refers
42 to a program object that has not been successfully linked.
43 </p><p>
44 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>pipeline</code></em> is not
45 a name previously returned from a call to <a href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>
46 or if such a name has been deleted by a call to
47 <a href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>.
48 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
49 <a href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>,
50 <a href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>,
51 <a href="glIsProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glIsProgramPipeline</span></span></a>
52 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
53 Copyright <span class="trademark"></span>© 2010 Khronos Group.
54 This material may be distributed subject to the terms and conditions set forth in
55 the Open Publication License, v 1.0, 8 June 1999.
56 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
57 </p></div></div></body></html>