upstream-man-pages/man2/glXDestroyGLXPixmap.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="glXDestroyGLXPixmap">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXDestroyGLXPixmap</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXDestroyGLXPixmap</refname>
  17         <refpurpose>destroy a GLX pixmap</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glXDestroyGLXPixmap</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>GLXPixmap <parameter>pix</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>pix</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies the GLX pixmap 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 pixmap <parameter>pix</parameter> is not current to any client,
  52             <function>glXDestroyGLXPixmap</function> destroys it immediately.
  53             Otherwise,
  54             <parameter>pix</parameter> is destroyed when it becomes not current to any client.
  55             In either case, the resource ID
  56             is freed immediately.
  57         </para>
  58     </refsect1>
  59     <refsect1 id="errors"><title>Errors</title>
  60         <para>
  61             <constant>GLXBadPixmap</constant> is generated if <parameter>pix</parameter> is not a valid GLX pixmap.
  62         </para>
  63     </refsect1>
  64     <refsect1 id="seealso"><title>See Also</title>
  65         <para>
  66             <citerefentry><refentrytitle>glXCreateGLXPixmap</refentrytitle></citerefentry>,
  67             <citerefentry><refentrytitle>glXDestroyPixmap</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>glXMakeCurrent</refentrytitle></citerefentry>
  69         </para>
  70     </refsect1>
  71     <refsect1 id="Copyright"><title>Copyright</title>
  72         <para>
  73             Copyright <trademark class="copyright"></trademark> 1991-2006
  74             Silicon Graphics, Inc. This document is licensed under the SGI
  75             Free Software B License. For details, see
  76             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  77         </para>
  78     </refsect1>
  79 </refentry>