upstream-man-pages/man2/glXDestroyPixmap.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="glXDestroyPixmap">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXDestroyPixmap</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXDestroyPixmap</refname>
  17         <refpurpose>destroy an off-screen rendering area</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glXDestroyPixmap</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>GLXPixmap <parameter>pixmap</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>pixmap</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies the GLXPixmap to be destroyed.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         </variablelist>
  48     </refsect1>
  49     <refsect1 id="description"><title>Description</title>
  50         <para>
  51             <function>glXDestroyPixmap</function> destroys a GLXPixmap created by <citerefentry><refentrytitle>glXCreatePixmap</refentrytitle></citerefentry>.
  52         </para>
  53     </refsect1>
  54     <refsect1 id="notes"><title>Notes</title>
  55         <para>
  56             <function>glXDestroyPixmap</function> is available only if the GLX version is 1.3 or greater.
  57         </para>
  58         <para>
  59             If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
  60             If the GLX version is 1.2, then the GL version must be 1.1.
  61             If the GLX version is 1.3, then the GL version must be 1.2.
  62         </para>
  63     </refsect1>
  64     <refsect1 id="errors"><title>Errors</title>
  65         <para>
  66             <constant>GLXBadPixmap</constant> is generated if <parameter>pixmap</parameter> is not a valid
  67             GLXPixmap.
  68         </para>
  69     </refsect1>
  70     <refsect1 id="seealso"><title>See Also</title>
  71         <para>
  72             <citerefentry><refentrytitle>glXChooseFBConfig</refentrytitle></citerefentry>,
  73             <citerefentry><refentrytitle>glXCreatePixmap</refentrytitle></citerefentry>,
  74             <citerefentry><refentrytitle>glXDestroyGLXPixmap</refentrytitle></citerefentry>,
  75             <citerefentry><refentrytitle>glXMakeContextCurrent</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>