upstream-man-pages/man2/glXDestroyContext.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="glXDestroyContext">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXDestroyContext</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXDestroyContext</refname>
  17         <refpurpose>destroy a GLX context</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glXDestroyContext</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 the GLX context to be destroyed.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         </variablelist>
  48     </refsect1>
  49     <refsect1 id="description"><title>Description</title>
  50         <para>
  51             If the GLX rendering context <parameter>ctx</parameter> is not current to any thread,
  52             <function>glXDestroyContext</function>
  53             destroys it immediately.
  54             Otherwise,
  55             <parameter>ctx</parameter> is destroyed when it becomes not current to any thread.
  56             In either case, the resource ID
  57             referenced by <parameter>ctx</parameter> is freed immediately.
  58         </para>
  59     </refsect1>
  60     <refsect1 id="errors"><title>Errors</title>
  61         <para>
  62             <constant>GLXBadContext</constant> is generated if <parameter>ctx</parameter> is not a valid GLX context.
  63         </para>
  64     </refsect1>
  65     <refsect1 id="seealso"><title>See Also</title>
  66         <para>
  67             <citerefentry><refentrytitle>glXCreateContext</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>glXCreateNewContext</refentrytitle></citerefentry>,
  69             <citerefentry><refentrytitle>glXMakeCurrent</refentrytitle></citerefentry>
  70         </para>
  71     </refsect1>
  72     <refsect1 id="Copyright"><title>Copyright</title>
  73         <para>
  74             Copyright <trademark class="copyright"></trademark> 1991-2006
  75             Silicon Graphics, Inc. This document is licensed under the SGI
  76             Free Software B License. For details, see
  77             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  78         </para>
  79     </refsect1>
  80 </refentry>