rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man2 / gluCheckExtension.xml

diff --git a/upstream-doc/man2/gluCheckExtension.xml b/upstream-doc/man2/gluCheckExtension.xml
new file mode 100644 (file)
index 0000000..72ef61d
--- /dev/null
+++ b/upstream-doc/man2/gluCheckExtension.xml
@@ -0,0 +1,93 @@
+<?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="gluCheckExtension">
+    <refmeta>
+        <refmetainfo>
+            <copyright>
+                <year>1991-2006</year>
+                <holder>Silicon Graphics, Inc.</holder>
+            </copyright>
+        </refmetainfo>
+        <refentrytitle>gluCheckExtension</refentrytitle>
+        <manvolnum>3G</manvolnum>
+    </refmeta>
+    <refnamediv>
+        <refname>gluCheckExtension</refname>
+        <refpurpose>determines if an extension name is supported</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv><title>C Specification</title>
+        <funcsynopsis>
+            <funcprototype>
+                <funcdef>GLboolean <function>gluCheckExtension</function></funcdef>
+                <paramdef>const GLubyte * <parameter>extName</parameter></paramdef>
+                <paramdef>const GLubyte * <parameter>extString</parameter></paramdef>
+            </funcprototype>
+        </funcsynopsis>
+    </refsynopsisdiv>
+    <refsect1 id="parameters"><title>Parameters</title>
+        <variablelist>
+        <varlistentry>
+            <term><parameter>extName</parameter></term>
+            <listitem>
+                <para>
+                    Specifies an extension name.
+                </para>
+            </listitem>
+        </varlistentry>
+        <varlistentry>
+            <term><parameter>extString</parameter></term>
+            <listitem>
+                <para>
+                    Specifies a space-separated list of extension names supported. 
+                </para>
+            </listitem>
+        </varlistentry>
+        </variablelist>
+    </refsect1>
+    <refsect1 id="description"><title>Description</title>
+        <para>
+            <function>gluCheckExtension</function> returns <constant>GLU_TRUE</constant> if <parameter>extName</parameter> is supported otherwise 
+            <constant>GLU_FALSE</constant> is returned.
+        </para>
+        <para>
+            This is used to check for the presence for OpenGL, GLU, or GLX extension names
+            by passing the extension strings returned by <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>, 
+            <citerefentry><refentrytitle>gluGetString</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glXGetClientString</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>, or <citerefentry><refentrytitle>glXQueryServerString</refentrytitle></citerefentry>,
+            respectively, as <parameter>extString</parameter>.
+        </para>
+    </refsect1>
+    <refsect1 id="notes"><title>Notes</title>
+        <para>
+            Cases where one extension name is a substring of another are
+            correctly handled.
+        </para>
+        <para>
+            There may or may not be leading or trailing blanks in <parameter>extString</parameter>.
+        </para>
+        <para>
+            Extension names should not contain embedded spaces.
+        </para>
+        <para>
+            All strings are null-terminated.
+        </para>
+    </refsect1>
+    <refsect1 id="seealso"><title>See Also</title>
+        <para>
+            <citerefentry><refentrytitle>gluGetString</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glXGetClientString</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glXQueryServerString</refentrytitle></citerefentry>
+        </para>
+    </refsect1>
+    <refsect1 id="Copyright"><title>Copyright</title>
+        <para>
+            Copyright <trademark class="copyright"></trademark> 1991-2006
+            Silicon Graphics, Inc. This document is licensed under the SGI
+            Free Software B License. For details, see
+            <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
+        </para>
+    </refsect1>
+</refentry>