Subversion Repositories AndroidProjects

<?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="gluCylinder">

    <refmeta>

        <refmetainfo>

            <copyright>

                <year>1991-2006</year>

                <holder>Silicon Graphics, Inc.</holder>

            </copyright>

        </refmetainfo>

        <refentrytitle>gluCylinder</refentrytitle>

        <manvolnum>3G</manvolnum>

    </refmeta>

    <refnamediv>

        <refname>gluCylinder</refname>

        <refpurpose>draw a cylinder</refpurpose>

    </refnamediv>

    <refsynopsisdiv><title>C Specification</title>

        <funcsynopsis>

            <funcprototype>

                <funcdef>void <function>gluCylinder</function></funcdef>

                <paramdef>GLUquadric* <parameter>quad</parameter></paramdef>

                <paramdef>GLdouble <parameter>base</parameter></paramdef>

                <paramdef>GLdouble <parameter>top</parameter></paramdef>

                <paramdef>GLdouble <parameter>height</parameter></paramdef>

                <paramdef>GLint <parameter>slices</parameter></paramdef>

                <paramdef>GLint <parameter>stacks</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>base</parameter></term>

            <listitem>

                <para>

                    Specifies the radius of the cylinder at <emphasis>z</emphasis> = 0.

                </para>

            </listitem>

        </varlistentry>

        <varlistentry>

            <term><parameter>top</parameter></term>

            <listitem>

                <para>

                    Specifies the radius of the cylinder at <emphasis>z</emphasis> = <parameter>height</parameter>.

                </para>

            </listitem>

        </varlistentry>

        <varlistentry>

            <term><parameter>height</parameter></term>

            <listitem>

                <para>

                    Specifies the height of the cylinder.

                </para>

            </listitem>

        </varlistentry>

        <varlistentry>

            <term><parameter>slices</parameter></term>

            <listitem>

                <para>

                    Specifies the number of subdivisions around the <emphasis>z</emphasis> axis.

                </para>

            </listitem>

        </varlistentry>

        <varlistentry>

            <term><parameter>stacks</parameter></term>

            <listitem>

                <para>

                    Specifies the number of subdivisions along the <emphasis>z</emphasis> axis.

                </para>

            </listitem>

        </varlistentry>

        </variablelist>

    </refsect1>

    <refsect1 id="description"><title>Description</title>

        <para>

            <function>gluCylinder</function> draws a cylinder oriented along the <emphasis>z</emphasis> axis. The base of the cylinder

            is placed at <emphasis>z</emphasis> = 0 and the top at

            <inlineequation><mml:math>

                <!-- eqn: z  =  height:-->

                <mml:mrow>

                    <mml:mi mathvariant="italic">z</mml:mi>

                    <mml:mo>=</mml:mo>

                    <mml:mi mathvariant="italic">height</mml:mi>

                </mml:mrow>

            </mml:math></inlineequation>.

            Like a sphere,

            a cylinder is subdivided around the <emphasis>z</emphasis> axis into slices and along the

            <emphasis>z</emphasis> axis into stacks.

        </para>

        <para>

            Note that if <parameter>top</parameter> is set to 0.0, this routine generates a cone.

        </para>

        <para>

            If the orientation is set to <constant>GLU_OUTSIDE</constant>

            (with <citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>), then any generated normals

            point away from the <emphasis>z</emphasis> axis. Otherwise, they point toward the

            <emphasis>z</emphasis> axis.

        </para>

        <para>

            If texturing is turned on (with <citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>), then texture

            coordinates are generated so that <emphasis>t</emphasis> ranges linearly from 0.0

            at <emphasis>z</emphasis> = 0 to 1.0 at <emphasis>z</emphasis> = <parameter>height</parameter>, and <emphasis>s</emphasis>

            ranges from 0.0 at the +<emphasis>y</emphasis> axis, to 0.25 at the +<emphasis>x</emphasis> axis,

            to 0.5 at the -<emphasis>y</emphasis> axis, to 0.75 at the \-<emphasis>x</emphasis> axis,

            and back to 1.0 at the +<emphasis>y</emphasis> axis.

        </para>

    </refsect1>

    <refsect1 id="seealso"><title>See Also</title>

        <para>

            <citerefentry><refentrytitle>gluDisk</refentrytitle></citerefentry>,

            <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>,

            <citerefentry><refentrytitle>gluPartialDisk</refentrytitle></citerefentry>,

            <citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>,

            <citerefentry><refentrytitle>gluSphere</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>