File: glUseProgramStages.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn27841-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 24,888 kB
  • ctags: 377
  • sloc: xml: 188,408; makefile: 1,153; python: 736; sh: 49; php: 7; sed: 2
file content (56 lines) | stat: -rw-r--r-- 7,233 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<?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.78.1" /></head><body><div class="refentry"><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" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glUseProgramStages</strong>(</code></td><td>GLuint <var class="pdparam">pipeline</var>, </td></tr><tr><td> </td><td>GLbitfield <var class="pdparam">stages</var>, </td></tr><tr><td> </td><td>GLuint <var class="pdparam">program</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>pipeline</code></em></span></dt><dd><p>
                Specifies the program pipeline object to which to bind stages from <em class="parameter"><code>program</code></em>.
            </p></dd><dt><span class="term"><em class="parameter"><code>stages</code></em></span></dt><dd><p>
                Specifies a set of program stages to bind to the program pipeline object.
            </p></dd><dt><span class="term"><em class="parameter"><code>program</code></em></span></dt><dd><p>
                Specifies the program object containing the shader executables to use in <em class="parameter"><code>pipeline</code></em>.
            </p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
            <code class="function">glUseProgramStages</code> binds executables from a program object
            associated with a specified set of shader stages to the program pipeline object given
            by <em class="parameter"><code>pipeline</code></em>.
            <em class="parameter"><code>pipeline</code></em> specifies the program pipeline object to which to bind
            the executables. <em class="parameter"><code>stages</code></em> contains a logical combination of bits
            indicating the shader stages to use within <em class="parameter"><code>program</code></em> with the program
            pipeline object <em class="parameter"><code>pipeline</code></em>. <em class="parameter"><code>stages</code></em> must be
            a logical combination of <code class="constant">GL_VERTEX_SHADER_BIT</code>,
            <code class="constant">GL_TESS_CONTROL_SHADER_BIT</code>, <code class="constant">GL_TESS_EVALUATION_SHADER_BIT</code>,
            <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>.
            Additionally, the special value <code class="constant">GL_ALL_SHADER_BITS</code> may be specified to
            indicate that all executables contained in <em class="parameter"><code>program</code></em> should be
            installed in <em class="parameter"><code>pipeline</code></em>.
        </p><p>
            If <em class="parameter"><code>program</code></em> refers to a program object with a valid shader attached for
            an indicated shader stage, <code class="function">glUseProgramStages</code> installs the executable
            code for that stage in the indicated program pipeline object <em class="parameter"><code>pipeline</code></em>.
            If <em class="parameter"><code>program</code></em> is zero, or refers to a program object with no valid shader
            executable for a given stage, it is as if the pipeline object has no programmable stage configured
            for the indicated shader stages. If <em class="parameter"><code>stages</code></em> contains bits other than those
            listed above, and is not equal to <code class="constant">GL_ALL_SHADER_BITS</code>, an error is generated.
       </p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
            The <code class="constant">GL_COMPUTE_SHADER_BIT</code> bit is available only if the GL version is 4.3 or greater.
        </p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>shaders</code></em> contains
            set bits that are not recognized, and is not the reserved value <code class="constant">GL_ALL_SHADER_BITS</code>.
        </p><p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>program</code></em> refers
            to a program object that was not linked with its <code class="constant">GL_PROGRAM_SEPARABLE</code> status set.
        </p><p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>program</code></em> refers
            to a program object that has not been successfully linked.
        </p><p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>pipeline</code></em> is not
            a name previously returned from a call to <a class="citerefentry" href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>
            or if such a name has been deleted by a call to
            <a class="citerefentry" href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>.
        </p></div><div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
            <a class="citerefentry" href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>,
            <a class="citerefentry" href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>,
            <a class="citerefentry" href="glIsProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glIsProgramPipeline</span></span></a>
        </p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
            Copyright <span class="trademark"></span>© 2010-2013 Khronos Group.
            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>