00001 #ifndef __glut_h__
00002 #define __glut_h__
00003 
00004 /* Copyright (c) Mark J. Kilgard, 1994, 1995, 1996. */
00005 
00006 /* This program is freely distributable without licensing fees  and is
00007    provided without guarantee or warrantee expressed or  implied. This
00008    program is -not- in the public domain. */
00009 
00010 #include <GL/gl.h>
00011 #include <GL/glu.h>
00012 
00013 #ifdef __cplusplus
00014 extern "C" {
00015 #endif
00016 
00017 /* 
00018  * GLUT API revision history:
00019  *
00020  * GLUT_API_VERSION is updated to reflect incompatible GLUT
00021  * API changes (interface changes, semantic changes, deletions,
00022  * or additions).
00023  *
00024  * GLUT_API_VERSION=1  First public release of GLUT.  11/29/94
00025  *
00026  * GLUT_API_VERSION=2  Added support for OpenGL/GLX multisampling,
00027  * extension.  Supports new input devices like tablet, dial and button
00028  * box, and Spaceball.  Easy to query OpenGL extensions.
00029  *
00030  * GLUT_API_VERSION=3  glutMenuStatus added.
00031  *
00032  */
00033 #ifndef GLUT_API_VERSION  /* allow this to be overriden */
00034 #define GLUT_API_VERSION                3
00035 #endif
00036 
00037 /* 
00038  * GLUT implementation revision history:
00039  * 
00040  * GLUT_XLIB_IMPLEMENTATION is updated to reflect both GLUT
00041  * API revisions and implementation revisions (ie, bug fixes).
00042  *
00043  * GLUT_XLIB_IMPLEMENTATION=1  mjk's first public release of
00044  * GLUT Xlib-based implementation.  11/29/94
00045  *
00046  * GLUT_XLIB_IMPLEMENTATION=2  mjk's second public release of
00047  * GLUT Xlib-based implementation providing GLUT version 2 
00048  * interfaces.
00049  *
00050  * GLUT_XLIB_IMPLEMENTATION=3  mjk's GLUT 2.2 images. 4/17/95
00051  *
00052  * GLUT_XLIB_IMPLEMENTATION=4  mjk's GLUT 2.3 images. 6/?/95
00053  *
00054  * GLUT_XLIB_IMPLEMENTATION=5  mjk's GLUT 3.0 images. 10/?/95
00055  *
00056  * GLUT_XLIB_IMPLEMENTATION=5  mjk's GLUT 3.1 images.
00057  */
00058 #ifndef GLUT_XLIB_IMPLEMENTATION  /* allow this to be overriden */
00059 #define GLUT_XLIB_IMPLEMENTATION        6
00060 #endif
00061 
00062 /* display mode bit masks */
00063 #define GLUT_RGB                        0
00064 #define GLUT_RGBA                       GLUT_RGB
00065 #define GLUT_INDEX                      1
00066 #define GLUT_SINGLE                     0
00067 #define GLUT_DOUBLE                     2
00068 #define GLUT_ACCUM                      4
00069 #define GLUT_ALPHA                      8
00070 #define GLUT_DEPTH                      16
00071 #define GLUT_STENCIL                    32
00072 #if (GLUT_API_VERSION >= 2)
00073 #define GLUT_MULTISAMPLE                128
00074 #define GLUT_STEREO                     256
00075 #endif
00076 #if (GLUT_API_VERSION >= 3)
00077 #define GLUT_LUMINANCE                  512
00078 #endif
00079 
00080 /* mouse buttons */
00081 #define GLUT_LEFT_BUTTON                0
00082 #define GLUT_MIDDLE_BUTTON              1
00083 #define GLUT_RIGHT_BUTTON               2
00084 
00085 /* mouse button callback state */
00086 #define GLUT_DOWN                       0
00087 #define GLUT_UP                         1
00088 
00089 #if (GLUT_API_VERSION >= 2)
00090 /* function keys */
00091 #define GLUT_KEY_F1                     1
00092 #define GLUT_KEY_F2                     2
00093 #define GLUT_KEY_F3                     3
00094 #define GLUT_KEY_F4                     4
00095 #define GLUT_KEY_F5                     5
00096 #define GLUT_KEY_F6                     6
00097 #define GLUT_KEY_F7                     7
00098 #define GLUT_KEY_F8                     8
00099 #define GLUT_KEY_F9                     9
00100 #define GLUT_KEY_F10                    10
00101 #define GLUT_KEY_F11                    11
00102 #define GLUT_KEY_F12                    12
00103 /* directional keys */
00104 #define GLUT_KEY_LEFT                   100
00105 #define GLUT_KEY_UP                     101
00106 #define GLUT_KEY_RIGHT                  102
00107 #define GLUT_KEY_DOWN                   103
00108 #define GLUT_KEY_PAGE_UP                104
00109 #define GLUT_KEY_PAGE_DOWN              105
00110 #define GLUT_KEY_HOME                   106
00111 #define GLUT_KEY_END                    107
00112 #define GLUT_KEY_INSERT                 108
00113 #endif
00114 
00115 /* entry/exit callback state */
00116 #define GLUT_LEFT                       0
00117 #define GLUT_ENTERED                    1
00118 
00119 /* menu usage callback state */
00120 #define GLUT_MENU_NOT_IN_USE            0
00121 #define GLUT_MENU_IN_USE                1
00122 
00123 /* visibility callback state */
00124 #define GLUT_NOT_VISIBLE                0
00125 #define GLUT_VISIBLE                    1
00126 
00127 /* color index component selection values */
00128 #define GLUT_RED                        0
00129 #define GLUT_GREEN                      1
00130 #define GLUT_BLUE                       2
00131 
00132 /* layers for use */
00133 #define GLUT_NORMAL                     0
00134 #define GLUT_OVERLAY                    1
00135 
00136 /* stroke font opaque addresses (use constants instead in source code) */
00137 extern void *glutStrokeRoman;
00138 extern void *glutStrokeMonoRoman;
00139 
00140 /* stroke font constants (use these in GLUT program) */
00141 #define GLUT_STROKE_ROMAN               (&glutStrokeRoman)
00142 #define GLUT_STROKE_MONO_ROMAN          (&glutStrokeMonoRoman)
00143 
00144 /* bitmap font opaque addresses (use constants instead in source code) */
00145 extern void *glutBitmap9By15;
00146 extern void *glutBitmap8By13;
00147 extern void *glutBitmapTimesRoman10;
00148 extern void *glutBitmapTimesRoman24;
00149 extern void *glutBitmapHelvetica10;
00150 extern void *glutBitmapHelvetica12;
00151 extern void *glutBitmapHelvetica18;
00152 
00153 /* bitmap font constants (use these in GLUT program) */
00154 #define GLUT_BITMAP_9_BY_15             (&glutBitmap9By15)
00155 #define GLUT_BITMAP_8_BY_13             (&glutBitmap8By13)
00156 #define GLUT_BITMAP_TIMES_ROMAN_10      (&glutBitmapTimesRoman10)
00157 #define GLUT_BITMAP_TIMES_ROMAN_24      (&glutBitmapTimesRoman24)
00158 #if (GLUT_API_VERSION >= 3)
00159 #define GLUT_BITMAP_HELVETICA_10        (&glutBitmapHelvetica10)
00160 #define GLUT_BITMAP_HELVETICA_12        (&glutBitmapHelvetica12)
00161 #define GLUT_BITMAP_HELVETICA_18        (&glutBitmapHelvetica18)
00162 #endif
00163 
00164 /* glutGet parameters */
00165 #define GLUT_WINDOW_X                   100
00166 #define GLUT_WINDOW_Y                   101
00167 #define GLUT_WINDOW_WIDTH               102
00168 #define GLUT_WINDOW_HEIGHT              103
00169 #define GLUT_WINDOW_BUFFER_SIZE         104
00170 #define GLUT_WINDOW_STENCIL_SIZE        105
00171 #define GLUT_WINDOW_DEPTH_SIZE          106
00172 #define GLUT_WINDOW_RED_SIZE            107
00173 #define GLUT_WINDOW_GREEN_SIZE          108
00174 #define GLUT_WINDOW_BLUE_SIZE           109
00175 #define GLUT_WINDOW_ALPHA_SIZE          110
00176 #define GLUT_WINDOW_ACCUM_RED_SIZE      111
00177 #define GLUT_WINDOW_ACCUM_GREEN_SIZE    112
00178 #define GLUT_WINDOW_ACCUM_BLUE_SIZE     113
00179 #define GLUT_WINDOW_ACCUM_ALPHA_SIZE    114
00180 #define GLUT_WINDOW_DOUBLEBUFFER        115
00181 #define GLUT_WINDOW_RGBA                116
00182 #define GLUT_WINDOW_PARENT              117
00183 #define GLUT_WINDOW_NUM_CHILDREN        118
00184 #define GLUT_WINDOW_COLORMAP_SIZE       119
00185 #if (GLUT_API_VERSION >= 2)
00186 #define GLUT_WINDOW_NUM_SAMPLES         120
00187 #define GLUT_WINDOW_STEREO              121
00188 #endif
00189 #if (GLUT_API_VERSION >= 3)
00190 #define GLUT_WINDOW_CURSOR              122
00191 #endif
00192 #define GLUT_SCREEN_WIDTH               200
00193 #define GLUT_SCREEN_HEIGHT              201
00194 #define GLUT_SCREEN_WIDTH_MM            202
00195 #define GLUT_SCREEN_HEIGHT_MM           203
00196 #define GLUT_MENU_NUM_ITEMS             300
00197 #define GLUT_DISPLAY_MODE_POSSIBLE      400
00198 #define GLUT_INIT_WINDOW_X              500
00199 #define GLUT_INIT_WINDOW_Y              501
00200 #define GLUT_INIT_WINDOW_WIDTH          502
00201 #define GLUT_INIT_WINDOW_HEIGHT         503
00202 #define GLUT_INIT_DISPLAY_MODE          504
00203 #if (GLUT_API_VERSION >= 2)
00204 #define GLUT_ELAPSED_TIME               700
00205 #endif
00206 
00207 #if (GLUT_API_VERSION >= 2)
00208 /* glutDeviceGet parameters */
00209 #define GLUT_HAS_KEYBOARD               600
00210 #define GLUT_HAS_MOUSE                  601
00211 #define GLUT_HAS_SPACEBALL              602
00212 #define GLUT_HAS_DIAL_AND_BUTTON_BOX    603
00213 #define GLUT_HAS_TABLET                 604
00214 #define GLUT_NUM_MOUSE_BUTTONS          605
00215 #define GLUT_NUM_SPACEBALL_BUTTONS      606
00216 #define GLUT_NUM_BUTTON_BOX_BUTTONS     607
00217 #define GLUT_NUM_DIALS                  608
00218 #define GLUT_NUM_TABLET_BUTTONS         609
00219 #endif
00220 
00221 #if (GLUT_API_VERSION >= 3)
00222 /* glutLayerGet parameters */
00223 #define GLUT_OVERLAY_POSSIBLE           800
00224 #define GLUT_LAYER_IN_USE               801
00225 #define GLUT_HAS_OVERLAY                802
00226 #define GLUT_TRANSPARENT_INDEX          803
00227 #define GLUT_NORMAL_DAMAGED             804
00228 #define GLUT_OVERLAY_DAMAGED            805
00229 
00230 /* glutUseLayer parameters */
00231 #define GLUT_NORMAL                     0
00232 #define GLUT_OVERLAY                    1
00233 
00234 /* glutGetModifiers return mask */
00235 #define GLUT_ACTIVE_SHIFT               1
00236 #define GLUT_ACTIVE_CTRL                2
00237 #define GLUT_ACTIVE_ALT                 4
00238 
00239 /* glutSetCursor parameters */
00240 /* Basic arrows */
00241 #define GLUT_CURSOR_RIGHT_ARROW         0
00242 #define GLUT_CURSOR_LEFT_ARROW          1
00243 /* Symbolic cursor shapees */
00244 #define GLUT_CURSOR_INFO                2
00245 #define GLUT_CURSOR_DESTROY             3
00246 #define GLUT_CURSOR_HELP                4
00247 #define GLUT_CURSOR_CYCLE               5
00248 #define GLUT_CURSOR_SPRAY               6
00249 #define GLUT_CURSOR_WAIT                7
00250 #define GLUT_CURSOR_TEXT                8
00251 #define GLUT_CURSOR_CROSSHAIR           9
00252 /* Directional cursors */
00253 #define GLUT_CURSOR_UP_DOWN             10
00254 #define GLUT_CURSOR_LEFT_RIGHT          11
00255 /* Sizing cursors */
00256 #define GLUT_CURSOR_TOP_SIDE            12
00257 #define GLUT_CURSOR_BOTTOM_SIDE         13
00258 #define GLUT_CURSOR_LEFT_SIDE           14
00259 #define GLUT_CURSOR_RIGHT_SIDE          15
00260 #define GLUT_CURSOR_TOP_LEFT_CORNER     16
00261 #define GLUT_CURSOR_TOP_RIGHT_CORNER    17
00262 #define GLUT_CURSOR_BOTTOM_RIGHT_CORNER 18
00263 #define GLUT_CURSOR_BOTTOM_LEFT_CORNER  19
00264 /* Inherit from parent window */
00265 #define GLUT_CURSOR_INHERIT             100
00266 /* Blank cursor */
00267 #define GLUT_CURSOR_NONE                101
00268 /* Fullscreen crosshair (if available) */
00269 #define GLUT_CURSOR_FULL_CROSSHAIR      102
00270 #endif
00271 
00272 /* GLUT initialization sub-API */
00273 extern void glutInit(int *argcp, char **argv);
00274 extern void glutInitDisplayMode(unsigned int mode);
00275 extern void glutInitWindowPosition(int x, int y);
00276 extern void glutInitWindowSize(int width, int height);
00277 extern void glutMainLoop(void);
00278 
00279 /* GLUT window sub-api */
00280 extern int glutCreateWindow(char *title);
00281 extern int glutCreateSubWindow(int win, int x, int y, int width, int height);
00282 extern void glutDestroyWindow(int win);
00283 extern void glutPostRedisplay(void);
00284 extern void glutSwapBuffers(void);
00285 extern int glutGetWindow(void);
00286 extern void glutSetWindow(int win);
00287 extern void glutSetWindowTitle(char *title);
00288 extern void glutSetIconTitle(char *title);
00289 extern void glutPositionWindow(int x, int y);
00290 extern void glutReshapeWindow(int width, int height);
00291 extern void glutPopWindow(void);
00292 extern void glutPushWindow(void);
00293 extern void glutIconifyWindow(void);
00294 extern void glutShowWindow(void);
00295 extern void glutHideWindow(void);
00296 #if (GLUT_API_VERSION >= 3)
00297 extern void glutFullScreen(void);
00298 extern void glutSetCursor(int cursor);
00299 
00300 /* GLUT overlay sub-API */
00301 extern void glutEstablishOverlay(void);
00302 extern void glutRemoveOverlay(void);
00303 extern void glutUseLayer(GLenum layer);
00304 extern void glutPostOverlayRedisplay(void);
00305 extern void glutShowOverlay(void);
00306 extern void glutHideOverlay(void);
00307 #endif
00308 
00309 /* GLUT menu sub-API */
00310 extern int glutCreateMenu(void (*)(int));
00311 extern void glutDestroyMenu(int menu);
00312 extern int glutGetMenu(void);
00313 extern void glutSetMenu(int menu);
00314 extern void glutAddMenuEntry(char *label, int value);
00315 extern void glutAddSubMenu(char *label, int submenu);
00316 extern void glutChangeToMenuEntry(int item, char *label, int value);
00317 extern void glutChangeToSubMenu(int item, char *label, int submenu);
00318 extern void glutRemoveMenuItem(int item);
00319 extern void glutAttachMenu(int button);
00320 extern void glutDetachMenu(int button);
00321 
00322 /* GLUT callback sub-api */
00323 extern void glutDisplayFunc(void (*)(void));
00324 extern void glutReshapeFunc(void (*)(int width, int height));
00325 extern void glutKeyboardFunc(void (*)(unsigned char key, int x, int y));
00326 extern void glutMouseFunc(void (*)(int button, int state, int x, int y));
00327 extern void glutMotionFunc(void (*)(int x, int y));
00328 extern void glutPassiveMotionFunc(void (*)(int x, int y));
00329 extern void glutEntryFunc(void (*)(int state));
00330 extern void glutVisibilityFunc(void (*)(int state));
00331 extern void glutIdleFunc(void (*)(void));
00332 extern void glutTimerFunc(unsigned int millis, void (*)(int value), int value);
00333 extern void glutMenuStateFunc(void (*)(int state));
00334 #if (GLUT_API_VERSION >= 2)
00335 extern void glutSpecialFunc(void (*)(int key, int x, int y));
00336 extern void glutSpaceballMotionFunc(void (*)(int x, int y, int z));
00337 extern void glutSpaceballRotateFunc(void (*)(int x, int y, int z));
00338 extern void glutSpaceballButtonFunc(void (*)(int button, int state));
00339 extern void glutButtonBoxFunc(void (*)(int button, int state));
00340 extern void glutDialsFunc(void (*)(int dial, int value));
00341 extern void glutTabletMotionFunc(void (*)(int x, int y));
00342 extern void glutTabletButtonFunc(void (*)(int button, int state, int x, int y));
00343 #if (GLUT_API_VERSION >= 3)
00344 extern void glutMenuStatusFunc(void (*)(int status, int x, int y));
00345 extern void glutOverlayDisplayFunc(void (*)(void));
00346 #endif
00347 #endif
00348 
00349 /* GLUT color index sub-api */
00350 extern void glutSetColor(int, GLfloat red, GLfloat green, GLfloat blue);
00351 extern GLfloat glutGetColor(int ndx, int component);
00352 extern void glutCopyColormap(int win);
00353 
00354 /* GLUT state retrieval sub-api */
00355 extern int glutGet(GLenum type);
00356 extern int glutDeviceGet(GLenum type);
00357 #if (GLUT_API_VERSION >= 2)
00358 /* GLUT extension support sub-API */
00359 extern int glutExtensionSupported(char *name);
00360 #endif
00361 #if (GLUT_API_VERSION >= 3)
00362 extern int glutGetModifiers(void);
00363 extern int glutLayerGet(GLenum type);
00364 #endif
00365 
00366 /* GLUT font sub-API */
00367 extern void glutBitmapCharacter(void *font, int character);
00368 extern int glutBitmapWidth(void *font, int character);
00369 extern void glutStrokeCharacter(void *font, int character);
00370 extern int glutStrokeWidth(void *font, int character);
00371 
00372 /* GLUT pre-built models sub-API */
00373 extern void glutWireSphere(GLdouble radius, GLint slices, GLint stacks);
00374 extern void glutSolidSphere(GLdouble radius, GLint slices, GLint stacks);
00375 extern void glutWireCone(GLdouble base, GLdouble height, GLint slices, GLint stacks);
00376 extern void glutSolidCone(GLdouble base, GLdouble height, GLint slices, GLint stacks);
00377 extern void glutWireCube(GLdouble size);
00378 extern void glutSolidCube(GLdouble size);
00379 extern void glutWireTorus(GLdouble innerRadius, GLdouble outerRadius, GLint sides, GLint rings);
00380 extern void glutSolidTorus(GLdouble innerRadius, GLdouble outerRadius, GLint sides, GLint rings);
00381 extern void glutWireDodecahedron(void);
00382 extern void glutSolidDodecahedron(void);
00383 extern void glutWireTeapot(GLdouble size);
00384 extern void glutSolidTeapot(GLdouble size);
00385 extern void glutWireOctahedron(void);
00386 extern void glutSolidOctahedron(void);
00387 extern void glutWireTetrahedron(void);
00388 extern void glutSolidTetrahedron(void);
00389 extern void glutWireIcosahedron(void);
00390 extern void glutSolidIcosahedron(void);
00391 
00392 #ifdef __cplusplus
00393 }
00394 
00395 #endif
00396 #endif                  /* __glut_h__ */