1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glGetProgramPipeline">
9 <holder>Khronos Group
</holder>
12 <refentrytitle>glGetProgramPipeline
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetProgramPipeline
</refname>
17 <refpurpose>retrieve properties of a program pipeline object
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glGetProgramPipelineiv
</function></funcdef>
23 <paramdef>GLuint
<parameter>pipeline
</parameter></paramdef>
24 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
25 <paramdef>GLint *
<parameter>params
</parameter></paramdef>
29 <refsect1 id=
"parameters"><title>Parameters
</title>
32 <term><parameter>pipeline
</parameter></term>
35 Specifies the name of a program pipeline object whose parameter retrieve.
40 <term><parameter>pname
</parameter></term>
43 Specifies the name of the parameter to retrieve.
48 <term><parameter>params
</parameter></term>
51 Specifies the address of a variable into which will be written the value or values
52 of
<parameter>pname
</parameter> for
<parameter>pipeline
</parameter>.
58 <refsect1 id=
"description"><title>Description
</title>
60 <function>glGetProgramPipelineiv
</function> retrieves the value of a property of the program
61 pipeline object
<parameter>pipeline
</parameter>.
<parameter>pname
</parameter> specifies the
62 name of the parameter whose value to retrieve. The value of the parameter is written to
63 the variable whose address is given by
<parameter>params
</parameter>.
66 If
<parameter>pname
</parameter> is
<constant>GL_ACTIVE_PROGRAM
</constant>, the name of the
67 active program object of the program pipeline object is returned in
<parameter>params
</parameter>.
70 If
<parameter>pname
</parameter> is
<constant>GL_VERTEX_SHADER
</constant>, the name of the
71 current program object for the vertex shader type of the program pipeline object is
72 returned in
<parameter>params
</parameter>.
75 If
<parameter>pname
</parameter> is
<constant>GL_TESS_CONTROL_SHADER
</constant>, the name of the
76 current program object for the tessellation control shader type of the program pipeline object is
77 returned in
<parameter>params
</parameter>.
80 If
<parameter>pname
</parameter> is
<constant>GL_TESS_EVALUATION_SHADER
</constant>, the name of the
81 current program object for the tessellation evaluation shader type of the program pipeline object is
82 returned in
<parameter>params
</parameter>.
85 If
<parameter>pname
</parameter> is
<constant>GL_GEOMETRY_SHADER
</constant>, the name of the
86 current program object for the geometry shader type of the program pipeline object is
87 returned in
<parameter>params
</parameter>.
90 If
<parameter>pname
</parameter> is
<constant>GL_FRAGMENT_SHADER
</constant>, the name of the
91 current program object for the fragment shader type of the program pipeline object is
92 returned in
<parameter>params
</parameter>.
95 If
<parameter>pname
</parameter> is
<constant>GL_INFO_LOG_LENGTH
</constant>, the length of the
96 info log, including the null terminator, is returned in
<parameter>params
</parameter>. If there
97 is no info log, zero is returned.
100 <refsect1 id=
"errors"><title>Errors
</title>
102 <constant>GL_INVALID_OPERATION
</constant> is generated if
<parameter>pipeline
</parameter> is not zero or
103 a name previously returned from a call to
<citerefentry><refentrytitle>glGenProgramPipelines
</refentrytitle></citerefentry>
104 or if such a name has been deleted by a call to
105 <citerefentry><refentrytitle>glDeleteProgramPipelines
</refentrytitle></citerefentry>.
108 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>pname
</parameter> is not one
109 of the accepted values.
112 <refsect1 id=
"seealso"><title>See Also
</title>
114 <citerefentry><refentrytitle>glGetProgramPipelines
</refentrytitle></citerefentry>,
115 <citerefentry><refentrytitle>glBindProgramPipeline
</refentrytitle></citerefentry>,
116 <citerefentry><refentrytitle>glDeleteProgramPipelines
</refentrytitle></citerefentry>
119 <refsect1 id=
"Copyright"><title>Copyright
</title>
121 Copyright
<trademark class=
"copyright"></trademark> 2010 Khronos Group.
122 This material may be distributed subject to the terms and conditions set forth in
123 the Open Publication License, v
1.0,
8 June
1999.
124 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.