Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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>glGetProgramPipeline - 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="glGetProgramPipeline"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetProgramPipeline — retrieve properties of a program pipeline 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">glGetProgramPipelineiv</b>(</code></td><td>GLuint </td><td><var class="pdparam">pipeline</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">params</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 name of a program pipeline object whose parameter retrieve. | |
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 retrieve. | |
8 | </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p> | |
9 | Specifies the address of a variable into which will be written the value or values | |
10 | of <em class="parameter"><code>pname</code></em> for <em class="parameter"><code>pipeline</code></em>. | |
11 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
12 | <code class="function">glGetProgramPipelineiv</code> retrieves the value of a property of the program | |
13 | pipeline object <em class="parameter"><code>pipeline</code></em>. <em class="parameter"><code>pname</code></em> specifies the | |
14 | name of the parameter whose value to retrieve. The value of the parameter is written to | |
15 | the variable whose address is given by <em class="parameter"><code>params</code></em>. | |
16 | </p><p> | |
17 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ACTIVE_PROGRAM</code>, the name of the | |
18 | active program object of the program pipeline object is returned in <em class="parameter"><code>params</code></em>. | |
19 | </p><p> | |
20 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_VERTEX_SHADER</code>, the name of the | |
21 | current program object for the vertex shader type of the program pipeline object is | |
22 | returned in <em class="parameter"><code>params</code></em>. | |
23 | </p><p> | |
24 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_TESS_CONTROL_SHADER</code>, the name of the | |
25 | current program object for the tessellation control shader type of the program pipeline object is | |
26 | returned in <em class="parameter"><code>params</code></em>. | |
27 | </p><p> | |
28 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_TESS_EVALUATION_SHADER</code>, the name of the | |
29 | current program object for the tessellation evaluation shader type of the program pipeline object is | |
30 | returned in <em class="parameter"><code>params</code></em>. | |
31 | </p><p> | |
32 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_GEOMETRY_SHADER</code>, the name of the | |
33 | current program object for the geometry shader type of the program pipeline object is | |
34 | returned in <em class="parameter"><code>params</code></em>. | |
35 | </p><p> | |
36 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_FRAGMENT_SHADER</code>, the name of the | |
37 | current program object for the fragment shader type of the program pipeline object is | |
38 | returned in <em class="parameter"><code>params</code></em>. | |
39 | </p><p> | |
40 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_INFO_LOG_LENGTH</code>, the length of the | |
41 | info log, including the null terminator, is returned in <em class="parameter"><code>params</code></em>. If there | |
42 | is no info log, zero is returned. | |
43 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
44 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>pipeline</code></em> is not zero or | |
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><p> | |
49 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not one | |
50 | of the accepted values. | |
51 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
52 | <a href="glGetProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipelines</span></span></a>, | |
53 | <a href="glBindProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glBindProgramPipeline</span></span></a>, | |
54 | <a href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a> | |
55 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
56 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
57 | This material may be distributed subject to the terms and conditions set forth in | |
58 | the Open Publication License, v 1.0, 8 June 1999. | |
59 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
60 | </p></div></div></body></html> |