upstream-doc/man2/glXFreeContextEXT.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glXFreeContextEXT">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXFreeContextEXT</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXFreeContextEXT</refname>
  17         <refpurpose>free client-side memory for imported context</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glXFreeContextEXT</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>GLXContext <parameter>ctx</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <!-- eqn: ignoring delim $$ -->
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>dpy</parameter></term>
  33             <listitem>
  34                 <para>
  35                     Specifies the connection to the X server.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>ctx</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies a GLX rendering context.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         </variablelist>
  48     </refsect1>
  49     <refsect1 id="description"><title>Description</title>
  50         <para>
  51             <function>glXFreeContextEXT</function> frees the client-side part of a GLXContext that
  52             was created with <citerefentry><refentrytitle>glXImportContextEXT</refentrytitle></citerefentry>. <function>glXFreeContextEXT</function> does not
  53             free the server-side context information or the XID
  54             associated with the server-side context.
  55         </para>
  56         <para>
  57             <function>glXFreeContextEXT</function> is part of the <code>EXT_import_context</code> extension,
  58             not part of the core GLX command set. If _glxextstring(EXT_import_context)
  59             is included in the string returned by <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>,
  60             when called with argument <constant>GLX_EXTENSIONS</constant>,
  61             extension <code>EXT_vertex_array</code> is supported.
  62         </para>
  63     </refsect1>
  64     <refsect1 id="errors"><title>Errors</title>
  65         <para>
  66             <constant>GLXBadContext</constant> is generated if <parameter>ctx</parameter> does not
  67             refer to a valid context.
  68         </para>
  69     </refsect1>
  70     <refsect1 id="seealso"><title>See Also</title>
  71         <para>
  72             <citerefentry><refentrytitle>glXCreateContext</refentrytitle></citerefentry>,
  73             <citerefentry><refentrytitle>glXQueryVersion</refentrytitle></citerefentry>,
  74             <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>,
  75             <citerefentry><refentrytitle>glXImportContextEXT</refentrytitle></citerefentry>
  76         </para>
  77     </refsect1>
  78     <refsect1 id="Copyright"><title>Copyright</title>
  79         <para>
  80             Copyright <trademark class="copyright"></trademark> 1991-2006
  81             Silicon Graphics, Inc. This document is licensed under the SGI
  82             Free Software B License. For details, see
  83             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  84         </para>
  85     </refsect1>
  86 </refentry>