rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glProgramBinary.xml
diff --git a/upstream-doc/man4/xhtml/glProgramBinary.xml b/upstream-doc/man4/xhtml/glProgramBinary.xml
new file mode 100644 (file)
index 0000000..b771fd2
--- /dev/null
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
+<!-- saved from url=(0013)about:internet -->
+<?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>glProgramBinary - 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="glProgramBinary"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glProgramBinary — load a program object with a program binary</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">glProgramBinary</b>(</code></td><td>GLuint  </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">binaryFormat</var>, </td></tr><tr><td> </td><td>const void * </td><td><var class="pdparam">binary</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">length</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 name of a program object into which to load a program binary.
+            </p></dd><dt><span class="term"><em class="parameter"><code>binaryFormat</code></em></span></dt><dd><p>
+                Specifies the format of the binary data in binary.
+            </p></dd><dt><span class="term"><em class="parameter"><code>binary</code></em></span></dt><dd><p>
+                Specifies the address an array containing the binary to be loaded into <em class="parameter"><code>program</code></em>.
+            </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
+                Specifies the number of bytes contained in <em class="parameter"><code>binary</code></em>.
+            </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
+            <code class="function">glProgramBinary</code> loads a program object with a program binary previously
+            returned from <a href="glGetProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>.
+            <em class="parameter"><code>binaryFormat</code></em> and <em class="parameter"><code>binary</code></em> must be those returned
+            by a previous call to <a href="glGetProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>,
+            and <em class="parameter"><code>length</code></em> must be the length returned by
+            <a href="glGetProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>, or by
+            <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a> when called with
+            <em class="parameter"><code>pname</code></em> set to <code class="constant">GL_PROGRAM_BINARY_LENGTH</code>.
+            If these conditions are not met, loading the program binary will fail and <em class="parameter"><code>program</code></em>'s
+            <code class="constant">GL_LINK_STATUS</code> will be set to <code class="constant">GL_FALSE</code>.
+        </p><p>
+            A program object's program binary is replaced by calls to
+            <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a> or
+            <code class="function">glProgramBinary</code>. When linking success or failure is concerned, <code class="function">glProgramBinary</code>
+            can be considered to perform an implicit linking operation.
+            <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a> and <code class="function">glProgramBinary</code>
+            both set the program object's <code class="constant">GL_LINK_STATUS</code> to <code class="constant">GL_TRUE</code>
+            or <code class="constant">GL_FALSE</code>.
+        </p><p>
+            A successful call to <code class="function">glProgramBinary</code> will reset all uniform variables to their
+            initial values. The initial value is either the value of the variable's initializer as specified in the
+            original shader source, or zero if no initializer was present. Additionally, all vertex shader input
+            and fragment shader output assignments that were in effect when the program was linked before saving are
+            restored with <code class="function">glProgramBinary</code> is called.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
+            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>program</code></em> is not the
+            name of an existing program object.
+        </p><p>
+            <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>binaryFormat</code></em> is not a
+            value recognized by the implementation.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
+            A program binary may fail to load if the implementation determines that there has been a
+            change in hardware or software configuration from when the program binary was produced such
+            as having been compiled with an incompatible or outdated version of the compiler.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
+            <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a> with argument <code class="constant">GL_PROGRAM_BINARY_LENGTH</code>
+        </p><p>
+            <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_NUM_PROGRAM_BINARY_FORMATS</code>
+        </p><p>
+            <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PROGRAM_BINARY_FORMATS</code>
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
+            <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
+            <a href="glGetProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
+            Copyright <span class="trademark"></span>© 2010 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.
+            <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
+        </p></div></div></body></html>