599a49e3e39159c9f7eb1973179aff2947c6ba7b
[clinton/guile-figl.git] / upstream-man-pages / man2 / xhtml / gluDisk.xml
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
2 <!-- saved from url=(0013)about:internet -->
3 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>gluDisk</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="gluDisk"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>gluDisk — draw a disk</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">gluDisk</b>(</code></td><td>GLUquadric*  </td><td><var class="pdparam">quad</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">inner</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">outer</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">slices</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">loops</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>quad</code></em></span></dt><dd><p>
4 Specifies the quadrics object (created with <a class="citerefentry" href="gluNewQuadric.xml"><span class="citerefentry"><span class="refentrytitle">gluNewQuadric</span></span></a>).
5 </p></dd><dt><span class="term"><em class="parameter"><code>inner</code></em></span></dt><dd><p>
6 Specifies the inner radius of the disk (may be 0).
7 </p></dd><dt><span class="term"><em class="parameter"><code>outer</code></em></span></dt><dd><p>
8 Specifies the outer radius of the disk.
9 </p></dd><dt><span class="term"><em class="parameter"><code>slices</code></em></span></dt><dd><p>
10 Specifies the number of subdivisions around the <span class="emphasis"><em>z</em></span> axis.
11 </p></dd><dt><span class="term"><em class="parameter"><code>loops</code></em></span></dt><dd><p>
12 Specifies the number of concentric rings about the origin into which
13 the disk is subdivided.
14 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
15 <code class="function">gluDisk</code> renders a disk on the <span class="emphasis"><em>z</em></span> = 0 plane. The disk has a radius of
16 <em class="parameter"><code>outer</code></em> and contains a concentric circular hole with a radius
17 of <em class="parameter"><code>inner</code></em>. If <em class="parameter"><code>inner</code></em> is 0, then no hole is generated. The disk is
18 subdivided around the <span class="emphasis"><em>z</em></span> axis into slices (like pizza slices) and also
19 about the <span class="emphasis"><em>z</em></span> axis into rings
20 (as specified by <em class="parameter"><code>slices</code></em> and <em class="parameter"><code>loops</code></em>, respectively).
21 </p><p>
22 With respect to orientation, the +<span class="emphasis"><em>z</em></span> side of the disk is considered to be
23 ``outside'' (see <a class="citerefentry" href="gluQuadricOrientation.xml"><span class="citerefentry"><span class="refentrytitle">gluQuadricOrientation</span></span></a>).
24 This means that if the
25 orientation is set to <code class="constant">GLU_OUTSIDE</code>, then any normals generated
26 point along the +<span class="emphasis"><em>z</em></span> axis. Otherwise, they point along the \-<span class="emphasis"><em>z</em></span>
27 axis.
28 </p><p>
29 If texturing has been turned on (with <a class="citerefentry" href="gluQuadricTexture.xml"><span class="citerefentry"><span class="refentrytitle">gluQuadricTexture</span></span></a>),
30 texture coordinates are generated
31 linearly such that where
32 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
33
34 <mml:mrow>
35 <mml:mi mathvariant="italic">r</mml:mi>
36 <mml:mo>=</mml:mo>
37 <mml:mi mathvariant="italic">outer</mml:mi>
38 </mml:mrow>
39 </mml:math>,
40 the value at (<span class="emphasis"><em>r</em></span>, 0, 0) is
41 (1, 0.5), at (0, <span class="emphasis"><em>r</em></span>, 0) it is (0.5, 1), at (\-<span class="emphasis"><em>r</em></span>, 0, 0)
42 it is (0, 0.5), and
43 at (0, \-<span class="emphasis"><em>r</em></span>, 0) it is (0.5, 0).
44 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
45 <a class="citerefentry" href="gluCylinder.xml"><span class="citerefentry"><span class="refentrytitle">gluCylinder</span></span></a>,
46 <a class="citerefentry" href="gluNewQuadric.xml"><span class="citerefentry"><span class="refentrytitle">gluNewQuadric</span></span></a>,
47 <a class="citerefentry" href="gluPartialDisk.xml"><span class="citerefentry"><span class="refentrytitle">gluPartialDisk</span></span></a>,
48 <a class="citerefentry" href="gluQuadricOrientation.xml"><span class="citerefentry"><span class="refentrytitle">gluQuadricOrientation</span></span></a>,
49 <a class="citerefentry" href="gluQuadricTexture.xml"><span class="citerefentry"><span class="refentrytitle">gluQuadricTexture</span></span></a>,
50 <a class="citerefentry" href="gluSphere.xml"><span class="citerefentry"><span class="refentrytitle">gluSphere</span></span></a>
51 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
52 Copyright <span class="trademark"></span>© 1991-2006
53 Silicon Graphics, Inc. This document is licensed under the SGI
54 Free Software B License. For details, see
55 <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
56 </p></div></div></body></html>