rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glBindProgramPipeline.xml

diff --git a/upstream-doc/man4/glBindProgramPipeline.xml b/upstream-doc/man4/glBindProgramPipeline.xml
new file mode 100644 (file)
index 0000000..e80f7d9
--- /dev/null
+++ b/upstream-doc/man4/glBindProgramPipeline.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
+<refentry id="glBindProgramPipeline">
+    <refmeta>
+        <refmetainfo>
+            <copyright>
+                <year>2010</year>
+                <holder>Khronos Group</holder>
+            </copyright>
+        </refmetainfo>
+        <refentrytitle>glBindProgramPipeline</refentrytitle>
+        <manvolnum>3G</manvolnum>
+    </refmeta>
+    <refnamediv>
+        <refname>glBindProgramPipeline</refname>
+        <refpurpose>bind a program pipeline to the current context</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv><title>C Specification</title>
+        <funcsynopsis>
+            <funcprototype>
+                <funcdef>void <function>glBindProgramPipeline</function></funcdef>
+                <paramdef>GLuint <parameter>pipeline</parameter></paramdef>
+            </funcprototype>
+        </funcsynopsis>
+    </refsynopsisdiv>
+    <refsect1 id="parameters"><title>Parameters</title>
+        <variablelist>
+        <varlistentry>
+            <term><parameter>pipeline</parameter></term>
+            <listitem>
+            <para>
+                Specifies the name of the pipeline object to bind to the context.
+            </para>
+            </listitem>
+        </varlistentry>
+        </variablelist>
+    </refsect1>
+    <refsect1 id="description"><title>Description</title>
+        <para>
+            <function>glBindProgramPipeline</function> binds a program pipeline object to the current
+            context. <parameter>pipeline</parameter> must be a name previously returned from a call
+            to <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>. If
+            no program pipeline exists with name <parameter>pipeline</parameter> then a new pipeline object
+            is created with that name and initialized to the default state vector.
+        </para>
+        <para>
+            When a program pipeline object is bound using <function>glBindProgramPipeline</function>, any previous
+            binding is broken and is replaced with a binding to the specified pipeline object. If <parameter>pipeline</parameter>
+            is zero, the previous binding is broken and is not replaced, leaving no pipeline object bound.
+            If no current program object has been established by <citerefentry><refentrytitle>glUseProgram</refentrytitle></citerefentry>,
+            the program objects used for each stage and for uniform updates are taken from the bound program
+            pipeline object, if any. If there is a current program object established by <citerefentry><refentrytitle>glUseProgram</refentrytitle></citerefentry>,
+            the bound program pipeline object has no effect on rendering or uniform updates. When a bound program
+            pipeline object is used for rendering, individual shader executables are taken from its program objects.
+        </para>
+    </refsect1>
+    <refsect1 id="errors"><title>Errors</title>
+        <para>
+            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>pipeline</parameter> is not zero or
+            a name previously returned from a call to <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>
+            or if such a name has been deleted by a call to
+            <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>.
+        </para>
+    </refsect1>
+    <refsect1 id="seealso"><title>See Also</title>
+        <para>
+            <citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glCompileShader</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glIsProgramPipeline</refentrytitle></citerefentry>
+        </para>
+    </refsect1>
+    <refsect1 id="Copyright"><title>Copyright</title>
+        <para>
+            Copyright <trademark class="copyright"></trademark> 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.
+            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
+        </para>
+    </refsect1>
+</refentry>