/usr/share/doc/libghc-glut-doc/html/Graphics-UI-GLUT-Objects.html is in libghc-glut-doc 2.7.0.1-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.GLUT.Objects</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-GLUT-Objects.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-GLUT-Objects.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">GLUT-2.7.0.1: A binding for the OpenGL Utility Toolkit</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) Sven Panne 2002-2013</td></tr><tr><th>License</th><td>BSD3</td></tr><tr><th>Maintainer</th><td>Sven Panne <svenpanne@gmail.com></td></tr><tr><th>Stability</th><td>stable</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Graphics.UI.GLUT.Objects</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Rendering flavour</a></li><li><a href="#g:2">Object description</a></li><li><a href="#g:3">Type synonyms</a></li><li><a href="#g:4">Rendering</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>GLUT includes a number of routines for generating easily recognizable 3D
geometric objects. These routines reflect functionality available in the
<code>aux</code> toolkit described in the <em>OpenGL Programmer's Guide</em> and are included
in GLUT to allow the construction of simple GLUT programs that render
recognizable objects. These routines can be implemented as pure OpenGL
rendering routines. The routines do not generate display lists for the
objects they create. The routines generate normals appropriate for lighting
but do not generate texture coordinates (except for the solid teapot, teacup
and teaspoon). If VBOs should be used instead of the fixed function pipeline,
specify at least one of the attribute locations
<code><a href="Graphics-UI-GLUT-State.html#v:vertexAttribCoord3">vertexAttribCoord3</a></code> or
<code><a href="Graphics-UI-GLUT-State.html#v:vertexAttribNormal">vertexAttribNormal</a></code>.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Flavour">Flavour</a><ul class="subs"><li>= <a href="#v:Solid">Solid</a></li><li>| <a href="#v:Wireframe">Wireframe</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Object">Object</a><ul class="subs"><li>= <a href="#v:Cube">Cube</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a></li><li>| <a href="#v:Dodecahedron">Dodecahedron</a></li><li>| <a href="#v:Icosahedron">Icosahedron</a></li><li>| <a href="#v:Octahedron">Octahedron</a></li><li>| <a href="#v:Tetrahedron">Tetrahedron</a></li><li>| <a href="#v:RhombicDodecahedron">RhombicDodecahedron</a></li><li>| <a href="#v:Sphere-39-">Sphere'</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Slices">Slices</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Stacks">Stacks</a></li><li>| <a href="#v:Cone">Cone</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Slices">Slices</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Stacks">Stacks</a></li><li>| <a href="#v:Cylinder-39-">Cylinder'</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Slices">Slices</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Stacks">Stacks</a></li><li>| <a href="#v:Torus">Torus</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="Graphics-UI-GLUT-Objects.html#t:Sides">Sides</a> <a href="Graphics-UI-GLUT-Objects.html#t:Rings">Rings</a></li><li>| <a href="#v:Teapot">Teapot</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a></li><li>| <a href="#v:Teacup">Teacup</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a></li><li>| <a href="#v:Teaspoon">Teaspoon</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a></li><li>| <a href="#v:SierpinskiSponge">SierpinskiSponge</a> <a href="Graphics-UI-GLUT-Objects.html#t:NumLevels">NumLevels</a></li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:Sides">Sides</a> = <a href="file:///usr/share/doc/libghc-openglraw-doc/html/Graphics-Rendering-OpenGL-Raw-Types.html#t:GLint">GLint</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:Rings">Rings</a> = <a href="file:///usr/share/doc/libghc-openglraw-doc/html/Graphics-Rendering-OpenGL-Raw-Types.html#t:GLint">GLint</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:NumLevels">NumLevels</a> = <a href="file:///usr/share/doc/libghc-openglraw-doc/html/Graphics-Rendering-OpenGL-Raw-Types.html#t:GLint">GLint</a></li><li class="src short"><a href="#v:renderObject">renderObject</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/transformers-0.4.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="Graphics-UI-GLUT-Objects.html#t:Flavour">Flavour</a> -> <a href="Graphics-UI-GLUT-Objects.html#t:Object">Object</a> -> m ()</li></ul></div><div id="interface"><h1 id="g:1">Rendering flavour</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Flavour" class="def">Flavour</a> <a href="src/Graphics-UI-GLUT-Objects.html#Flavour" class="link">Source</a></p><div class="doc"><p>Flavour of object rendering</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Solid" class="def">Solid</a></td><td class="doc"><p>Object is rendered as a solid with shading and surface normals.</p></td></tr><tr><td class="src"><a name="v:Wireframe" class="def">Wireframe</a></td><td class="doc"><p>Object is rendered as a wireframe without surface normals.</p></td></tr></table></div><div class="subs instances"><p id="control.i:Flavour" class="caption collapser" onclick="toggleSection('i:Flavour')">Instances</p><div id="section.i:Flavour" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-GLUT-Objects.html#t:Flavour">Flavour</a></span> <a href="src/Graphics-UI-GLUT-Objects.html#line-58" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-GLUT-Objects.html#t:Flavour">Flavour</a></span> <a href="src/Graphics-UI-GLUT-Objects.html#line-58" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-GLUT-Objects.html#t:Flavour">Flavour</a></span> <a href="src/Graphics-UI-GLUT-Objects.html#line-58" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Object description</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Object" class="def">Object</a> <a href="src/Graphics-UI-GLUT-Objects.html#Object" class="link">Source</a></p><div class="doc"><p>GLUT offers five types of objects:</p><ul><li>The five Platonic solids, see
<a href="http://mathworld.wolfram.com/PlatonicSolid.html">http://mathworld.wolfram.com/PlatonicSolid.html</a>.</li><li>A rhombic dodecahedron, see
<a href="http://mathworld.wolfram.com/RhombicDodecahedron.html">http://mathworld.wolfram.com/RhombicDodecahedron.html</a>.</li><li>Approximations to rounded objects.</li><li>The classic teaset modeled by Martin Newell in 1975. Both surface normals
and texture coordinates for the teaset are generated.</li><li>A Sierpinski sponge, see
<a href="http://mathworld.wolfram.com/Tetrix.html">http://mathworld.wolfram.com/Tetrix.html</a>.</li></ul></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Cube" class="def">Cube</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a></td><td class="doc"><p>A cube centered at the modeling coordinates origin with sides of the
given length.</p></td></tr><tr><td class="src"><a name="v:Dodecahedron" class="def">Dodecahedron</a></td><td class="doc"><p>A dodecahedron (12-sided regular solid) centered at the modeling
coordinates origin with a radius of <code>sqrt 3</code>.</p></td></tr><tr><td class="src"><a name="v:Icosahedron" class="def">Icosahedron</a></td><td class="doc"><p>A icosahedron (20-sided regular solid) centered at the modeling
coordinates origin with a radius of 1.0.</p></td></tr><tr><td class="src"><a name="v:Octahedron" class="def">Octahedron</a></td><td class="doc"><p>Render a solid octahedron (8-sided regular solid) centered at the
modeling coordinates origin with a radius of 1.0.</p></td></tr><tr><td class="src"><a name="v:Tetrahedron" class="def">Tetrahedron</a></td><td class="doc"><p>Render a solid tetrahedron (4-sided regular solid) centered at the
modeling coordinates origin with a radius of <code>sqrt 3</code>.</p></td></tr><tr><td class="src"><a name="v:RhombicDodecahedron" class="def">RhombicDodecahedron</a></td><td class="doc"><p>(<em>freeglut only</em>) A rhombic dodecahedron whose corners are at most a
distance of one from the origin. The rhombic dodecahedron has faces
which are identical rhombi, but which have some vertices at which three
faces meet and some vertices at which four faces meet. The length of
each side is <code>(sqrt 3)/2</code>. Vertices at which four faces meet are found
at <code>(0, 0, +/-1)</code> and <code>(+/-(sqrt 2)/2, +/-(sqrt 2)/2, 0)</code>.</p></td></tr><tr><td class="src"><a name="v:Sphere-39-" class="def">Sphere'</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Slices">Slices</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Stacks">Stacks</a></td><td class="doc"><p>A sphere centered at the modeling coordinates origin of the specified
radius. The sphere is subdivided around the Z axis into slices
(similar to lines of longitude) and along the Z axis into stacks
(similar to lines of latitude).</p></td></tr><tr><td class="src"><a name="v:Cone" class="def">Cone</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Slices">Slices</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Stacks">Stacks</a></td><td class="doc"><p>A cone oriented along the Z axis. The base of the cone is placed at Z
= 0, and the top at Z = the given height. The cone is subdivided
around the Z axis into slices, and along the Z axis into stacks.</p></td></tr><tr><td class="src"><a name="v:Cylinder-39-" class="def">Cylinder'</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Slices">Slices</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Stacks">Stacks</a></td><td class="doc"><p>(<em>freeglut only</em>) A cylinder oriented along the Z axis. The base of the
cylinder is placed at Z = 0, and the top at Z = the given height. The
cylinder is subdivided around the Z axis into slices, and along the Z
axis into stacks.</p></td></tr><tr><td class="src"><a name="v:Torus" class="def">Torus</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Radius">Radius</a> <a href="Graphics-UI-GLUT-Objects.html#t:Sides">Sides</a> <a href="Graphics-UI-GLUT-Objects.html#t:Rings">Rings</a></td><td class="doc"><p>A torus (doughnut) centered at the modeling coordinates origin
whose axis is aligned with the Z axis. The torus is described by its
inner and outer radius, the number of sides for each radial section,
and the number of radial divisions (rings).</p></td></tr><tr><td class="src"><a name="v:Teapot" class="def">Teapot</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a></td><td class="doc"><p>A teapot with a given relative size.</p></td></tr><tr><td class="src"><a name="v:Teacup" class="def">Teacup</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a></td><td class="doc"><p>(<em>freeglut only</em>) A teacup with a given relative size.</p></td></tr><tr><td class="src"><a name="v:Teaspoon" class="def">Teaspoon</a> <a href="file:///usr/share/doc/libghc-opengl-doc/html/Graphics-Rendering-OpenGL-GLU-Quadrics.html#t:Height">Height</a></td><td class="doc"><p>(<em>freeglut only</em>) A teaspoon with a given relative size.</p></td></tr><tr><td class="src"><a name="v:SierpinskiSponge" class="def">SierpinskiSponge</a> <a href="Graphics-UI-GLUT-Objects.html#t:NumLevels">NumLevels</a></td><td class="doc"><p>(<em>freeglut only</em>) A Sierpinski sponge of a given level, where a level
0 sponge is the same as a <code><a href="Graphics-UI-GLUT-Objects.html#v:Tetrahedron">Tetrahedron</a></code>.</p></td></tr></table></div><div class="subs instances"><p id="control.i:Object" class="caption collapser" onclick="toggleSection('i:Object')">Instances</p><div id="section.i:Object" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-GLUT-Objects.html#t:Object">Object</a></span> <a href="src/Graphics-UI-GLUT-Objects.html#line-129" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-GLUT-Objects.html#t:Object">Object</a></span> <a href="src/Graphics-UI-GLUT-Objects.html#line-129" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-GLUT-Objects.html#t:Object">Object</a></span> <a href="src/Graphics-UI-GLUT-Objects.html#line-129" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:3">Type synonyms</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Sides" class="def">Sides</a> = <a href="file:///usr/share/doc/libghc-openglraw-doc/html/Graphics-Rendering-OpenGL-Raw-Types.html#t:GLint">GLint</a> <a href="src/Graphics-UI-GLUT-Objects.html#Sides" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Rings" class="def">Rings</a> = <a href="file:///usr/share/doc/libghc-openglraw-doc/html/Graphics-Rendering-OpenGL-Raw-Types.html#t:GLint">GLint</a> <a href="src/Graphics-UI-GLUT-Objects.html#Rings" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:NumLevels" class="def">NumLevels</a> = <a href="file:///usr/share/doc/libghc-openglraw-doc/html/Graphics-Rendering-OpenGL-Raw-Types.html#t:GLint">GLint</a> <a href="src/Graphics-UI-GLUT-Objects.html#NumLevels" class="link">Source</a></p></div><h1 id="g:4">Rendering</h1><div class="top"><p class="src"><a name="v:renderObject" class="def">renderObject</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/transformers-0.4.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="Graphics-UI-GLUT-Objects.html#t:Flavour">Flavour</a> -> <a href="Graphics-UI-GLUT-Objects.html#t:Object">Object</a> -> m () <a href="src/Graphics-UI-GLUT-Objects.html#renderObject" class="link">Source</a></p><div class="doc"><p>Render an object in the given flavour.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>
|