upstream-doc/man2/gluQuadricNormals.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="gluQuadricNormals">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gluQuadricNormals</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gluQuadricNormals</refname>
  17         <refpurpose>specify what kind of normals are desired for quadrics</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>gluQuadricNormals</function></funcdef>
  23                 <paramdef>GLUquadric* <parameter>quad</parameter></paramdef>
  24                 <paramdef>GLenum <parameter>normal</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>normal</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies the desired type of normals. Valid values are
  44                     <constant>GLU_NONE</constant>,
  45                     <constant>GLU_FLAT</constant>, and
  46                     <constant>GLU_SMOOTH</constant>.
  47                 </para>
  48             </listitem>
  49         </varlistentry>
  50         </variablelist>
  51     </refsect1>
  52     <refsect1 id="description"><title>Description</title>
  53         <para>
  54             <function>gluQuadricNormals</function> specifies what kind of normals are desired for quadrics rendered with
  55             <parameter>quad</parameter>. The legal values are as follows:
  56         </para>
  57         <variablelist>
  58             <varlistentry>
  59                 <term><constant>GLU_NONE</constant></term>
  60                 <listitem>
  61                     <para>
  62                         No normals are generated.
  63                     </para>
  64                 </listitem>
  65             </varlistentry>
  66             <varlistentry>
  67                 <term><constant>GLU_FLAT</constant></term>
  68                 <listitem>
  69                     <para>
  70                         One normal is generated for every facet of a quadric.
  71                     </para>
  72                 </listitem>
  73             </varlistentry>
  74             <varlistentry>
  75                 <term><constant>GLU_SMOOTH</constant></term>
  76                 <listitem>
  77                     <para>
  78                         One normal is generated for every vertex of a quadric. This is the
  79                         initial value.
  80                     </para>
  81                 </listitem>
  82             </varlistentry>
  83         </variablelist>
  84     </refsect1>
  85     <refsect1 id="seealso"><title>See Also</title>
  86         <para>
  87             <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>,
  88             <citerefentry><refentrytitle>gluQuadricDrawStyle</refentrytitle></citerefentry>,
  89             <citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>,
  90             <citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>
  91         </para>
  92     </refsect1>
  93     <refsect1 id="Copyright"><title>Copyright</title>
  94         <para>
  95             Copyright <trademark class="copyright"></trademark> 1991-2006
  96             Silicon Graphics, Inc. This document is licensed under the SGI
  97             Free Software B License. For details, see
  98             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  99         </para>
 100     </refsect1>
 101 </refentry>