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