upstream-doc/man2/gluDeleteQuadric.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="gluDeleteQuadric">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gluDeleteQuadric</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gluDeleteQuadric</refname>
  17         <refpurpose>destroy a quadrics object</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>gluDeleteQuadric</function></funcdef>
  23                 <paramdef>GLUquadric* <parameter>quad</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <!-- eqn: ignoring delim $$ -->
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>quad</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies the quadrics object to be destroyed.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         </variablelist>
  39     </refsect1>
  40     <refsect1 id="description"><title>Description</title>
  41         <para>
  42             <function>gluDeleteQuadric</function> destroys the quadrics object (created with <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>)
  43             and frees any memory it uses.
  44             Once <function>gluDeleteQuadric</function> has been called, <parameter>quad</parameter> cannot be used again.
  45         </para>
  46     </refsect1>
  47     <refsect1 id="seealso"><title>See Also</title>
  48         <para>
  49             <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>
  50         </para>
  51     </refsect1>
  52     <refsect1 id="Copyright"><title>Copyright</title>
  53         <para>
  54             Copyright <trademark class="copyright"></trademark> 1991-2006
  55             Silicon Graphics, Inc. This document is licensed under the SGI
  56             Free Software B License. For details, see
  57             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  58         </para>
  59     </refsect1>
  60 </refentry>