HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
| 2 | <!-- saved from url=(0013)about:internet --> | |
| 3 | <?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" /><title>glValidateProgram</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glValidateProgram"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glValidateProgram — Validates a program 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">glValidateProgram</b>(</code></td><td>GLuint </td><td><var class="pdparam">program</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>program</code></em></span></dt><dd><p>Specifies the handle of the program object to | |
| 4 | be validated.</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p><code class="function">glValidateProgram</code> checks to see | |
| 5 | whether the executables contained in | |
| 6 | <em class="parameter"><code>program</code></em> can execute given the current | |
| 7 | OpenGL state. The information generated by the validation | |
| 8 | process will be stored in <em class="parameter"><code>program</code></em>'s | |
| 9 | information log. The validation information may consist of an | |
| 10 | empty string, or it may be a string containing information about | |
| 11 | how the current program object interacts with the rest of | |
| 12 | current OpenGL state. This provides a way for OpenGL | |
| 13 | implementers to convey more information about why the current | |
| 14 | program is inefficient, suboptimal, failing to execute, and so | |
| 15 | on.</p><p>The status of the validation operation will be stored as | |
| 16 | part of the program object's state. This value will be set to | |
| 17 | <code class="constant">GL_TRUE</code> if the validation succeeded, and | |
| 18 | <code class="constant">GL_FALSE</code> otherwise. It can be queried by | |
| 19 | calling | |
| 20 | <a class="citerefentry" href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a> | |
| 21 | with arguments <em class="parameter"><code>program</code></em> and | |
| 22 | <code class="constant">GL_VALIDATE_STATUS</code>. If validation is | |
| 23 | successful, <em class="parameter"><code>program</code></em> is guaranteed to | |
| 24 | execute given the current state. Otherwise, | |
| 25 | <em class="parameter"><code>program</code></em> is guaranteed to not execute.</p><p>This function is typically useful only during application | |
| 26 | development. The informational string stored in the information | |
| 27 | log is completely implementation dependent; therefore, an | |
| 28 | application should not expect different OpenGL implementations | |
| 29 | to produce identical information strings.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p><code class="function">glValidateProgram</code> is available only | |
| 30 | if the GL version is 2.0 or greater.</p><p>This function mimics the validation operation that OpenGL | |
| 31 | implementations must perform when rendering commands are issued | |
| 32 | while programmable shaders are part of current state. The error | |
| 33 | <code class="constant">GL_INVALID_OPERATION</code> will be generated by | |
| 34 | <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>, | |
| 35 | <a class="citerefentry" href="glRasterPos.xml"><span class="citerefentry"><span class="refentrytitle">glRasterPos</span></span></a>, | |
| 36 | or any command that performs an implicit call to | |
| 37 | <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> | |
| 38 | if:</p><div class="itemizedlist"><ul type="disc"><li><p>any two active samplers in the current program | |
| 39 | object are of different types, but refer to the same | |
| 40 | texture image unit,</p></li><li><p>any active sampler in the current program object | |
| 41 | refers to a texture image unit where fixed-function | |
| 42 | fragment processing accesses a texture target that does | |
| 43 | not match the sampler type, or</p></li><li><p>the sum of the number of active samplers in the | |
| 44 | program and the number of texture image units enabled | |
| 45 | for fixed-function fragment processing exceeds the | |
| 46 | combined limit on the total number of texture image | |
| 47 | units allowed.</p></li></ul></div><p>It may be difficult or cause a performance degradation for | |
| 48 | applications to catch these errors when rendering commands are | |
| 49 | issued. Therefore, applications are advised to make calls to | |
| 50 | <code class="function">glValidateProgram</code> to detect these issues | |
| 51 | during application development.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_VALUE</code> is generated if | |
| 52 | <em class="parameter"><code>program</code></em> is not a value generated by | |
| 53 | OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if | |
| 54 | <em class="parameter"><code>program</code></em> is not a program object.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if | |
| 55 | <code class="function">glValidateProgram</code> is executed between the | |
| 56 | execution of | |
| 57 | <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> | |
| 58 | and the corresponding execution of | |
| 59 | <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a class="citerefentry" href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a> | |
| 60 | with arguments <em class="parameter"><code>program</code></em> and | |
| 61 | <code class="constant">GL_VALIDATE_STATUS</code></p><p><a class="citerefentry" href="glGetProgramInfoLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramInfoLog</span></span></a> | |
| 62 | with argument <em class="parameter"><code>program</code></em></p><p><a class="citerefentry" href="glIsProgram.xml"><span class="citerefentry"><span class="refentrytitle">glIsProgram</span></span></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p><a class="citerefentry" href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>, | |
| 63 | <a class="citerefentry" href="glUseProgram.xml"><span class="citerefentry"><span class="refentrytitle">glUseProgram</span></span></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 64 | Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd. | |
| 65 | This material may be distributed subject to the terms and conditions set forth in | |
| 66 | the Open Publication License, v 1.0, 8 June 1999. | |
| 67 | <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 68 | </p></div></div></body></html> |