Opentk/Source/Bind/Specifications/Docs/glXDestroyGLXPixmap.xml
2009-03-08 00:46:58 +00:00

79 lines
3.1 KiB
XML

<?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="glXDestroyGLXPixmap">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glXDestroyGLXPixmap</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glXDestroyGLXPixmap</refname>
<refpurpose>destroy a GLX pixmap</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glXDestroyGLXPixmap</function></funcdef>
<paramdef>Display * <parameter>dpy</parameter></paramdef>
<paramdef>GLXPixmap <parameter>pix</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>pix</parameter></term>
<listitem>
<para>
Specifies the GLX pixmap to be destroyed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
If the GLX pixmap <parameter>pix</parameter> is not current to any client,
<function>glXDestroyGLXPixmap</function> destroys it immediately.
Otherwise,
<parameter>pix</parameter> is destroyed when it becomes not current to any client.
In either case, the resource ID
is freed immediately.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GLXBadPixmap</constant> is generated if <parameter>pix</parameter> is not a valid GLX pixmap.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glXCreateGLXPixmap</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXDestroyPixmap</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXMakeCurrent</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>