rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glValidateProgramPipeline.xml
CommitLineData
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>glValidateProgramPipeline - 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="glValidateProgramPipeline"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glValidateProgramPipeline — validate a program pipeline object against current GL state</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">glValidateProgramPipeline</b>(</code></td><td>GLuint  </td><td><var class="pdparam">pipeline</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 to validate.
6 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
7 <code class="function">glValidateProgramPipeline</code> instructs the implementation to validate the
8 shader executables contained in <em class="parameter"><code>pipeline</code></em> against the current GL state.
9 The implementation may use this as an opportunity to perform any internal shader modifications
10 that may be required to ensure correct operation of the installed shaders given the
11 current GL state.
12 </p><p>
13 After a program pipeline has been validated, its validation status is set to <code class="constant">GL_TRUE</code>.
14 The validation status of a program pipeline object may be queried by calling
15 <a href="glGetProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipeline</span></span></a> with
16 parameter <code class="constant">GL_VALIDATE_STATUS</code>.
17 </p><p>
18 If <em class="parameter"><code>pipeline</code></em> is a name previously returned from a call to
19 <a href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a> but
20 that has not yet been bound by a call to <a href="glBindProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glBindProgramPipeline</span></span></a>,
21 a new program pipeline object is created with name <em class="parameter"><code>pipeline</code></em> and
22 the default state vector.
23 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
24 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>pipeline</code></em> is not
25 a name previously returned from a call to <a href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>
26 or if such a name has been deleted by a call to
27 <a href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>.
28 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
29 <a href="glGetProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipeline</span></span></a>
30 with parameter <code class="constant">GL_VALIDATE_STATUS</code>.
31 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
32 <a href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>,
33 <a href="glBindProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glBindProgramPipeline</span></span></a>,
34 <a href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>
35 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
36 Copyright <span class="trademark"></span>© 2010 Khronos Group.
37 This material may be distributed subject to the terms and conditions set forth in
38 the Open Publication License, v 1.0, 8 June 1999.
39 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
40 </p></div></div></body></html>