upstream-man-pages/man2/gluQuadricDrawStyle.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="gluQuadricDrawStyle">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gluQuadricDrawStyle</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gluQuadricDrawStyle</refname>
  17         <refpurpose>specify the draw style desired for quadrics</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>gluQuadricDrawStyle</function></funcdef>
  23                 <paramdef>GLUquadric* <parameter>quad</parameter></paramdef>
  24                 <paramdef>GLenum <parameter>draw</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>quad</parameter></term>
  33             <listitem>
  34                 <para>
  35                     Specifies the quadrics object (created with <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>).
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>draw</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies the desired draw style. Valid values are
  44                     <constant>GLU_FILL</constant>,
  45                     <constant>GLU_LINE</constant>,
  46                     <constant>GLU_SILHOUETTE</constant>, and
  47                     <constant>GLU_POINT</constant>.
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         </variablelist>
  52     </refsect1>
  53     <refsect1 id="description"><title>Description</title>
  54         <para>
  55             <function>gluQuadricDrawStyle</function> specifies the draw style for quadrics rendered with
  56             <parameter>quad</parameter>. The legal values are as follows:
  57         </para>
  58         <variablelist>
  59             <varlistentry>
  60                 <term><constant>GLU_FILL</constant></term>
  61                 <listitem>
  62                     <para>
  63                         Quadrics are rendered with polygon primitives. The polygons
  64                         are drawn in a counterclockwise fashion with respect to their
  65                         normals (as defined with <citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>).
  66                     </para>
  67                 </listitem>
  68             </varlistentry>
  69             <varlistentry>
  70                 <term><constant>GLU_LINE</constant></term>
  71                 <listitem>
  72                     <para>
  73                         Quadrics are rendered as a set of lines.
  74                     </para>
  75                 </listitem>
  76             </varlistentry>
  77             <varlistentry>
  78                 <term><constant>GLU_SILHOUETTE</constant></term>
  79                 <listitem>
  80                     <para>
  81                         Quadrics are rendered as a set of lines, except that edges separating
  82                         coplanar faces will not be drawn.
  83                     </para>
  84                 </listitem>
  85             </varlistentry>
  86             <varlistentry>
  87                 <term><constant>GLU_POINT</constant></term>
  88                 <listitem>
  89                     <para>
  90                         Quadrics are rendered as a set of points.
  91                     </para>
  92                 </listitem>
  93             </varlistentry>
  94         </variablelist>
  95     </refsect1>
  96     <refsect1 id="seealso"><title>See Also</title>
  97         <para>
  98             <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>,
  99             <citerefentry><refentrytitle>gluQuadricNormals</refentrytitle></citerefentry>,
 100             <citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>,
 101             <citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>
 102         </para>
 103     </refsect1>
 104     <refsect1 id="Copyright"><title>Copyright</title>
 105         <para>
 106             Copyright <trademark class="copyright"></trademark> 1991-2006
 107             Silicon Graphics, Inc. This document is licensed under the SGI
 108             Free Software B License. For details, see
 109             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 110         </para>
 111     </refsect1>
 112 </refentry>