4 /* Copyright (c) Mark J. Kilgard, 1994, 1995, 1996. */
6 /* This program is freely distributable without licensing fees and is
7 provided without guarantee or warrantee expressed or implied. This
8 program is -not- in the public domain. */
12 #pragma warning (disable:4244) /* disable bogus conversion warnings */
17 /* define APIENTRY and CALLBACK to null string if we aren't on Win32 */
28 GLUT API revision history:
30 GLUT_API_VERSION is updated to reflect incompatible GLUT
31 API changes (interface changes, semantic changes, deletions,
34 GLUT_API_VERSION=1 First public release of GLUT. 11/29/94
36 GLUT_API_VERSION=2 Added support for OpenGL/GLX multisampling,
37 extension. Supports new input devices like tablet, dial and button
38 box, and Spaceball. Easy to query OpenGL extensions.
40 GLUT_API_VERSION=3 glutMenuStatus added.
42 GLUT_API_VERSION=4 glutInitDisplayString, glutWarpPointer,
43 glutBitmapLength, glutStrokeLength, glutWindowStatusFunc, dynamic
44 video resize subAPI (NOT FINALIZED!).
46 #ifndef GLUT_API_VERSION /* allow this to be overriden */
47 #define GLUT_API_VERSION 3
51 GLUT implementation revision history:
53 GLUT_XLIB_IMPLEMENTATION is updated to reflect both GLUT
54 API revisions and implementation revisions (ie, bug fixes).
56 GLUT_XLIB_IMPLEMENTATION=1 mjk's first public release of
57 GLUT Xlib-based implementation. 11/29/94
59 GLUT_XLIB_IMPLEMENTATION=2 mjk's second public release of
60 GLUT Xlib-based implementation providing GLUT version 2
63 GLUT_XLIB_IMPLEMENTATION=3 mjk's GLUT 2.2 images. 4/17/95
65 GLUT_XLIB_IMPLEMENTATION=4 mjk's GLUT 2.3 images. 6/?/95
67 GLUT_XLIB_IMPLEMENTATION=5 mjk's GLUT 3.0 images. 10/?/95
69 GLUT_XLIB_IMPLEMENTATION=7 mjk's GLUT 3.1+ with glutWarpPoitner. 7/24/96
71 GLUT_XLIB_IMPLEMENTATION=8 mjk's GLUT 3.1+ with glutWarpPoitner
72 and video resize. 1/3/97
74 GLUT_XLIB_IMPLEMENTATION=9 mjk's GLUT 3.4 release with early GLUT 4 routines.
76 GLUT_XLIB_IMPLEMENTATION=11 mjk's GLUT 3.6 release with early GLUT 4 routines + signal handling.
78 #ifndef GLUT_XLIB_IMPLEMENTATION /* Allow this to be overriden. */
79 #define GLUT_XLIB_IMPLEMENTATION 11
82 /* Display mode bit masks. */
84 #define GLUT_RGBA GLUT_RGB
91 #define GLUT_STENCIL 32
92 #if (GLUT_API_VERSION >= 2)
93 #define GLUT_MULTISAMPLE 128
94 #define GLUT_STEREO 256
96 #if (GLUT_API_VERSION >= 3)
97 #define GLUT_LUMINANCE 512
101 #define GLUT_LEFT_BUTTON 0
102 #define GLUT_MIDDLE_BUTTON 1
103 #define GLUT_RIGHT_BUTTON 2
105 /* Mouse button state. */
109 #if (GLUT_API_VERSION >= 2)
111 #define GLUT_KEY_F1 1
112 #define GLUT_KEY_F2 2
113 #define GLUT_KEY_F3 3
114 #define GLUT_KEY_F4 4
115 #define GLUT_KEY_F5 5
116 #define GLUT_KEY_F6 6
117 #define GLUT_KEY_F7 7
118 #define GLUT_KEY_F8 8
119 #define GLUT_KEY_F9 9
120 #define GLUT_KEY_F10 10
121 #define GLUT_KEY_F11 11
122 #define GLUT_KEY_F12 12
123 /* directional keys */
124 #define GLUT_KEY_LEFT 100
125 #define GLUT_KEY_UP 101
126 #define GLUT_KEY_RIGHT 102
127 #define GLUT_KEY_DOWN 103
128 #define GLUT_KEY_PAGE_UP 104
129 #define GLUT_KEY_PAGE_DOWN 105
130 #define GLUT_KEY_HOME 106
131 #define GLUT_KEY_END 107
132 #define GLUT_KEY_INSERT 108
135 /* Entry/exit state. */
137 #define GLUT_ENTERED 1
139 /* Menu usage state. */
140 #define GLUT_MENU_NOT_IN_USE 0
141 #define GLUT_MENU_IN_USE 1
143 /* Visibility state. */
144 #define GLUT_NOT_VISIBLE 0
145 #define GLUT_VISIBLE 1
147 /* Window status state. */
148 #define GLUT_HIDDEN 0
149 #define GLUT_FULLY_RETAINED 1
150 #define GLUT_PARTIALLY_RETAINED 2
151 #define GLUT_FULLY_COVERED 3
153 /* Color index component selection values. */
158 /* Layers for use. */
159 #define GLUT_NORMAL 0
160 #define GLUT_OVERLAY 1
163 /* Stroke font constants (use these in GLUT program). */
164 #define GLUT_STROKE_ROMAN ((void*)0)
165 #define GLUT_STROKE_MONO_ROMAN ((void*)1)
167 /* Bitmap font constants (use these in GLUT program). */
168 #define GLUT_BITMAP_9_BY_15 ((void*)2)
169 #define GLUT_BITMAP_8_BY_13 ((void*)3)
170 #define GLUT_BITMAP_TIMES_ROMAN_10 ((void*)4)
171 #define GLUT_BITMAP_TIMES_ROMAN_24 ((void*)5)
172 #if (GLUT_API_VERSION >= 3)
173 #define GLUT_BITMAP_HELVETICA_10 ((void*)6)
174 #define GLUT_BITMAP_HELVETICA_12 ((void*)7)
175 #define GLUT_BITMAP_HELVETICA_18 ((void*)8)
178 /* Stroke font opaque addresses (use constants instead in source code). */
179 extern void *glutStrokeRoman;
180 extern void *glutStrokeMonoRoman;
182 /* Stroke font constants (use these in GLUT program). */
183 #define GLUT_STROKE_ROMAN (&glutStrokeRoman)
184 #define GLUT_STROKE_MONO_ROMAN (&glutStrokeMonoRoman)
186 /* Bitmap font opaque addresses (use constants instead in source code). */
187 extern void *glutBitmap9By15;
188 extern void *glutBitmap8By13;
189 extern void *glutBitmapTimesRoman10;
190 extern void *glutBitmapTimesRoman24;
191 extern void *glutBitmapHelvetica10;
192 extern void *glutBitmapHelvetica12;
193 extern void *glutBitmapHelvetica18;
195 /* Bitmap font constants (use these in GLUT program). */
196 #define GLUT_BITMAP_9_BY_15 (&glutBitmap9By15)
197 #define GLUT_BITMAP_8_BY_13 (&glutBitmap8By13)
198 #define GLUT_BITMAP_TIMES_ROMAN_10 (&glutBitmapTimesRoman10)
199 #define GLUT_BITMAP_TIMES_ROMAN_24 (&glutBitmapTimesRoman24)
200 #if (GLUT_API_VERSION >= 3)
201 #define GLUT_BITMAP_HELVETICA_10 (&glutBitmapHelvetica10)
202 #define GLUT_BITMAP_HELVETICA_12 (&glutBitmapHelvetica12)
203 #define GLUT_BITMAP_HELVETICA_18 (&glutBitmapHelvetica18)
207 /* glutGet parameters. */
208 #define GLUT_WINDOW_X 100
209 #define GLUT_WINDOW_Y 101
210 #define GLUT_WINDOW_WIDTH 102
211 #define GLUT_WINDOW_HEIGHT 103
212 #define GLUT_WINDOW_BUFFER_SIZE 104
213 #define GLUT_WINDOW_STENCIL_SIZE 105
214 #define GLUT_WINDOW_DEPTH_SIZE 106
215 #define GLUT_WINDOW_RED_SIZE 107
216 #define GLUT_WINDOW_GREEN_SIZE 108
217 #define GLUT_WINDOW_BLUE_SIZE 109
218 #define GLUT_WINDOW_ALPHA_SIZE 110
219 #define GLUT_WINDOW_ACCUM_RED_SIZE 111
220 #define GLUT_WINDOW_ACCUM_GREEN_SIZE 112
221 #define GLUT_WINDOW_ACCUM_BLUE_SIZE 113
222 #define GLUT_WINDOW_ACCUM_ALPHA_SIZE 114
223 #define GLUT_WINDOW_DOUBLEBUFFER 115
224 #define GLUT_WINDOW_RGBA 116
225 #define GLUT_WINDOW_PARENT 117
226 #define GLUT_WINDOW_NUM_CHILDREN 118
227 #define GLUT_WINDOW_COLORMAP_SIZE 119
228 #if (GLUT_API_VERSION >= 2)
229 #define GLUT_WINDOW_NUM_SAMPLES 120
230 #define GLUT_WINDOW_STEREO 121
232 #if (GLUT_API_VERSION >= 3)
233 #define GLUT_WINDOW_CURSOR 122
235 #define GLUT_SCREEN_WIDTH 200
236 #define GLUT_SCREEN_HEIGHT 201
237 #define GLUT_SCREEN_WIDTH_MM 202
238 #define GLUT_SCREEN_HEIGHT_MM 203
239 #define GLUT_MENU_NUM_ITEMS 300
240 #define GLUT_DISPLAY_MODE_POSSIBLE 400
241 #define GLUT_INIT_WINDOW_X 500
242 #define GLUT_INIT_WINDOW_Y 501
243 #define GLUT_INIT_WINDOW_WIDTH 502
244 #define GLUT_INIT_WINDOW_HEIGHT 503
245 #define GLUT_INIT_DISPLAY_MODE 504
246 #if (GLUT_API_VERSION >= 2)
247 #define GLUT_ELAPSED_TIME 700
250 #if (GLUT_API_VERSION >= 2)
251 /* glutDeviceGet parameters. */
252 #define GLUT_HAS_KEYBOARD 600
253 #define GLUT_HAS_MOUSE 601
254 #define GLUT_HAS_SPACEBALL 602
255 #define GLUT_HAS_DIAL_AND_BUTTON_BOX 603
256 #define GLUT_HAS_TABLET 604
257 #define GLUT_NUM_MOUSE_BUTTONS 605
258 #define GLUT_NUM_SPACEBALL_BUTTONS 606
259 #define GLUT_NUM_BUTTON_BOX_BUTTONS 607
260 #define GLUT_NUM_DIALS 608
261 #define GLUT_NUM_TABLET_BUTTONS 609
264 #if (GLUT_API_VERSION >= 3)
265 /* glutLayerGet parameters. */
266 #define GLUT_OVERLAY_POSSIBLE 800
267 #define GLUT_LAYER_IN_USE 801
268 #define GLUT_HAS_OVERLAY 802
269 #define GLUT_TRANSPARENT_INDEX 803
270 #define GLUT_NORMAL_DAMAGED 804
271 #define GLUT_OVERLAY_DAMAGED 805
273 #if (GLUT_API_VERSION >= 4 || GLUT_XLIB_IMPLEMENTATION >= 9)
274 /* glutVideoResizeGet parameters. */
275 #define GLUT_VIDEO_RESIZE_POSSIBLE 900
276 #define GLUT_VIDEO_RESIZE_IN_USE 901
277 #define GLUT_VIDEO_RESIZE_X_DELTA 902
278 #define GLUT_VIDEO_RESIZE_Y_DELTA 903
279 #define GLUT_VIDEO_RESIZE_WIDTH_DELTA 904
280 #define GLUT_VIDEO_RESIZE_HEIGHT_DELTA 905
281 #define GLUT_VIDEO_RESIZE_X 906
282 #define GLUT_VIDEO_RESIZE_Y 907
283 #define GLUT_VIDEO_RESIZE_WIDTH 908
284 #define GLUT_VIDEO_RESIZE_HEIGHT 909
287 /* glutUseLayer parameters. */
288 #define GLUT_NORMAL 0
289 #define GLUT_OVERLAY 1
291 /* glutGetModifiers return mask. */
292 #define GLUT_ACTIVE_SHIFT 1
293 #define GLUT_ACTIVE_CTRL 2
294 #define GLUT_ACTIVE_ALT 4
296 /* glutSetCursor parameters. */
298 #define GLUT_CURSOR_RIGHT_ARROW 0
299 #define GLUT_CURSOR_LEFT_ARROW 1
300 /* Symbolic cursor shapes. */
301 #define GLUT_CURSOR_INFO 2
302 #define GLUT_CURSOR_DESTROY 3
303 #define GLUT_CURSOR_HELP 4
304 #define GLUT_CURSOR_CYCLE 5
305 #define GLUT_CURSOR_SPRAY 6
306 #define GLUT_CURSOR_WAIT 7
307 #define GLUT_CURSOR_TEXT 8
308 #define GLUT_CURSOR_CROSSHAIR 9
309 /* Directional cursors. */
310 #define GLUT_CURSOR_UP_DOWN 10
311 #define GLUT_CURSOR_LEFT_RIGHT 11
312 /* Sizing cursors. */
313 #define GLUT_CURSOR_TOP_SIDE 12
314 #define GLUT_CURSOR_BOTTOM_SIDE 13
315 #define GLUT_CURSOR_LEFT_SIDE 14
316 #define GLUT_CURSOR_RIGHT_SIDE 15
317 #define GLUT_CURSOR_TOP_LEFT_CORNER 16
318 #define GLUT_CURSOR_TOP_RIGHT_CORNER 17
319 #define GLUT_CURSOR_BOTTOM_RIGHT_CORNER 18
320 #define GLUT_CURSOR_BOTTOM_LEFT_CORNER 19
321 /* Inherit from parent window. */
322 #define GLUT_CURSOR_INHERIT 100
324 #define GLUT_CURSOR_NONE 101
325 /* Fullscreen crosshair (if available). */
326 #define GLUT_CURSOR_FULL_CROSSHAIR 102
329 /* GLUT initialization sub-API. */
330 extern void APIENTRY glutInit(int *argcp, char **argv);
331 extern void APIENTRY glutInitDisplayMode(unsigned int mode);
332 #if (GLUT_API_VERSION >= 4 || GLUT_XLIB_IMPLEMENTATION >= 9)
333 extern void APIENTRY glutInitDisplayString(const char *string);
335 extern void APIENTRY glutInitWindowPosition(int x, int y);
336 extern void APIENTRY glutInitWindowSize(int width, int height);
337 extern void APIENTRY glutMainLoop(void);
339 /* GLUT window sub-API. */
340 extern int APIENTRY glutCreateWindow(const char *title);
341 extern int APIENTRY glutCreateSubWindow(int win, int x, int y, int width, int height);
342 extern void APIENTRY glutDestroyWindow(int win);
343 extern void APIENTRY glutPostRedisplay(void);
344 extern void APIENTRY glutSwapBuffers(void);
345 extern int APIENTRY glutGetWindow(void);
346 extern void APIENTRY glutSetWindow(int win);
347 extern void APIENTRY glutSetWindowTitle(const char *title);
348 extern void APIENTRY glutSetIconTitle(const char *title);
349 extern void APIENTRY glutPositionWindow(int x, int y);
350 extern void APIENTRY glutReshapeWindow(int width, int height);
351 extern void APIENTRY glutPopWindow(void);
352 extern void APIENTRY glutPushWindow(void);
353 extern void APIENTRY glutIconifyWindow(void);
354 extern void APIENTRY glutShowWindow(void);
355 extern void APIENTRY glutHideWindow(void);
356 #if (GLUT_API_VERSION >= 3)
357 extern void APIENTRY glutFullScreen(void);
358 extern void APIENTRY glutSetCursor(int cursor);
359 #if (GLUT_API_VERSION >= 4 || GLUT_XLIB_IMPLEMENTATION >= 9)
360 extern void APIENTRY glutWarpPointer(int x, int y);
363 /* GLUT overlay sub-API. */
364 extern void APIENTRY glutEstablishOverlay(void);
365 extern void APIENTRY glutRemoveOverlay(void);
366 extern void APIENTRY glutUseLayer(GLenum layer);
367 extern void APIENTRY glutPostOverlayRedisplay(void);
368 extern void APIENTRY glutShowOverlay(void);
369 extern void APIENTRY glutHideOverlay(void);
372 /* GLUT menu sub-API. */
373 extern int APIENTRY glutCreateMenu(void (*)(int));
374 extern void APIENTRY glutDestroyMenu(int menu);
375 extern int APIENTRY glutGetMenu(void);
376 extern void APIENTRY glutSetMenu(int menu);
377 extern void APIENTRY glutAddMenuEntry(const char *label, int value);
378 extern void APIENTRY glutAddSubMenu(const char *label, int submenu);
379 extern void APIENTRY glutChangeToMenuEntry(int item, const char *label, int value);
380 extern void APIENTRY glutChangeToSubMenu(int item, const char *label, int submenu);
381 extern void APIENTRY glutRemoveMenuItem(int item);
382 extern void APIENTRY glutAttachMenu(int button);
383 extern void APIENTRY glutDetachMenu(int button);
386 extern void APIENTRY glutDisplayFunc(void (*)(void));
387 extern void APIENTRY glutReshapeFunc(void (*)(int width, int height));
388 extern void APIENTRY glutKeyboardFunc(void (*)(unsigned char key, int x, int y));
389 extern void APIENTRY glutMouseFunc(void (*)(int button, int state, int x, int y));
390 extern void APIENTRY glutMotionFunc(void (*)(int x, int y));
391 extern void APIENTRY glutPassiveMotionFunc(void (*)(int x, int y));
392 extern void APIENTRY glutEntryFunc(void (*)(int state));
393 extern void APIENTRY glutVisibilityFunc(void (*)(int state));
394 extern void APIENTRY glutIdleFunc(void (*)(void));
395 extern void APIENTRY glutTimerFunc(unsigned int millis, void (*)(int value), int value);
396 extern void APIENTRY glutMenuStateFunc(void (*)(int state));
397 #if (GLUT_API_VERSION >= 2)
398 extern void APIENTRY glutSpecialFunc(void (*)(int key, int x, int y));
399 extern void APIENTRY glutSpaceballMotionFunc(void (*)(int x, int y, int z));
400 extern void APIENTRY glutSpaceballRotateFunc(void (*)(int x, int y, int z));
401 extern void APIENTRY glutSpaceballButtonFunc(void (*)(int button, int state));
402 extern void APIENTRY glutButtonBoxFunc(void (*)(int button, int state));
403 extern void APIENTRY glutDialsFunc(void (*)(int dial, int value));
404 extern void APIENTRY glutTabletMotionFunc(void (*)(int x, int y));
405 extern void APIENTRY glutTabletButtonFunc(void (*)(int button, int state, int x, int y));
406 #if (GLUT_API_VERSION >= 3)
407 extern void APIENTRY glutMenuStatusFunc(void (*)(int status, int x, int y));
408 extern void APIENTRY glutOverlayDisplayFunc(void (*)(void));
409 #if (GLUT_API_VERSION >= 4 || GLUT_XLIB_IMPLEMENTATION >= 9)
410 extern void APIENTRY glutWindowStatusFunc(void (*)(int state));
415 /* GLUT color index sub-API. */
416 extern void APIENTRY glutSetColor(int, GLfloat red, GLfloat green, GLfloat blue);
417 extern GLfloat APIENTRY glutGetColor(int ndx, int component);
418 extern void APIENTRY glutCopyColormap(int win);
420 /* GLUT state retrieval sub-API. */
421 extern int APIENTRY glutGet(GLenum type);
422 extern int APIENTRY glutDeviceGet(GLenum type);
423 #if (GLUT_API_VERSION >= 2)
424 /* GLUT extension support sub-API */
425 extern int APIENTRY glutExtensionSupported(const char *name);
427 #if (GLUT_API_VERSION >= 3)
428 extern int APIENTRY glutGetModifiers(void);
429 extern int APIENTRY glutLayerGet(GLenum type);
432 /* GLUT font sub-API */
433 extern void APIENTRY glutBitmapCharacter(void *font, int character);
434 extern int APIENTRY glutBitmapWidth(void *font, int character);
435 extern void APIENTRY glutStrokeCharacter(void *font, int character);
436 extern int APIENTRY glutStrokeWidth(void *font, int character);
437 #if (GLUT_API_VERSION >= 4 || GLUT_XLIB_IMPLEMENTATION >= 9)
438 extern int APIENTRY glutBitmapLength(void *font, const unsigned char *string);
439 extern int APIENTRY glutStrokeLength(void *font, const unsigned char *string);
442 /* GLUT pre-built models sub-API */
443 extern void APIENTRY glutWireSphere(GLdouble radius, GLint slices, GLint stacks);
444 extern void APIENTRY glutSolidSphere(GLdouble radius, GLint slices, GLint stacks);
445 extern void APIENTRY glutWireCone(GLdouble base, GLdouble height, GLint slices, GLint stacks);
446 extern void APIENTRY glutSolidCone(GLdouble base, GLdouble height, GLint slices, GLint stacks);
447 extern void APIENTRY glutWireCube(GLdouble size);
448 extern void APIENTRY glutSolidCube(GLdouble size);
449 extern void APIENTRY glutWireTorus(GLdouble innerRadius, GLdouble outerRadius, GLint sides, GLint rings);
450 extern void APIENTRY glutSolidTorus(GLdouble innerRadius, GLdouble outerRadius, GLint sides, GLint rings);
451 extern void APIENTRY glutWireDodecahedron(void);
452 extern void APIENTRY glutSolidDodecahedron(void);
453 extern void APIENTRY glutWireTeapot(GLdouble size);
454 extern void APIENTRY glutSolidTeapot(GLdouble size);
455 extern void APIENTRY glutWireOctahedron(void);
456 extern void APIENTRY glutSolidOctahedron(void);
457 extern void APIENTRY glutWireTetrahedron(void);
458 extern void APIENTRY glutSolidTetrahedron(void);
459 extern void APIENTRY glutWireIcosahedron(void);
460 extern void APIENTRY glutSolidIcosahedron(void);
462 #if (GLUT_API_VERSION >= 4 || GLUT_XLIB_IMPLEMENTATION >= 9)
463 /* GLUT video resize sub-API. */
464 extern int APIENTRY glutVideoResizeGet(GLenum param);
465 extern void APIENTRY glutSetupVideoResizing(void);
466 extern void APIENTRY glutStopVideoResizing(void);
467 extern void APIENTRY glutVideoResize(int x, int y, int width, int height);
468 extern void APIENTRY glutVideoPan(int x, int y, int width, int height);
470 /* GLUT debugging sub-API. */
471 extern void APIENTRY glutReportErrors(void);
478 #endif /* __glut_h__ */