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 (123 lines) | stat: -rw-r--r-- 6,562 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glUseProgramStages">
    <refentryinfo>
        <copyright>
            <year>2010-2013</year>
            <holder>Khronos Group</holder>
        </copyright>
    </refentryinfo>
    <refmeta>
        <refentrytitle>glUseProgramStages</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glUseProgramStages</refname>
        <refpurpose>bind stages of a program object to a program pipeline</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glUseProgramStages</function></funcdef>
                <paramdef>GLuint <parameter>pipeline</parameter></paramdef>
                <paramdef>GLbitfield <parameter>stages</parameter></paramdef>
                <paramdef>GLuint <parameter>program</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>pipeline</parameter></term>
            <listitem>
            <para>
                Specifies the program pipeline object to which to bind stages from <parameter>program</parameter>.
            </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>stages</parameter></term>
            <listitem>
            <para>
                Specifies a set of program stages to bind to the program pipeline object.
            </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>program</parameter></term>
            <listitem>
            <para>
                Specifies the program object containing the shader executables to use in <parameter>pipeline</parameter>.
            </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glUseProgramStages</function> binds executables from a program object
            associated with a specified set of shader stages to the program pipeline object given
            by <parameter>pipeline</parameter>.
            <parameter>pipeline</parameter> specifies the program pipeline object to which to bind
            the executables. <parameter>stages</parameter> contains a logical combination of bits
            indicating the shader stages to use within <parameter>program</parameter> with the program
            pipeline object <parameter>pipeline</parameter>. <parameter>stages</parameter> must be
            a logical combination of <constant>GL_VERTEX_SHADER_BIT</constant>,
            <constant>GL_TESS_CONTROL_SHADER_BIT</constant>, <constant>GL_TESS_EVALUATION_SHADER_BIT</constant>,
            <constant>GL_GEOMETRY_SHADER_BIT</constant>, <constant>GL_FRAGMENT_SHADER_BIT</constant> and <constant>GL_COMPUTE_SHADER_BIT</constant>.
            Additionally, the special value <constant>GL_ALL_SHADER_BITS</constant> may be specified to
            indicate that all executables contained in <parameter>program</parameter> should be
            installed in <parameter>pipeline</parameter>.
        </para>
        <para>
            If <parameter>program</parameter> refers to a program object with a valid shader attached for
            an indicated shader stage, <function>glUseProgramStages</function> installs the executable
            code for that stage in the indicated program pipeline object <parameter>pipeline</parameter>.
            If <parameter>program</parameter> 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 <parameter>stages</parameter> contains bits other than those
            listed above, and is not equal to <constant>GL_ALL_SHADER_BITS</constant>, an error is generated.
       </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            The <constant>GL_COMPUTE_SHADER_BIT</constant> bit is available only if the GL version is 4.3 or greater.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>shaders</parameter> contains
            set bits that are not recognized, and is not the reserved value <constant>GL_ALL_SHADER_BITS</constant>.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>program</parameter> refers
            to a program object that was not linked with its <constant>GL_PROGRAM_SEPARABLE</constant> status set.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>program</parameter> refers
            to a program object that has not been successfully linked.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>pipeline</parameter> is not
            a name previously returned from a call to <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>
            or if such a name has been deleted by a call to
            <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>.
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glIsProgramPipeline</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 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.
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
        </para>
    </refsect1>
</refentry>