on windows+MSVC, debug builds of the library now have a 'd' suffix.
[freeglut] / include / GL / freeglut_std.h
1 #ifndef  __FREEGLUT_STD_H__
2 #define  __FREEGLUT_STD_H__
3
4 /*
5  * freeglut_std.h
6  *
7  * The GLUT-compatible part of the freeglut library include file
8  *
9  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
10  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
11  * Creation date: Thu Dec 2 1999
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining a
14  * copy of this software and associated documentation files (the "Software"),
15  * to deal in the Software without restriction, including without limitation
16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  * and/or sell copies of the Software, and to permit persons to whom the
18  * Software is furnished to do so, subject to the following conditions:
19  *
20  * The above copyright notice and this permission notice shall be included
21  * in all copies or substantial portions of the Software.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
26  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
27  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
28  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29  */
30
31 #ifdef __cplusplus
32     extern "C" {
33 #endif
34
35 /*
36  * Under windows, we have to differentiate between static and dynamic libraries
37  */
38 #ifdef _WIN32
39 /* #pragma may not be supported by some compilers.
40  * Discussion by FreeGLUT developers suggests that
41  * Visual C++ specific code involving pragmas may
42  * need to move to a separate header.  24th Dec 2003
43  */
44
45 /* Define FREEGLUT_LIB_PRAGMAS to 1 to include library
46  * pragmas or to 0 to exclude library pragmas.
47  * The default behavior depends on the compiler/platform.
48  */
49 #   ifndef FREEGLUT_LIB_PRAGMAS
50 #       if ( defined(_MSC_VER) || defined(__WATCOMC__) ) && !defined(_WIN32_WCE)
51 #           define FREEGLUT_LIB_PRAGMAS 1
52 #       else
53 #           define FREEGLUT_LIB_PRAGMAS 0
54 #       endif
55 #   endif
56
57 #  ifndef WIN32_LEAN_AND_MEAN
58 #    define WIN32_LEAN_AND_MEAN 1
59 #  endif
60 #  ifndef NOMINMAX
61 #    define NOMINMAX
62 #  endif
63 #   include <windows.h>
64
65 /* Windows static library */
66 #   ifdef FREEGLUT_STATIC
67
68 #       define FGAPI
69 #       define FGAPIENTRY
70
71         /* Link with Win32 static freeglut lib */
72 #       if FREEGLUT_LIB_PRAGMAS
73 #           ifdef NDEBUG
74 #              pragma comment (lib, "freeglut_static.lib")
75 #           else
76 #              pragma comment (lib, "freeglut_staticd.lib")
77 #           endif
78 #       endif
79
80 /* Windows shared library (DLL) */
81 #   else
82
83 #       define FGAPIENTRY __stdcall
84 #       if defined(FREEGLUT_EXPORTS)
85 #           define FGAPI __declspec(dllexport)
86 #       else
87 #           define FGAPI __declspec(dllimport)
88
89             /* Link with Win32 shared freeglut lib */
90 #           if FREEGLUT_LIB_PRAGMAS
91 #               ifdef NDEBUG
92 #                   pragma comment (lib, "freeglut.lib")
93 #               else
94 #                   pragma comment (lib, "freeglutd.lib")
95 #               endif
96 #           endif
97
98 #       endif
99
100 #   endif
101
102 /* Drag in other Windows libraries as required by FreeGLUT */
103 #   if FREEGLUT_LIB_PRAGMAS
104 #       pragma comment (lib, "glu32.lib")    /* link OpenGL Utility lib     */
105 #       pragma comment (lib, "opengl32.lib") /* link Microsoft OpenGL lib   */
106 #       pragma comment (lib, "gdi32.lib")    /* link Windows GDI lib        */
107 #       pragma comment (lib, "winmm.lib")    /* link Windows MultiMedia lib */
108 #       pragma comment (lib, "user32.lib")   /* link Windows user lib       */
109 #   endif
110
111 #else
112
113 /* Non-Windows definition of FGAPI and FGAPIENTRY  */
114 #        define FGAPI
115 #        define FGAPIENTRY
116
117 #endif
118
119 /*
120  * The freeglut and GLUT API versions
121  */
122 #define  FREEGLUT             1
123 #define  GLUT_API_VERSION     4
124 #define  FREEGLUT_VERSION_2_0 1
125 #define  GLUT_XLIB_IMPLEMENTATION 13
126
127 /*
128  * Always include OpenGL and GLU headers
129  */
130 /* Note: FREEGLUT_GLES1 and FREEGLUT_GLES2 are only used to cleanly
131    bootstrap headers inclusion here; use GLES constants directly
132    (e.g. GL_ES_VERSION_2_0) for all other needs */
133 #ifdef FREEGLUT_GLES2
134 #   include <EGL/egl.h>
135 #   include <GLES2/gl2.h>
136 #elif FREEGLUT_GLES1
137 #   include <EGL/egl.h>
138 #   include <GLES/gl.h>
139 #else
140 #   include <GL/gl.h>
141 #   include <GL/glu.h>
142 #endif
143
144 /*
145  * GLUT API macro definitions -- the special key codes:
146  */
147 #define  GLUT_KEY_F1                        0x0001
148 #define  GLUT_KEY_F2                        0x0002
149 #define  GLUT_KEY_F3                        0x0003
150 #define  GLUT_KEY_F4                        0x0004
151 #define  GLUT_KEY_F5                        0x0005
152 #define  GLUT_KEY_F6                        0x0006
153 #define  GLUT_KEY_F7                        0x0007
154 #define  GLUT_KEY_F8                        0x0008
155 #define  GLUT_KEY_F9                        0x0009
156 #define  GLUT_KEY_F10                       0x000A
157 #define  GLUT_KEY_F11                       0x000B
158 #define  GLUT_KEY_F12                       0x000C
159 #define  GLUT_KEY_LEFT                      0x0064
160 #define  GLUT_KEY_UP                        0x0065
161 #define  GLUT_KEY_RIGHT                     0x0066
162 #define  GLUT_KEY_DOWN                      0x0067
163 #define  GLUT_KEY_PAGE_UP                   0x0068
164 #define  GLUT_KEY_PAGE_DOWN                 0x0069
165 #define  GLUT_KEY_HOME                      0x006A
166 #define  GLUT_KEY_END                       0x006B
167 #define  GLUT_KEY_INSERT                    0x006C
168
169 /*
170  * GLUT API macro definitions -- mouse state definitions
171  */
172 #define  GLUT_LEFT_BUTTON                   0x0000
173 #define  GLUT_MIDDLE_BUTTON                 0x0001
174 #define  GLUT_RIGHT_BUTTON                  0x0002
175 #define  GLUT_DOWN                          0x0000
176 #define  GLUT_UP                            0x0001
177 #define  GLUT_LEFT                          0x0000
178 #define  GLUT_ENTERED                       0x0001
179
180 /*
181  * GLUT API macro definitions -- the display mode definitions
182  */
183 #define  GLUT_RGB                           0x0000
184 #define  GLUT_RGBA                          0x0000
185 #define  GLUT_INDEX                         0x0001
186 #define  GLUT_SINGLE                        0x0000
187 #define  GLUT_DOUBLE                        0x0002
188 #define  GLUT_ACCUM                         0x0004
189 #define  GLUT_ALPHA                         0x0008
190 #define  GLUT_DEPTH                         0x0010
191 #define  GLUT_STENCIL                       0x0020
192 #define  GLUT_MULTISAMPLE                   0x0080
193 #define  GLUT_STEREO                        0x0100
194 #define  GLUT_LUMINANCE                     0x0200
195
196 /*
197  * GLUT API macro definitions -- windows and menu related definitions
198  */
199 #define  GLUT_MENU_NOT_IN_USE               0x0000
200 #define  GLUT_MENU_IN_USE                   0x0001
201 #define  GLUT_NOT_VISIBLE                   0x0000
202 #define  GLUT_VISIBLE                       0x0001
203 #define  GLUT_HIDDEN                        0x0000
204 #define  GLUT_FULLY_RETAINED                0x0001
205 #define  GLUT_PARTIALLY_RETAINED            0x0002
206 #define  GLUT_FULLY_COVERED                 0x0003
207
208 /*
209  * GLUT API macro definitions -- fonts definitions
210  *
211  * Steve Baker suggested to make it binary compatible with GLUT:
212  */
213 #if defined(_MSC_VER) || defined(__CYGWIN__) || defined(__MINGW32__) || defined(__WATCOMC__)
214 #   define  GLUT_STROKE_ROMAN               ((void *)0x0000)
215 #   define  GLUT_STROKE_MONO_ROMAN          ((void *)0x0001)
216 #   define  GLUT_BITMAP_9_BY_15             ((void *)0x0002)
217 #   define  GLUT_BITMAP_8_BY_13             ((void *)0x0003)
218 #   define  GLUT_BITMAP_TIMES_ROMAN_10      ((void *)0x0004)
219 #   define  GLUT_BITMAP_TIMES_ROMAN_24      ((void *)0x0005)
220 #   define  GLUT_BITMAP_HELVETICA_10        ((void *)0x0006)
221 #   define  GLUT_BITMAP_HELVETICA_12        ((void *)0x0007)
222 #   define  GLUT_BITMAP_HELVETICA_18        ((void *)0x0008)
223 #else
224     /*
225      * I don't really know if it's a good idea... But here it goes:
226      */
227     extern void* glutStrokeRoman;
228     extern void* glutStrokeMonoRoman;
229     extern void* glutBitmap9By15;
230     extern void* glutBitmap8By13;
231     extern void* glutBitmapTimesRoman10;
232     extern void* glutBitmapTimesRoman24;
233     extern void* glutBitmapHelvetica10;
234     extern void* glutBitmapHelvetica12;
235     extern void* glutBitmapHelvetica18;
236
237     /*
238      * Those pointers will be used by following definitions:
239      */
240 #   define  GLUT_STROKE_ROMAN               ((void *) &glutStrokeRoman)
241 #   define  GLUT_STROKE_MONO_ROMAN          ((void *) &glutStrokeMonoRoman)
242 #   define  GLUT_BITMAP_9_BY_15             ((void *) &glutBitmap9By15)
243 #   define  GLUT_BITMAP_8_BY_13             ((void *) &glutBitmap8By13)
244 #   define  GLUT_BITMAP_TIMES_ROMAN_10      ((void *) &glutBitmapTimesRoman10)
245 #   define  GLUT_BITMAP_TIMES_ROMAN_24      ((void *) &glutBitmapTimesRoman24)
246 #   define  GLUT_BITMAP_HELVETICA_10        ((void *) &glutBitmapHelvetica10)
247 #   define  GLUT_BITMAP_HELVETICA_12        ((void *) &glutBitmapHelvetica12)
248 #   define  GLUT_BITMAP_HELVETICA_18        ((void *) &glutBitmapHelvetica18)
249 #endif
250
251 /*
252  * GLUT API macro definitions -- the glutGet parameters
253  */
254 #define  GLUT_WINDOW_X                      0x0064
255 #define  GLUT_WINDOW_Y                      0x0065
256 #define  GLUT_WINDOW_WIDTH                  0x0066
257 #define  GLUT_WINDOW_HEIGHT                 0x0067
258 #define  GLUT_WINDOW_BUFFER_SIZE            0x0068
259 #define  GLUT_WINDOW_STENCIL_SIZE           0x0069
260 #define  GLUT_WINDOW_DEPTH_SIZE             0x006A
261 #define  GLUT_WINDOW_RED_SIZE               0x006B
262 #define  GLUT_WINDOW_GREEN_SIZE             0x006C
263 #define  GLUT_WINDOW_BLUE_SIZE              0x006D
264 #define  GLUT_WINDOW_ALPHA_SIZE             0x006E
265 #define  GLUT_WINDOW_ACCUM_RED_SIZE         0x006F
266 #define  GLUT_WINDOW_ACCUM_GREEN_SIZE       0x0070
267 #define  GLUT_WINDOW_ACCUM_BLUE_SIZE        0x0071
268 #define  GLUT_WINDOW_ACCUM_ALPHA_SIZE       0x0072
269 #define  GLUT_WINDOW_DOUBLEBUFFER           0x0073
270 #define  GLUT_WINDOW_RGBA                   0x0074
271 #define  GLUT_WINDOW_PARENT                 0x0075
272 #define  GLUT_WINDOW_NUM_CHILDREN           0x0076
273 #define  GLUT_WINDOW_COLORMAP_SIZE          0x0077
274 #define  GLUT_WINDOW_NUM_SAMPLES            0x0078
275 #define  GLUT_WINDOW_STEREO                 0x0079
276 #define  GLUT_WINDOW_CURSOR                 0x007A
277
278 #define  GLUT_SCREEN_WIDTH                  0x00C8
279 #define  GLUT_SCREEN_HEIGHT                 0x00C9
280 #define  GLUT_SCREEN_WIDTH_MM               0x00CA
281 #define  GLUT_SCREEN_HEIGHT_MM              0x00CB
282 #define  GLUT_MENU_NUM_ITEMS                0x012C
283 #define  GLUT_DISPLAY_MODE_POSSIBLE         0x0190
284 #define  GLUT_INIT_WINDOW_X                 0x01F4
285 #define  GLUT_INIT_WINDOW_Y                 0x01F5
286 #define  GLUT_INIT_WINDOW_WIDTH             0x01F6
287 #define  GLUT_INIT_WINDOW_HEIGHT            0x01F7
288 #define  GLUT_INIT_DISPLAY_MODE             0x01F8
289 #define  GLUT_ELAPSED_TIME                  0x02BC
290 #define  GLUT_WINDOW_FORMAT_ID              0x007B
291
292 /*
293  * GLUT API macro definitions -- the glutDeviceGet parameters
294  */
295 #define  GLUT_HAS_KEYBOARD                  0x0258
296 #define  GLUT_HAS_MOUSE                     0x0259
297 #define  GLUT_HAS_SPACEBALL                 0x025A
298 #define  GLUT_HAS_DIAL_AND_BUTTON_BOX       0x025B
299 #define  GLUT_HAS_TABLET                    0x025C
300 #define  GLUT_NUM_MOUSE_BUTTONS             0x025D
301 #define  GLUT_NUM_SPACEBALL_BUTTONS         0x025E
302 #define  GLUT_NUM_BUTTON_BOX_BUTTONS        0x025F
303 #define  GLUT_NUM_DIALS                     0x0260
304 #define  GLUT_NUM_TABLET_BUTTONS            0x0261
305 #define  GLUT_DEVICE_IGNORE_KEY_REPEAT      0x0262
306 #define  GLUT_DEVICE_KEY_REPEAT             0x0263
307 #define  GLUT_HAS_JOYSTICK                  0x0264
308 #define  GLUT_OWNS_JOYSTICK                 0x0265
309 #define  GLUT_JOYSTICK_BUTTONS              0x0266
310 #define  GLUT_JOYSTICK_AXES                 0x0267
311 #define  GLUT_JOYSTICK_POLL_RATE            0x0268
312
313 /*
314  * GLUT API macro definitions -- the glutLayerGet parameters
315  */
316 #define  GLUT_OVERLAY_POSSIBLE              0x0320
317 #define  GLUT_LAYER_IN_USE                  0x0321
318 #define  GLUT_HAS_OVERLAY                   0x0322
319 #define  GLUT_TRANSPARENT_INDEX             0x0323
320 #define  GLUT_NORMAL_DAMAGED                0x0324
321 #define  GLUT_OVERLAY_DAMAGED               0x0325
322
323 /*
324  * GLUT API macro definitions -- the glutVideoResizeGet parameters
325  */
326 #define  GLUT_VIDEO_RESIZE_POSSIBLE         0x0384
327 #define  GLUT_VIDEO_RESIZE_IN_USE           0x0385
328 #define  GLUT_VIDEO_RESIZE_X_DELTA          0x0386
329 #define  GLUT_VIDEO_RESIZE_Y_DELTA          0x0387
330 #define  GLUT_VIDEO_RESIZE_WIDTH_DELTA      0x0388
331 #define  GLUT_VIDEO_RESIZE_HEIGHT_DELTA     0x0389
332 #define  GLUT_VIDEO_RESIZE_X                0x038A
333 #define  GLUT_VIDEO_RESIZE_Y                0x038B
334 #define  GLUT_VIDEO_RESIZE_WIDTH            0x038C
335 #define  GLUT_VIDEO_RESIZE_HEIGHT           0x038D
336
337 /*
338  * GLUT API macro definitions -- the glutUseLayer parameters
339  */
340 #define  GLUT_NORMAL                        0x0000
341 #define  GLUT_OVERLAY                       0x0001
342
343 /*
344  * GLUT API macro definitions -- the glutGetModifiers parameters
345  */
346 #define  GLUT_ACTIVE_SHIFT                  0x0001
347 #define  GLUT_ACTIVE_CTRL                   0x0002
348 #define  GLUT_ACTIVE_ALT                    0x0004
349
350 /*
351  * GLUT API macro definitions -- the glutSetCursor parameters
352  */
353 #define  GLUT_CURSOR_RIGHT_ARROW            0x0000
354 #define  GLUT_CURSOR_LEFT_ARROW             0x0001
355 #define  GLUT_CURSOR_INFO                   0x0002
356 #define  GLUT_CURSOR_DESTROY                0x0003
357 #define  GLUT_CURSOR_HELP                   0x0004
358 #define  GLUT_CURSOR_CYCLE                  0x0005
359 #define  GLUT_CURSOR_SPRAY                  0x0006
360 #define  GLUT_CURSOR_WAIT                   0x0007
361 #define  GLUT_CURSOR_TEXT                   0x0008
362 #define  GLUT_CURSOR_CROSSHAIR              0x0009
363 #define  GLUT_CURSOR_UP_DOWN                0x000A
364 #define  GLUT_CURSOR_LEFT_RIGHT             0x000B
365 #define  GLUT_CURSOR_TOP_SIDE               0x000C
366 #define  GLUT_CURSOR_BOTTOM_SIDE            0x000D
367 #define  GLUT_CURSOR_LEFT_SIDE              0x000E
368 #define  GLUT_CURSOR_RIGHT_SIDE             0x000F
369 #define  GLUT_CURSOR_TOP_LEFT_CORNER        0x0010
370 #define  GLUT_CURSOR_TOP_RIGHT_CORNER       0x0011
371 #define  GLUT_CURSOR_BOTTOM_RIGHT_CORNER    0x0012
372 #define  GLUT_CURSOR_BOTTOM_LEFT_CORNER     0x0013
373 #define  GLUT_CURSOR_INHERIT                0x0064
374 #define  GLUT_CURSOR_NONE                   0x0065
375 #define  GLUT_CURSOR_FULL_CROSSHAIR         0x0066
376
377 /*
378  * GLUT API macro definitions -- RGB color component specification definitions
379  */
380 #define  GLUT_RED                           0x0000
381 #define  GLUT_GREEN                         0x0001
382 #define  GLUT_BLUE                          0x0002
383
384 /*
385  * GLUT API macro definitions -- additional keyboard and joystick definitions
386  */
387 #define  GLUT_KEY_REPEAT_OFF                0x0000
388 #define  GLUT_KEY_REPEAT_ON                 0x0001
389 #define  GLUT_KEY_REPEAT_DEFAULT            0x0002
390
391 #define  GLUT_JOYSTICK_BUTTON_A             0x0001
392 #define  GLUT_JOYSTICK_BUTTON_B             0x0002
393 #define  GLUT_JOYSTICK_BUTTON_C             0x0004
394 #define  GLUT_JOYSTICK_BUTTON_D             0x0008
395
396 /*
397  * GLUT API macro definitions -- game mode definitions
398  */
399 #define  GLUT_GAME_MODE_ACTIVE              0x0000
400 #define  GLUT_GAME_MODE_POSSIBLE            0x0001
401 #define  GLUT_GAME_MODE_WIDTH               0x0002
402 #define  GLUT_GAME_MODE_HEIGHT              0x0003
403 #define  GLUT_GAME_MODE_PIXEL_DEPTH         0x0004
404 #define  GLUT_GAME_MODE_REFRESH_RATE        0x0005
405 #define  GLUT_GAME_MODE_DISPLAY_CHANGED     0x0006
406
407 /*
408  * Initialization functions, see fglut_init.c
409  */
410 FGAPI void    FGAPIENTRY glutInit( int* pargc, char** argv );
411 FGAPI void    FGAPIENTRY glutInitWindowPosition( int x, int y );
412 FGAPI void    FGAPIENTRY glutInitWindowSize( int width, int height );
413 FGAPI void    FGAPIENTRY glutInitDisplayMode( unsigned int displayMode );
414 FGAPI void    FGAPIENTRY glutInitDisplayString( const char* displayMode );
415
416 /*
417  * Process loop function, see freeglut_main.c
418  */
419 FGAPI void    FGAPIENTRY glutMainLoop( void );
420
421 /*
422  * Window management functions, see freeglut_window.c
423  */
424 FGAPI int     FGAPIENTRY glutCreateWindow( const char* title );
425 FGAPI int     FGAPIENTRY glutCreateSubWindow( int window, int x, int y, int width, int height );
426 FGAPI void    FGAPIENTRY glutDestroyWindow( int window );
427 FGAPI void    FGAPIENTRY glutSetWindow( int window );
428 FGAPI int     FGAPIENTRY glutGetWindow( void );
429 FGAPI void    FGAPIENTRY glutSetWindowTitle( const char* title );
430 FGAPI void    FGAPIENTRY glutSetIconTitle( const char* title );
431 FGAPI void    FGAPIENTRY glutReshapeWindow( int width, int height );
432 FGAPI void    FGAPIENTRY glutPositionWindow( int x, int y );
433 FGAPI void    FGAPIENTRY glutShowWindow( void );
434 FGAPI void    FGAPIENTRY glutHideWindow( void );
435 FGAPI void    FGAPIENTRY glutIconifyWindow( void );
436 FGAPI void    FGAPIENTRY glutPushWindow( void );
437 FGAPI void    FGAPIENTRY glutPopWindow( void );
438 FGAPI void    FGAPIENTRY glutFullScreen( void );
439
440 /*
441  * Display-connected functions, see freeglut_display.c
442  */
443 FGAPI void    FGAPIENTRY glutPostWindowRedisplay( int window );
444 FGAPI void    FGAPIENTRY glutPostRedisplay( void );
445 FGAPI void    FGAPIENTRY glutSwapBuffers( void );
446
447 /*
448  * Mouse cursor functions, see freeglut_cursor.c
449  */
450 FGAPI void    FGAPIENTRY glutWarpPointer( int x, int y );
451 FGAPI void    FGAPIENTRY glutSetCursor( int cursor );
452
453 /*
454  * Overlay stuff, see freeglut_overlay.c
455  */
456 FGAPI void    FGAPIENTRY glutEstablishOverlay( void );
457 FGAPI void    FGAPIENTRY glutRemoveOverlay( void );
458 FGAPI void    FGAPIENTRY glutUseLayer( GLenum layer );
459 FGAPI void    FGAPIENTRY glutPostOverlayRedisplay( void );
460 FGAPI void    FGAPIENTRY glutPostWindowOverlayRedisplay( int window );
461 FGAPI void    FGAPIENTRY glutShowOverlay( void );
462 FGAPI void    FGAPIENTRY glutHideOverlay( void );
463
464 /*
465  * Menu stuff, see freeglut_menu.c
466  */
467 FGAPI int     FGAPIENTRY glutCreateMenu( void (* callback)( int menu ) );
468 FGAPI void    FGAPIENTRY glutDestroyMenu( int menu );
469 FGAPI int     FGAPIENTRY glutGetMenu( void );
470 FGAPI void    FGAPIENTRY glutSetMenu( int menu );
471 FGAPI void    FGAPIENTRY glutAddMenuEntry( const char* label, int value );
472 FGAPI void    FGAPIENTRY glutAddSubMenu( const char* label, int subMenu );
473 FGAPI void    FGAPIENTRY glutChangeToMenuEntry( int item, const char* label, int value );
474 FGAPI void    FGAPIENTRY glutChangeToSubMenu( int item, const char* label, int value );
475 FGAPI void    FGAPIENTRY glutRemoveMenuItem( int item );
476 FGAPI void    FGAPIENTRY glutAttachMenu( int button );
477 FGAPI void    FGAPIENTRY glutDetachMenu( int button );
478
479 /*
480  * Global callback functions, see freeglut_callbacks.c
481  */
482 FGAPI void    FGAPIENTRY glutTimerFunc( unsigned int time, void (* callback)( int ), int value );
483 FGAPI void    FGAPIENTRY glutIdleFunc( void (* callback)( void ) );
484
485 /*
486  * Window-specific callback functions, see freeglut_callbacks.c
487  */
488 FGAPI void    FGAPIENTRY glutKeyboardFunc( void (* callback)( unsigned char, int, int ) );
489 FGAPI void    FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) );
490 FGAPI void    FGAPIENTRY glutReshapeFunc( void (* callback)( int, int ) );
491 FGAPI void    FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) );
492 FGAPI void    FGAPIENTRY glutDisplayFunc( void (* callback)( void ) );
493 FGAPI void    FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) );
494 FGAPI void    FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) );
495 FGAPI void    FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) );
496 FGAPI void    FGAPIENTRY glutEntryFunc( void (* callback)( int ) );
497
498 FGAPI void    FGAPIENTRY glutKeyboardUpFunc( void (* callback)( unsigned char, int, int ) );
499 FGAPI void    FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) );
500 FGAPI void    FGAPIENTRY glutJoystickFunc( void (* callback)( unsigned int, int, int, int ), int pollInterval );
501 FGAPI void    FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) );
502 FGAPI void    FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) );
503 FGAPI void    FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) );
504 FGAPI void    FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) );
505
506 FGAPI void    FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) );
507 FGAPI void    FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) );
508 FGAPI void    FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) );
509 FGAPI void    FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) );
510 FGAPI void    FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) );
511 FGAPI void    FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) );
512 FGAPI void    FGAPIENTRY glutTabletButtonFunc( void (* callback)( int, int, int, int ) );
513
514 /*
515  * State setting and retrieval functions, see freeglut_state.c
516  */
517 FGAPI int     FGAPIENTRY glutGet( GLenum query );
518 FGAPI int     FGAPIENTRY glutDeviceGet( GLenum query );
519 FGAPI int     FGAPIENTRY glutGetModifiers( void );
520 FGAPI int     FGAPIENTRY glutLayerGet( GLenum query );
521
522 /*
523  * Font stuff, see freeglut_font.c
524  */
525 FGAPI void    FGAPIENTRY glutBitmapCharacter( void* font, int character );
526 FGAPI int     FGAPIENTRY glutBitmapWidth( void* font, int character );
527 FGAPI void    FGAPIENTRY glutStrokeCharacter( void* font, int character );
528 FGAPI int     FGAPIENTRY glutStrokeWidth( void* font, int character );
529 FGAPI int     FGAPIENTRY glutBitmapLength( void* font, const unsigned char* string );
530 FGAPI int     FGAPIENTRY glutStrokeLength( void* font, const unsigned char* string );
531
532 /*
533  * Geometry functions, see freeglut_geometry.c
534  */
535
536 FGAPI void    FGAPIENTRY glutWireCube( double size );
537 FGAPI void    FGAPIENTRY glutSolidCube( double size );
538 FGAPI void    FGAPIENTRY glutWireSphere( double radius, GLint slices, GLint stacks );
539 FGAPI void    FGAPIENTRY glutSolidSphere( double radius, GLint slices, GLint stacks );
540 FGAPI void    FGAPIENTRY glutWireCone( double base, double height, GLint slices, GLint stacks );
541 FGAPI void    FGAPIENTRY glutSolidCone( double base, double height, GLint slices, GLint stacks );
542 FGAPI void    FGAPIENTRY glutWireTorus( double innerRadius, double outerRadius, GLint sides, GLint rings );
543 FGAPI void    FGAPIENTRY glutSolidTorus( double innerRadius, double outerRadius, GLint sides, GLint rings );
544 FGAPI void    FGAPIENTRY glutWireDodecahedron( void );
545 FGAPI void    FGAPIENTRY glutSolidDodecahedron( void );
546 FGAPI void    FGAPIENTRY glutWireOctahedron( void );
547 FGAPI void    FGAPIENTRY glutSolidOctahedron( void );
548 FGAPI void    FGAPIENTRY glutWireTetrahedron( void );
549 FGAPI void    FGAPIENTRY glutSolidTetrahedron( void );
550 FGAPI void    FGAPIENTRY glutWireIcosahedron( void );
551 FGAPI void    FGAPIENTRY glutSolidIcosahedron( void );
552
553 /*
554  * Teapot rendering functions, found in freeglut_teapot.c
555  * NB: front facing polygons have clockwise winding, not counter clockwise
556  */
557 /* TODO: doesn't work with GLES1 yet */
558 #ifndef EGL_VERSION_1_0
559 FGAPI void    FGAPIENTRY glutWireTeapot( GLdouble size );
560 FGAPI void    FGAPIENTRY glutSolidTeapot( GLdouble size );
561 #endif
562
563 /*
564  * Game mode functions, see freeglut_gamemode.c
565  */
566 FGAPI void    FGAPIENTRY glutGameModeString( const char* string );
567 FGAPI int     FGAPIENTRY glutEnterGameMode( void );
568 FGAPI void    FGAPIENTRY glutLeaveGameMode( void );
569 FGAPI int     FGAPIENTRY glutGameModeGet( GLenum query );
570
571 /*
572  * Video resize functions, see freeglut_videoresize.c
573  */
574 FGAPI int     FGAPIENTRY glutVideoResizeGet( GLenum query );
575 FGAPI void    FGAPIENTRY glutSetupVideoResizing( void );
576 FGAPI void    FGAPIENTRY glutStopVideoResizing( void );
577 FGAPI void    FGAPIENTRY glutVideoResize( int x, int y, int width, int height );
578 FGAPI void    FGAPIENTRY glutVideoPan( int x, int y, int width, int height );
579
580 /*
581  * Colormap functions, see freeglut_misc.c
582  */
583 FGAPI void    FGAPIENTRY glutSetColor( int color, GLfloat red, GLfloat green, GLfloat blue );
584 FGAPI GLfloat FGAPIENTRY glutGetColor( int color, int component );
585 FGAPI void    FGAPIENTRY glutCopyColormap( int window );
586
587 /*
588  * Misc keyboard and joystick functions, see freeglut_misc.c
589  */
590 FGAPI void    FGAPIENTRY glutIgnoreKeyRepeat( int ignore );
591 FGAPI void    FGAPIENTRY glutSetKeyRepeat( int repeatMode );
592 FGAPI void    FGAPIENTRY glutForceJoystickFunc( void );
593
594 /*
595  * Misc functions, see freeglut_misc.c
596  */
597 FGAPI int     FGAPIENTRY glutExtensionSupported( const char* extension );
598 FGAPI void    FGAPIENTRY glutReportErrors( void );
599
600 /* Comment from glut.h of classic GLUT:
601
602    Win32 has an annoying issue where there are multiple C run-time
603    libraries (CRTs).  If the executable is linked with a different CRT
604    from the GLUT DLL, the GLUT DLL will not share the same CRT static
605    data seen by the executable.  In particular, atexit callbacks registered
606    in the executable will not be called if GLUT calls its (different)
607    exit routine).  GLUT is typically built with the
608    "/MD" option (the CRT with multithreading DLL support), but the Visual
609    C++ linker default is "/ML" (the single threaded CRT).
610
611    One workaround to this issue is requiring users to always link with
612    the same CRT as GLUT is compiled with.  That requires users supply a
613    non-standard option.  GLUT 3.7 has its own built-in workaround where
614    the executable's "exit" function pointer is covertly passed to GLUT.
615    GLUT then calls the executable's exit function pointer to ensure that
616    any "atexit" calls registered by the application are called if GLUT
617    needs to exit.
618
619    Note that the __glut*WithExit routines should NEVER be called directly.
620    To avoid the atexit workaround, #define GLUT_DISABLE_ATEXIT_HACK. */
621
622 /* to get the prototype for exit() */
623 #include <stdlib.h>
624
625 #if defined(_WIN32) && !defined(GLUT_DISABLE_ATEXIT_HACK) && !defined(__WATCOMC__)
626 FGAPI void FGAPIENTRY __glutInitWithExit(int *argcp, char **argv, void (__cdecl *exitfunc)(int));
627 FGAPI int FGAPIENTRY __glutCreateWindowWithExit(const char *title, void (__cdecl *exitfunc)(int));
628 FGAPI int FGAPIENTRY __glutCreateMenuWithExit(void (* func)(int), void (__cdecl *exitfunc)(int));
629 #ifndef FREEGLUT_BUILDING_LIB
630 #if defined(__GNUC__)
631 #define FGUNUSED __attribute__((unused))
632 #else
633 #define FGUNUSED
634 #endif
635 static void FGAPIENTRY FGUNUSED glutInit_ATEXIT_HACK(int *argcp, char **argv) { __glutInitWithExit(argcp, argv, exit); }
636 #define glutInit glutInit_ATEXIT_HACK
637 static int FGAPIENTRY FGUNUSED glutCreateWindow_ATEXIT_HACK(const char *title) { return __glutCreateWindowWithExit(title, exit); }
638 #define glutCreateWindow glutCreateWindow_ATEXIT_HACK
639 static int FGAPIENTRY FGUNUSED glutCreateMenu_ATEXIT_HACK(void (* func)(int)) { return __glutCreateMenuWithExit(func, exit); }
640 #define glutCreateMenu glutCreateMenu_ATEXIT_HACK
641 #endif
642 #endif
643
644 #ifdef __cplusplus
645     }
646 #endif
647
648 /*** END OF FILE ***/
649
650 #endif /* __FREEGLUT_STD_H__ */
651