From: <dc...@us...> - 2012-03-26 16:14:38
|
Revision: 1216 http://freeglut.svn.sourceforge.net/freeglut/?rev=1216&view=rev Author: dcnieho Date: 2012-03-26 16:14:27 +0000 (Mon, 26 Mar 2012) Log Message: ----------- cleanup up make up of geometry function docs a bit added glutCylinder (description TODO) Modified Paths: -------------- trunk/freeglut/web-src/docs/api.php Modified: trunk/freeglut/web-src/docs/api.php =================================================================== --- trunk/freeglut/web-src/docs/api.php 2012-03-26 13:51:15 UTC (rev 1215) +++ trunk/freeglut/web-src/docs/api.php 2012-03-26 16:14:27 UTC (rev 1216) @@ -1720,26 +1720,21 @@ draw a wireframe and solid sphere respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireSphere ( GLdouble dRadius, -GLint slices, GLint stacks );</tt> </p> +<p><tt> +void glutWireSphere (GLdouble dRadius, GLint slices, GLint stacks);<br> +void glutSolidSphere(GLdouble dRadius, GLint slices, GLint stacks);</tt> </p> -<p><tt>void glutSolidSphere ( GLdouble dRadius, -GLint slices, GLint stacks );</tt> </p> +<p><b>Arguments</b></p> +<p><tt>dRadius </tt>The desired radius of the sphere </p> -<p><tt>dRadius -</tt>The desired radius of the sphere </p> - -<p><tt>slices -</tt>The desired number of slices (divisions +<p><tt>slices </tt>The desired number of slices (divisions in the longitudinal direction) in the sphere </p> -<p><tt>stacks -</tt>The desired number of stacks (divisions +<p><tt>stacks </tt>The desired number of stacks (divisions in the latitudinal direction) in the sphere. The number of points in -this direction, including the north and south poles, is <tt>stacks+1</tt> - </p> +this direction, including the north and south poles, is <tt>stacks+1</tt></p> <p><b>Description</b></p> @@ -1761,28 +1756,25 @@ a wireframe and solid torus (donut shape) respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireTorus ( GLdouble dInnerRadius, -GLdouble dOuterRadius, GLint nSides, GLint nRings );</tt> </p> +<p><tt> +void glutWireTorus (GLdouble dInnerRadius, GLdouble dOuterRadius, GLint +nSides, GLint nRings);<br> +void glutSolidTorus(GLdouble dInnerRadius, GLdouble dOuterRadius, GLint +nSides, GLint nRings);</tt> </p> -<p><tt>void glutSolidTorus ( GLdouble dInnerRadius, -GLdouble dOuterRadius, GLint nSides, GLint nRings );</tt> </p> - -<p><tt>dInnerRadius -</tt>The desired inner radius of the torus, +<p><b>Arguments</b></p> +<p><tt>dInnerRadius </tt>The desired inner radius of the torus, from the origin to the circle defining the centers of the outer circles </p> -<p><tt>dOuterRadius -</tt>The desired outer radius of the torus, +<p><tt>dOuterRadius </tt>The desired outer radius of the torus, from the center of the outer circle to the actual surface of the torus </p> -<p><tt>nSides -</tt>The desired number of segments in a +<p><tt>nSides </tt>The desired number of segments in a single outer circle of the torus </p> -<p><tt>nRings -</tt>The desired number of outer circles +<p><tt>nRings </tt>The desired number of outer circles around the origin of the torus </p> <p><b>Description</b></p> @@ -1796,34 +1788,57 @@ <p>None that we know of. </p> -<h2>15.3 glutWireCone, glutSolidCone</h2> +<h2>15.3 glutWireCylinder, glutSolidCylinder</h2> <p> +The <tt>glutWireCylinder</tt> and <tt>glutSolidCylinder</tt> functions draw +a wireframe and solid cone respectively. +</p> + +<p><b>Definition</b></p> + +<p><tt> +void glutWireCylinder (GLdouble base, GLdouble height, GLint slices, GLint +stacks);<br> +void glutSolidCylinder(GLdouble base, GLdouble height, GLint slices, GLint +stacks);</tt> </p> + +<p><b>Arguments</b></p> +<p><tt>radius </tt>The desired radius of the cylinder </p> + +<p><tt>height </tt>The desired height of the cylinder </p> + +<p><tt>slices </tt>The desired number of slices around +the cylinder </p> + +<p><tt>stacks </tt>The desired number of segments between +the base and the top of the cylinder (the number of points, including +the tip, is <tt>stacks + 1</tt>) </p> + +<h2>15.4 glutWireCone, glutSolidCone</h2> + +<p> The <tt>glutWireCone</tt> and <tt>glutSolidCone</tt> functions draw a wireframe and solid cone respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireCone ( GLdouble base, -GLdouble height, GLint slices, GLint stacks );</tt> </p> +<p><tt> +void glutWireCone (GLdouble base, GLdouble height, GLint slices, GLint +stacks);<br> +void glutSolidCone(GLdouble base, GLdouble height, GLint slices, GLint +stacks);</tt> </p> -<p><tt>void glutSolidCone ( GLdouble base, -GLdouble height, GLint slices, GLint stacks );</tt> </p> +<p><b>Arguments</b></p> +<p><tt>base </tt>The desired radius of the base of the cone </p> -<p><tt>base -</tt>The desired radius of the base of the -cone </p> +<p><tt>height </tt>The desired height of the cone </p> -<p><tt>height -</tt>The desired height of the cone </p> - -<p><tt>slices -</tt>The desired number of slices around +<p><tt>slices </tt>The desired number of slices around the base of the cone </p> -<p><tt>stacks -</tt>The desired number of segments between +<p><tt>stacks </tt>The desired number of segments between the base and the tip of the cone (the number of points, including the tip, is <tt>stacks + 1</tt>) </p> @@ -1838,25 +1853,22 @@ <p>None that we know of. </p> -<h2>15.4 glutWireCube, glutSolidCube</h2> +<h2>15.5 glutWireCube, glutSolidCube</h2> <p> The <tt>glutWireCube</tt> and <tt>glutSolidCube</tt> functions draw a wireframe and solid cube respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireCube ( GLdouble dSize -);</tt> </p> +<p><tt> +void glutWireCube (GLdouble dSize);<br> +void glutSolidCube(GLdouble dSize);</tt> </p> -<p><tt>void glutSolidCube ( GLdouble dSize -);</tt> </p> +<p><b>Arguments</b></p> +<p><tt>dSize </tt>The desired length of an edge of the cube</p> -<p><tt>dSize -</tt>The desired length of an edge of the -cube </p> - <p><b>Description</b></p> <p>The <tt>glutWireCube</tt> and <tt> @@ -1867,7 +1879,7 @@ <p>None that we know of. </p> -<h2>15.5 glutWireTetrahedron, glutSolidTetrahedron</h2> +<h2>15.6 glutWireTetrahedron, glutSolidTetrahedron</h2> <p> The <tt>glutWireTetrahedron</tt> and <tt>glutSolidTetrahedron</tt> @@ -1875,14 +1887,12 @@ respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireTetrahedron ( void ) -;</tt> </p> +<p><tt> +void glutWireTetrahedron (void);<br> +void glutSolidTetrahedron(void);</tt></p> -<p><tt>void glutSolidTetrahedron ( void -);</tt> </p> - <p><b>Description</b></p> <p>The <tt>glutWireTetrahedron</tt> and @@ -1895,21 +1905,19 @@ <p>None that we know of. </p> -<h2>15.6 glutWireOctahedron, glutSolidOctahedron</h2> +<h2>15.7 glutWireOctahedron, glutSolidOctahedron</h2> <p> The <tt>glutWireOctahedron</tt> and <tt>glutSolidOctahedron</tt> functions draw a wireframe and solid octahedron (eight-sided Platonic solid) respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireOctahedron ( void ) -;</tt> </p> +<p><tt> +void glutWireOctahedron (void);<br> +void glutSolidOctahedron(void);</tt></p> -<p><tt>void glutSolidOctahedron ( void ) -;</tt> </p> - <p><b>Description</b></p> <p>The <tt>glutWireOctahedron</tt> and @@ -1922,7 +1930,7 @@ <p>None that we know of. </p> -<h2>15.7 glutWireDodecahedron, glutSolidDodecahedron</h2> +<h2>15.8 glutWireDodecahedron, glutSolidDodecahedron</h2> <p> The <tt>glutWireDodecahedron</tt> and <tt>glutSolidDodecahedron</tt> @@ -1930,14 +1938,12 @@ solid) respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireDodecahedron ( void -);</tt> </p> +<p><tt> +void glutWireDodecahedron (void);<br> +void glutSolidDodecahedron(void);</tt></p> -<p><tt>void glutSolidDodecahedron ( void -);</tt> </p> - <p><b>Description</b></p> <p>The <tt>glutWireDodecahedron</tt> and @@ -1951,7 +1957,7 @@ <p>None that we know of. </p> -<h2>15.8 glutWireIcosahedron, glutSolidIcosahedron</h2> +<h2>15.9 glutWireIcosahedron, glutSolidIcosahedron</h2> <p> The <tt>glutWireIcosahedron</tt> and <tt>glutSolidIcosahedron</tt> @@ -1959,14 +1965,12 @@ respectively. </p> -<p><b>Usage</b> </p> +<p><b>Definition</b></p> -<p><tt>void glutWireIcosahedron ( void ) -;</tt> </p> +<p><tt> +void glutWireIcosahedron (void);<br> +void glutSolidIcosahedron(void);</tt></p> -<p><tt>void glutSolidIcosahedron ( void -);</tt> </p> - <p><b>Description</b></p> <p> @@ -1981,7 +1985,7 @@ <p>None that we know of. </p> -<h2>15.7 glutWireRhombicDodecahedron, glutSolidRhombicDodecahedron</h2> +<h2>15.10 glutWireRhombicDodecahedron, glutSolidRhombicDodecahedron</h2> <p> The <tt>glutWireRhombicDodecahedron</tt> and <tt>glutSolidRhombicDodecahedron</tt> @@ -1989,14 +1993,12 @@ semi-regular solid) respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireRhombicDodecahedron -( void );</tt> </p> +<p><tt> +void glutWireRhombicDodecahedron (void);<br> +void glutSolidRhombicDodecahedron(void);</tt></p> -<p><tt>void glutSolidRhombicDodecahedron -( void );</tt> </p> - <p><b>Description</b></p> <p> @@ -2015,24 +2017,22 @@ <p>GLUT does not include these functions. </p> -<h2>15.10 glutWireTeapot, glutSolidTeapot</h2> +<h2>15.11 glutWireTeapot, glutSolidTeapot</h2> <p> The <tt>glutWireTeapot</tt> and <tt>glutSolidTeapot</tt> functions draw a wireframe and solid teapot respectively. </p> -<p><b>Usage</b></p> +<p><b>Definition</b></p> -<p><tt>void glutWireTeapot ( GLdouble dSize -);</tt> </p> +<p><tt> +void glutWireTeapot (GLdouble dSize);<br> +void glutSolidTeapot(GLdouble dSize);</tt></p> -<p><tt>void glutSolidTeapot ( GLdouble dSize -);</tt> </p> +<p><b>Arguments</b></p> +<p><tt>dSize </tt>The desired size of the teapot </p> -<p><tt>dSize -</tt>The desired size of the teapot </p> - <p><b>Description</b></p> <p>The <tt>glutWireTeapot</tt> and <tt> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |