rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man2 / glXFreeContextEXT.xml
diff --git a/upstream-doc/man2/glXFreeContextEXT.xml b/upstream-doc/man2/glXFreeContextEXT.xml
new file mode 100644 (file)
index 0000000..017b148
--- /dev/null
@@ -0,0 +1,86 @@
+<?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="glXFreeContextEXT">
+    <refmeta>
+        <refmetainfo>
+            <copyright>
+                <year>1991-2006</year>
+                <holder>Silicon Graphics, Inc.</holder>
+            </copyright>
+        </refmetainfo>
+        <refentrytitle>glXFreeContextEXT</refentrytitle>
+        <manvolnum>3G</manvolnum>
+    </refmeta>
+    <refnamediv>
+        <refname>glXFreeContextEXT</refname>
+        <refpurpose>free client-side memory for imported context</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv><title>C Specification</title>
+        <funcsynopsis>
+            <funcprototype>
+                <funcdef>void <function>glXFreeContextEXT</function></funcdef>
+                <paramdef>Display * <parameter>dpy</parameter></paramdef>
+                <paramdef>GLXContext <parameter>ctx</parameter></paramdef>
+            </funcprototype>
+        </funcsynopsis>
+    </refsynopsisdiv>
+    <!-- eqn: ignoring delim $$ -->
+    <refsect1 id="parameters"><title>Parameters</title>
+        <variablelist>
+        <varlistentry>
+            <term><parameter>dpy</parameter></term>
+            <listitem>
+                <para>
+                    Specifies the connection to the X server.
+                </para>
+            </listitem>
+        </varlistentry>
+        <varlistentry>
+            <term><parameter>ctx</parameter></term>
+            <listitem>
+                <para>
+                    Specifies a GLX rendering context.
+                </para>
+            </listitem>
+        </varlistentry>
+        </variablelist>
+    </refsect1>
+    <refsect1 id="description"><title>Description</title>
+        <para>
+            <function>glXFreeContextEXT</function> frees the client-side part of a GLXContext that 
+            was created with <citerefentry><refentrytitle>glXImportContextEXT</refentrytitle></citerefentry>. <function>glXFreeContextEXT</function> does not 
+            free the server-side context information or the XID 
+            associated with the server-side context.
+        </para>
+        <para>
+            <function>glXFreeContextEXT</function> is part of the <code>EXT_import_context</code> extension,
+            not part of the core GLX command set. If _glxextstring(EXT_import_context)
+            is included in the string returned by <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>,
+            when called with argument <constant>GLX_EXTENSIONS</constant>,
+            extension <code>EXT_vertex_array</code> is supported.
+        </para>
+    </refsect1>
+    <refsect1 id="errors"><title>Errors</title>
+        <para>
+            <constant>GLXBadContext</constant> is generated if <parameter>ctx</parameter> does not
+            refer to a valid context.
+        </para>
+    </refsect1>
+    <refsect1 id="seealso"><title>See Also</title>
+        <para>
+            <citerefentry><refentrytitle>glXCreateContext</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glXQueryVersion</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glXImportContextEXT</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>