rename upstream-man-pages to upstream-doc

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

diff --git a/upstream-doc/man4/glIsProgram.xml b/upstream-doc/man4/glIsProgram.xml
new file mode 100644 (file)
index 0000000..cc0aca2
--- /dev/null
+++ b/upstream-doc/man4/glIsProgram.xml
@@ -0,0 +1,102 @@
+<?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="glIsProgram">
+    <refmeta>
+    <refentrytitle>glIsProgram</refentrytitle>
+    <manvolnum>3G</manvolnum>
+    </refmeta>
+    <refnamediv>
+    <refname>glIsProgram</refname>
+    <refpurpose>Determines if a name corresponds to a program object</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv><title>C Specification</title>
+    <funcsynopsis>
+        <funcprototype>
+        <funcdef>GLboolean <function>glIsProgram</function></funcdef>
+        <paramdef>GLuint <parameter>program</parameter></paramdef>
+        </funcprototype>
+    </funcsynopsis>
+    </refsynopsisdiv>
+    <refsect1 id="parameters"><title>Parameters</title>
+    <variablelist>
+        <varlistentry>
+        <term><parameter>program</parameter></term>
+        <listitem>
+            <para>Specifies a potential program object.</para>
+        </listitem>
+        </varlistentry>
+    </variablelist>
+    </refsect1>
+    <refsect1 id="description"><title>Description</title>
+    <para><function>glIsProgram</function> returns
+    <constant>GL_TRUE</constant> if <parameter>program</parameter>
+    is the name of a program object previously created with 
+        <citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry> 
+        and not yet deleted with <citerefentry><refentrytitle>glDeleteProgram</refentrytitle></citerefentry>.
+    If <parameter>program</parameter> is zero or a non-zero value that
+    is not the name of a program object, or if an error occurs, 
+        <function>glIsProgram</function> returns <constant>GL_FALSE</constant>.</para>
+    </refsect1>
+    <refsect1 id="notes"><title>Notes</title>
+    <para>No error is generated if <parameter>program</parameter> is
+    not a valid program object name.</para>
+
+    <para>A program object marked for deletion with <citerefentry><refentrytitle>glDeleteProgram</refentrytitle></citerefentry>
+        but still in use as part of current rendering state is still considered 
+        a program object and <function>glIsProgram</function> will return <constant>GL_TRUE</constant>.</para>
+    </refsect1>
+    <refsect1 id="associatedgets"><title>Associated Gets</title>
+    <para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
+    with the argument <constant>GL_CURRENT_PROGRAM</constant></para>
+
+    <para><citerefentry><refentrytitle>glGetActiveAttrib</refentrytitle></citerefentry>
+    with arguments <parameter>program</parameter> and the index of
+    an active attribute variable</para>
+
+    <para><citerefentry><refentrytitle>glGetActiveUniform</refentrytitle></citerefentry>
+    with arguments <parameter>program</parameter> and the index of
+    an active uniform variable</para>
+
+    <para><citerefentry><refentrytitle>glGetAttachedShaders</refentrytitle></citerefentry>
+    with argument <parameter>program</parameter></para>
+
+    <para><citerefentry><refentrytitle>glGetAttribLocation</refentrytitle></citerefentry>
+    with arguments <parameter>program</parameter> and the name of an
+    attribute variable</para>
+
+    <para><citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>
+    with arguments <parameter>program</parameter> and the parameter
+    to be queried</para>
+
+    <para><citerefentry><refentrytitle>glGetProgramInfoLog</refentrytitle></citerefentry>
+    with argument <parameter>program</parameter></para>
+
+    <para><citerefentry><refentrytitle>glGetUniform</refentrytitle></citerefentry>
+    with arguments <parameter>program</parameter> and the location
+    of a uniform variable</para>
+
+    <para><citerefentry><refentrytitle>glGetUniformLocation</refentrytitle></citerefentry>
+    with arguments <parameter>program</parameter> and the name of a
+    uniform variable</para>
+    </refsect1>
+    <refsect1 id="seealso"><title>See Also</title>
+    <para><citerefentry><refentrytitle>glAttachShader</refentrytitle></citerefentry>,
+    <citerefentry><refentrytitle>glBindAttribLocation</refentrytitle></citerefentry>,
+    <citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry>,
+    <citerefentry><refentrytitle>glDeleteProgram</refentrytitle></citerefentry>,
+    <citerefentry><refentrytitle>glDetachShader</refentrytitle></citerefentry>,
+    <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
+    <citerefentry><refentrytitle>glUniform</refentrytitle></citerefentry>,
+    <citerefentry><refentrytitle>glUseProgram</refentrytitle></citerefentry>,
+    <citerefentry><refentrytitle>glValidateProgram</refentrytitle></citerefentry></para>
+    </refsect1>
+    <refsect1 id="Copyright"><title>Copyright</title>
+        <para>
+            Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd. 
+            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>