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

95 lines
4 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="gluQuadricOrientation">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>gluQuadricOrientation</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>gluQuadricOrientation</refname>
<refpurpose>specify inside/outside orientation for quadrics</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>gluQuadricOrientation</function></funcdef>
<paramdef>GLUquadric* <parameter>quad</parameter></paramdef>
<paramdef>GLenum <parameter>orientation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- eqn: ignoring delim $$ -->
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>quad</parameter></term>
<listitem>
<para>
Specifies the quadrics object (created with <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>orientation</parameter></term>
<listitem>
<para>
Specifies the desired orientation. Valid values are
<constant>GLU_OUTSIDE</constant> and
<constant>GLU_INSIDE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>gluQuadricOrientation</function> specifies what kind of orientation is desired for quadrics rendered
with <parameter>quad</parameter>. The <parameter>orientation</parameter> values are as follows:
</para>
<variablelist>
<varlistentry>
<term><constant>GLU_OUTSIDE</constant> </term>
<listitem>
<para>
Quadrics are drawn with normals pointing outward (the initial value).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GLU_INSIDE</constant> </term>
<listitem>
<para>
Quadrics are drawn with normals pointing inward.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Note that the interpretation of <emphasis>outward</emphasis> and <emphasis>inward</emphasis> depends on the
quadric being drawn.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>gluQuadricDrawStyle</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>gluQuadricNormals</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>gluQuadricTexture</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>