including OpenGL/gl.h and OpenGL/glu.h when on apple platform
[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  GLUT_XLIB_IMPLEMENTATION 13
125 /* Deprecated:
126    cf. http://sourceforge.net/mailarchive/forum.php?thread_name=CABcAi1hw7cr4xtigckaGXB5X8wddLfMcbA_rZ3NAuwMrX_zmsw%40mail.gmail.com&forum_name=freeglut-developer */
127 #define  FREEGLUT_VERSION_2_0 1
128
129 /*
130  * Always include OpenGL and GLU headers
131  */
132 /* Note: FREEGLUT_GLES1 and FREEGLUT_GLES2 are only used to cleanly
133    bootstrap headers inclusion here; use GLES constants directly
134    (e.g. GL_ES_VERSION_2_0) for all other needs */
135 #ifdef FREEGLUT_GLES2
136 #   include <EGL/egl.h>
137 #   include <GLES2/gl2.h>
138 #elif FREEGLUT_GLES1
139 #   include <EGL/egl.h>
140 #   include <GLES/gl.h>
141 #elif __APPLE__
142 #   include <OpenGL/gl.h>
143 #   include <OpenGL/glu.h>
144 #else
145 #   include <GL/gl.h>
146 #   include <GL/glu.h>
147 #endif
148
149 /*
150  * GLUT API macro definitions -- the special key codes:
151  */
152 #define  GLUT_KEY_F1                        0x0001
153 #define  GLUT_KEY_F2                        0x0002
154 #define  GLUT_KEY_F3                        0x0003
155 #define  GLUT_KEY_F4                        0x0004
156 #define  GLUT_KEY_F5                        0x0005
157 #define  GLUT_KEY_F6                        0x0006
158 #define  GLUT_KEY_F7                        0x0007
159 #define  GLUT_KEY_F8                        0x0008
160 #define  GLUT_KEY_F9                        0x0009
161 #define  GLUT_KEY_F10                       0x000A
162 #define  GLUT_KEY_F11                       0x000B
163 #define  GLUT_KEY_F12                       0x000C
164 #define  GLUT_KEY_LEFT                      0x0064
165 #define  GLUT_KEY_UP                        0x0065
166 #define  GLUT_KEY_RIGHT                     0x0066
167 #define  GLUT_KEY_DOWN                      0x0067
168 #define  GLUT_KEY_PAGE_UP                   0x0068
169 #define  GLUT_KEY_PAGE_DOWN                 0x0069
170 #define  GLUT_KEY_HOME                      0x006A
171 #define  GLUT_KEY_END                       0x006B
172 #define  GLUT_KEY_INSERT                    0x006C
173
174 /*
175  * GLUT API macro definitions -- mouse state definitions
176  */
177 #define  GLUT_LEFT_BUTTON                   0x0000
178 #define  GLUT_MIDDLE_BUTTON                 0x0001
179 #define  GLUT_RIGHT_BUTTON                  0x0002
180 #define  GLUT_DOWN                          0x0000
181 #define  GLUT_UP                            0x0001
182 #define  GLUT_LEFT                          0x0000
183 #define  GLUT_ENTERED                       0x0001
184
185 /*
186  * GLUT API macro definitions -- the display mode definitions
187  */
188 #define  GLUT_RGB                           0x0000
189 #define  GLUT_RGBA                          0x0000
190 #define  GLUT_INDEX                         0x0001
191 #define  GLUT_SINGLE                        0x0000
192 #define  GLUT_DOUBLE                        0x0002
193 #define  GLUT_ACCUM                         0x0004
194 #define  GLUT_ALPHA                         0x0008
195 #define  GLUT_DEPTH                         0x0010
196 #define  GLUT_STENCIL                       0x0020
197 #define  GLUT_MULTISAMPLE                   0x0080
198 #define  GLUT_STEREO                        0x0100
199 #define  GLUT_LUMINANCE                     0x0200
200
201 /*
202  * GLUT API macro definitions -- windows and menu related definitions
203  */
204 #define  GLUT_MENU_NOT_IN_USE               0x0000
205 #define  GLUT_MENU_IN_USE                   0x0001
206 #define  GLUT_NOT_VISIBLE                   0x0000
207 #define  GLUT_VISIBLE                       0x0001
208 #define  GLUT_HIDDEN                        0x0000
209 #define  GLUT_FULLY_RETAINED                0x0001
210 #define  GLUT_PARTIALLY_RETAINED            0x0002
211 #define  GLUT_FULLY_COVERED                 0x0003
212
213 /*
214  * GLUT API macro definitions -- fonts definitions
215  *
216  * Steve Baker suggested to make it binary compatible with GLUT:
217  */
218 #if defined(_MSC_VER) || defined(__CYGWIN__) || defined(__MINGW32__) || defined(__WATCOMC__)
219 #   define  GLUT_STROKE_ROMAN               ((void *)0x0000)
220 #   define  GLUT_STROKE_MONO_ROMAN          ((void *)0x0001)
221 #   define  GLUT_BITMAP_9_BY_15             ((void *)0x0002)
222 #   define  GLUT_BITMAP_8_BY_13             ((void *)0x0003)
223 #   define  GLUT_BITMAP_TIMES_ROMAN_10      ((void *)0x0004)
224 #   define  GLUT_BITMAP_TIMES_ROMAN_24      ((void *)0x0005)
225 #   define  GLUT_BITMAP_HELVETICA_10        ((void *)0x0006)
226 #   define  GLUT_BITMAP_HELVETICA_12        ((void *)0x0007)
227 #   define  GLUT_BITMAP_HELVETICA_18        ((void *)0x0008)
228 #else
229     /*
230      * I don't really know if it's a good idea... But here it goes:
231      */
232     extern void* glutStrokeRoman;
233     extern void* glutStrokeMonoRoman;
234     extern void* glutBitmap9By15;
235     extern void* glutBitmap8By13;
236     extern void* glutBitmapTimesRoman10;
237     extern void* glutBitmapTimesRoman24;
238     extern void* glutBitmapHelvetica10;
239     extern void* glutBitmapHelvetica12;
240     extern void* glutBitmapHelvetica18;
241
242     /*
243      * Those pointers will be used by following definitions:
244      */
245 #   define  GLUT_STROKE_ROMAN               ((void *) &glutStrokeRoman)
246 #   define  GLUT_STROKE_MONO_ROMAN          ((void *) &glutStrokeMonoRoman)
247 #   define  GLUT_BITMAP_9_BY_15             ((void *) &glutBitmap9By15)
248 #   define  GLUT_BITMAP_8_BY_13             ((void *) &glutBitmap8By13)
249 #   define  GLUT_BITMAP_TIMES_ROMAN_10      ((void *) &glutBitmapTimesRoman10)
250 #   define  GLUT_BITMAP_TIMES_ROMAN_24      ((void *) &glutBitmapTimesRoman24)
251 #   define  GLUT_BITMAP_HELVETICA_10        ((void *) &glutBitmapHelvetica10)
252 #   define  GLUT_BITMAP_HELVETICA_12        ((void *) &glutBitmapHelvetica12)
253 #   define  GLUT_BITMAP_HELVETICA_18        ((void *) &glutBitmapHelvetica18)
254 #endif
255
256 /*
257  * GLUT API macro definitions -- the glutGet parameters
258  */
259 #define  GLUT_WINDOW_X                      0x0064
260 #define  GLUT_WINDOW_Y                      0x0065
261 #define  GLUT_WINDOW_WIDTH                  0x0066
262 #define  GLUT_WINDOW_HEIGHT                 0x0067
263 #define  GLUT_WINDOW_BUFFER_SIZE            0x0068
264 #define  GLUT_WINDOW_STENCIL_SIZE           0x0069
265 #define  GLUT_WINDOW_DEPTH_SIZE             0x006A
266 #define  GLUT_WINDOW_RED_SIZE               0x006B
267 #define  GLUT_WINDOW_GREEN_SIZE             0x006C
268 #define  GLUT_WINDOW_BLUE_SIZE              0x006D
269 #define  GLUT_WINDOW_ALPHA_SIZE             0x006E
270 #define  GLUT_WINDOW_ACCUM_RED_SIZE         0x006F
271 #define  GLUT_WINDOW_ACCUM_GREEN_SIZE       0x0070
272 #define  GLUT_WINDOW_ACCUM_BLUE_SIZE        0x0071
273 #define  GLUT_WINDOW_ACCUM_ALPHA_SIZE       0x0072
274 #define  GLUT_WINDOW_DOUBLEBUFFER           0x0073
275 #define  GLUT_WINDOW_RGBA                   0x0074
276 #define  GLUT_WINDOW_PARENT                 0x0075
277 #define  GLUT_WINDOW_NUM_CHILDREN           0x0076
278 #define  GLUT_WINDOW_COLORMAP_SIZE          0x0077
279 #define  GLUT_WINDOW_NUM_SAMPLES            0x0078
280 #define  GLUT_WINDOW_STEREO                 0x0079
281 #define  GLUT_WINDOW_CURSOR                 0x007A
282
283 #define  GLUT_SCREEN_WIDTH                  0x00C8
284 #define  GLUT_SCREEN_HEIGHT                 0x00C9
285 #define  GLUT_SCREEN_WIDTH_MM               0x00CA
286 #define  GLUT_SCREEN_HEIGHT_MM              0x00CB
287 #define  GLUT_MENU_NUM_ITEMS                0x012C
288 #define  GLUT_DISPLAY_MODE_POSSIBLE         0x0190
289 #define  GLUT_INIT_WINDOW_X                 0x01F4
290 #define  GLUT_INIT_WINDOW_Y                 0x01F5
291 #define  GLUT_INIT_WINDOW_WIDTH             0x01F6
292 #define  GLUT_INIT_WINDOW_HEIGHT            0x01F7
293 #define  GLUT_INIT_DISPLAY_MODE             0x01F8
294 #define  GLUT_ELAPSED_TIME                  0x02BC
295 #define  GLUT_WINDOW_FORMAT_ID              0x007B
296
297 /*
298  * GLUT API macro definitions -- the glutDeviceGet parameters
299  */
300 #define  GLUT_HAS_KEYBOARD                  0x0258
301 #define  GLUT_HAS_MOUSE                     0x0259
302 #define  GLUT_HAS_SPACEBALL                 0x025A
303 #define  GLUT_HAS_DIAL_AND_BUTTON_BOX       0x025B
304 #define  GLUT_HAS_TABLET                    0x025C
305 #define  GLUT_NUM_MOUSE_BUTTONS             0x025D
306 #define  GLUT_NUM_SPACEBALL_BUTTONS         0x025E
307 #define  GLUT_NUM_BUTTON_BOX_BUTTONS        0x025F
308 #define  GLUT_NUM_DIALS                     0x0260
309 #define  GLUT_NUM_TABLET_BUTTONS            0x0261
310 #define  GLUT_DEVICE_IGNORE_KEY_REPEAT      0x0262
311 #define  GLUT_DEVICE_KEY_REPEAT             0x0263
312 #define  GLUT_HAS_JOYSTICK                  0x0264
313 #define  GLUT_OWNS_JOYSTICK                 0x0265
314 #define  GLUT_JOYSTICK_BUTTONS              0x0266
315 #define  GLUT_JOYSTICK_AXES                 0x0267
316 #define  GLUT_JOYSTICK_POLL_RATE            0x0268
317
318 /*
319  * GLUT API macro definitions -- the glutLayerGet parameters
320  */
321 #define  GLUT_OVERLAY_POSSIBLE              0x0320
322 #define  GLUT_LAYER_IN_USE                  0x0321
323 #define  GLUT_HAS_OVERLAY                   0x0322
324 #define  GLUT_TRANSPARENT_INDEX             0x0323
325 #define  GLUT_NORMAL_DAMAGED                0x0324
326 #define  GLUT_OVERLAY_DAMAGED               0x0325
327
328 /*
329  * GLUT API macro definitions -- the glutVideoResizeGet parameters
330  */
331 #define  GLUT_VIDEO_RESIZE_POSSIBLE         0x0384
332 #define  GLUT_VIDEO_RESIZE_IN_USE           0x0385
333 #define  GLUT_VIDEO_RESIZE_X_DELTA          0x0386
334 #define  GLUT_VIDEO_RESIZE_Y_DELTA          0x0387
335 #define  GLUT_VIDEO_RESIZE_WIDTH_DELTA      0x0388
336 #define  GLUT_VIDEO_RESIZE_HEIGHT_DELTA     0x0389
337 #define  GLUT_VIDEO_RESIZE_X                0x038A
338 #define  GLUT_VIDEO_RESIZE_Y                0x038B
339 #define  GLUT_VIDEO_RESIZE_WIDTH            0x038C
340 #define  GLUT_VIDEO_RESIZE_HEIGHT           0x038D
341
342 /*
343  * GLUT API macro definitions -- the glutUseLayer parameters
344  */
345 #define  GLUT_NORMAL                        0x0000
346 #define  GLUT_OVERLAY                       0x0001
347
348 /*
349  * GLUT API macro definitions -- the glutGetModifiers parameters
350  */
351 #define  GLUT_ACTIVE_SHIFT                  0x0001
352 #define  GLUT_ACTIVE_CTRL                   0x0002
353 #define  GLUT_ACTIVE_ALT                    0x0004
354
355 /*
356  * GLUT API macro definitions -- the glutSetCursor parameters
357  */
358 #define  GLUT_CURSOR_RIGHT_ARROW            0x0000
359 #define  GLUT_CURSOR_LEFT_ARROW             0x0001
360 #define  GLUT_CURSOR_INFO                   0x0002
361 #define  GLUT_CURSOR_DESTROY                0x0003
362 #define  GLUT_CURSOR_HELP                   0x0004
363 #define  GLUT_CURSOR_CYCLE                  0x0005
364 #define  GLUT_CURSOR_SPRAY                  0x0006
365 #define  GLUT_CURSOR_WAIT                   0x0007
366 #define  GLUT_CURSOR_TEXT                   0x0008
367 #define  GLUT_CURSOR_CROSSHAIR              0x0009
368 #define  GLUT_CURSOR_UP_DOWN                0x000A
369 #define  GLUT_CURSOR_LEFT_RIGHT             0x000B
370 #define  GLUT_CURSOR_TOP_SIDE               0x000C
371 #define  GLUT_CURSOR_BOTTOM_SIDE            0x000D
372 #define  GLUT_CURSOR_LEFT_SIDE              0x000E
373 #define  GLUT_CURSOR_RIGHT_SIDE             0x000F
374 #define  GLUT_CURSOR_TOP_LEFT_CORNER        0x0010
375 #define  GLUT_CURSOR_TOP_RIGHT_CORNER       0x0011
376 #define  GLUT_CURSOR_BOTTOM_RIGHT_CORNER    0x0012
377 #define  GLUT_CURSOR_BOTTOM_LEFT_CORNER     0x0013
378 #define  GLUT_CURSOR_INHERIT                0x0064
379 #define  GLUT_CURSOR_NONE                   0x0065
380 #define  GLUT_CURSOR_FULL_CROSSHAIR         0x0066
381
382 /*
383  * GLUT API macro definitions -- RGB color component specification definitions
384  */
385 #define  GLUT_RED                           0x0000
386 #define  GLUT_GREEN                         0x0001
387 #define  GLUT_BLUE                          0x0002
388
389 /*
390  * GLUT API macro definitions -- additional keyboard and joystick definitions
391  */
392 #define  GLUT_KEY_REPEAT_OFF                0x0000
393 #define  GLUT_KEY_REPEAT_ON                 0x0001
394 #define  GLUT_KEY_REPEAT_DEFAULT            0x0002
395
396 #define  GLUT_JOYSTICK_BUTTON_A             0x0001
397 #define  GLUT_JOYSTICK_BUTTON_B             0x0002
398 #define  GLUT_JOYSTICK_BUTTON_C             0x0004
399 #define  GLUT_JOYSTICK_BUTTON_D             0x0008
400
401 /*
402  * GLUT API macro definitions -- game mode definitions
403  */
404 #define  GLUT_GAME_MODE_ACTIVE              0x0000
405 #define  GLUT_GAME_MODE_POSSIBLE            0x0001
406 #define  GLUT_GAME_MODE_WIDTH               0x0002
407 #define  GLUT_GAME_MODE_HEIGHT              0x0003
408 #define  GLUT_GAME_MODE_PIXEL_DEPTH         0x0004
409 #define  GLUT_GAME_MODE_REFRESH_RATE        0x0005
410 #define  GLUT_GAME_MODE_DISPLAY_CHANGED     0x0006
411
412 /*
413  * Initialization functions, see fglut_init.c
414  */
415 FGAPI void    FGAPIENTRY glutInit( int* pargc, char** argv );
416 FGAPI void    FGAPIENTRY glutInitWindowPosition( int x, int y );
417 FGAPI void    FGAPIENTRY glutInitWindowSize( int width, int height );
418 FGAPI void    FGAPIENTRY glutInitDisplayMode( unsigned int displayMode );
419 FGAPI void    FGAPIENTRY glutInitDisplayString( const char* displayMode );
420
421 /*
422  * Process loop function, see freeglut_main.c
423  */
424 FGAPI void    FGAPIENTRY glutMainLoop( void );
425
426 /*
427  * Window management functions, see freeglut_window.c
428  */
429 FGAPI int     FGAPIENTRY glutCreateWindow( const char* title );
430 FGAPI int     FGAPIENTRY glutCreateSubWindow( int window, int x, int y, int width, int height );
431 FGAPI void    FGAPIENTRY glutDestroyWindow( int window );
432 FGAPI void    FGAPIENTRY glutSetWindow( int window );
433 FGAPI int     FGAPIENTRY glutGetWindow( void );
434 FGAPI void    FGAPIENTRY glutSetWindowTitle( const char* title );
435 FGAPI void    FGAPIENTRY glutSetIconTitle( const char* title );
436 FGAPI void    FGAPIENTRY glutReshapeWindow( int width, int height );
437 FGAPI void    FGAPIENTRY glutPositionWindow( int x, int y );
438 FGAPI void    FGAPIENTRY glutShowWindow( void );
439 FGAPI void    FGAPIENTRY glutHideWindow( void );
440 FGAPI void    FGAPIENTRY glutIconifyWindow( void );
441 FGAPI void    FGAPIENTRY glutPushWindow( void );
442 FGAPI void    FGAPIENTRY glutPopWindow( void );
443 FGAPI void    FGAPIENTRY glutFullScreen( void );
444
445 /*
446  * Display-connected functions, see freeglut_display.c
447  */
448 FGAPI void    FGAPIENTRY glutPostWindowRedisplay( int window );
449 FGAPI void    FGAPIENTRY glutPostRedisplay( void );
450 FGAPI void    FGAPIENTRY glutSwapBuffers( void );
451
452 /*
453  * Mouse cursor functions, see freeglut_cursor.c
454  */
455 FGAPI void    FGAPIENTRY glutWarpPointer( int x, int y );
456 FGAPI void    FGAPIENTRY glutSetCursor( int cursor );
457
458 /*
459  * Overlay stuff, see freeglut_overlay.c
460  */
461 FGAPI void    FGAPIENTRY glutEstablishOverlay( void );
462 FGAPI void    FGAPIENTRY glutRemoveOverlay( void );
463 FGAPI void    FGAPIENTRY glutUseLayer( GLenum layer );
464 FGAPI void    FGAPIENTRY glutPostOverlayRedisplay( void );
465 FGAPI void    FGAPIENTRY glutPostWindowOverlayRedisplay( int window );
466 FGAPI void    FGAPIENTRY glutShowOverlay( void );
467 FGAPI void    FGAPIENTRY glutHideOverlay( void );
468
469 /*
470  * Menu stuff, see freeglut_menu.c
471  */
472 FGAPI int     FGAPIENTRY glutCreateMenu( void (* callback)( int menu ) );
473 FGAPI void    FGAPIENTRY glutDestroyMenu( int menu );
474 FGAPI int     FGAPIENTRY glutGetMenu( void );
475 FGAPI void    FGAPIENTRY glutSetMenu( int menu );
476 FGAPI void    FGAPIENTRY glutAddMenuEntry( const char* label, int value );
477 FGAPI void    FGAPIENTRY glutAddSubMenu( const char* label, int subMenu );
478 FGAPI void    FGAPIENTRY glutChangeToMenuEntry( int item, const char* label, int value );
479 FGAPI void    FGAPIENTRY glutChangeToSubMenu( int item, const char* label, int value );
480 FGAPI void    FGAPIENTRY glutRemoveMenuItem( int item );
481 FGAPI void    FGAPIENTRY glutAttachMenu( int button );
482 FGAPI void    FGAPIENTRY glutDetachMenu( int button );
483
484 /*
485  * Global callback functions, see freeglut_callbacks.c
486  */
487 FGAPI void    FGAPIENTRY glutTimerFunc( unsigned int time, void (* callback)( int ), int value );
488 FGAPI void    FGAPIENTRY glutIdleFunc( void (* callback)( void ) );
489
490 /*
491  * Window-specific callback functions, see freeglut_callbacks.c
492  */
493 FGAPI void    FGAPIENTRY glutKeyboardFunc( void (* callback)( unsigned char, int, int ) );
494 FGAPI void    FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) );
495 FGAPI void    FGAPIENTRY glutReshapeFunc( void (* callback)( int, int ) );
496 FGAPI void    FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) );
497 FGAPI void    FGAPIENTRY glutDisplayFunc( void (* callback)( void ) );
498 FGAPI void    FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) );
499 FGAPI void    FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) );
500 FGAPI void    FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) );
501 FGAPI void    FGAPIENTRY glutEntryFunc( void (* callback)( int ) );
502
503 FGAPI void    FGAPIENTRY glutKeyboardUpFunc( void (* callback)( unsigned char, int, int ) );
504 FGAPI void    FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) );
505 FGAPI void    FGAPIENTRY glutJoystickFunc( void (* callback)( unsigned int, int, int, int ), int pollInterval );
506 FGAPI void    FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) );
507 FGAPI void    FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) );
508 FGAPI void    FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) );
509 FGAPI void    FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) );
510
511 FGAPI void    FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) );
512 FGAPI void    FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) );
513 FGAPI void    FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) );
514 FGAPI void    FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) );
515 FGAPI void    FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) );
516 FGAPI void    FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) );
517 FGAPI void    FGAPIENTRY glutTabletButtonFunc( void (* callback)( int, int, int, int ) );
518
519 /*
520  * State setting and retrieval functions, see freeglut_state.c
521  */
522 FGAPI int     FGAPIENTRY glutGet( GLenum query );
523 FGAPI int     FGAPIENTRY glutDeviceGet( GLenum query );
524 FGAPI int     FGAPIENTRY glutGetModifiers( void );
525 FGAPI int     FGAPIENTRY glutLayerGet( GLenum query );
526
527 /*
528  * Font stuff, see freeglut_font.c
529  */
530 FGAPI void    FGAPIENTRY glutBitmapCharacter( void* font, int character );
531 FGAPI int     FGAPIENTRY glutBitmapWidth( void* font, int character );
532 FGAPI void    FGAPIENTRY glutStrokeCharacter( void* font, int character );
533 FGAPI int     FGAPIENTRY glutStrokeWidth( void* font, int character );
534 FGAPI int     FGAPIENTRY glutBitmapLength( void* font, const unsigned char* string );
535 FGAPI int     FGAPIENTRY glutStrokeLength( void* font, const unsigned char* string );
536
537 /*
538  * Geometry functions, see freeglut_geometry.c
539  */
540
541 FGAPI void    FGAPIENTRY glutWireCube( double size );
542 FGAPI void    FGAPIENTRY glutSolidCube( double size );
543 FGAPI void    FGAPIENTRY glutWireSphere( double radius, GLint slices, GLint stacks );
544 FGAPI void    FGAPIENTRY glutSolidSphere( double radius, GLint slices, GLint stacks );
545 FGAPI void    FGAPIENTRY glutWireCone( double base, double height, GLint slices, GLint stacks );
546 FGAPI void    FGAPIENTRY glutSolidCone( double base, double height, GLint slices, GLint stacks );
547 FGAPI void    FGAPIENTRY glutWireTorus( double innerRadius, double outerRadius, GLint sides, GLint rings );
548 FGAPI void    FGAPIENTRY glutSolidTorus( double innerRadius, double outerRadius, GLint sides, GLint rings );
549 FGAPI void    FGAPIENTRY glutWireDodecahedron( void );
550 FGAPI void    FGAPIENTRY glutSolidDodecahedron( void );
551 FGAPI void    FGAPIENTRY glutWireOctahedron( void );
552 FGAPI void    FGAPIENTRY glutSolidOctahedron( void );
553 FGAPI void    FGAPIENTRY glutWireTetrahedron( void );
554 FGAPI void    FGAPIENTRY glutSolidTetrahedron( void );
555 FGAPI void    FGAPIENTRY glutWireIcosahedron( void );
556 FGAPI void    FGAPIENTRY glutSolidIcosahedron( void );
557
558 /*
559  * Teapot rendering functions, found in freeglut_teapot.c
560  * NB: front facing polygons have clockwise winding, not counter clockwise
561  */
562 /* TODO: doesn't work with GLES1 yet */
563 #ifndef EGL_VERSION_1_0
564 FGAPI void    FGAPIENTRY glutWireTeapot( GLdouble size );
565 FGAPI void    FGAPIENTRY glutSolidTeapot( GLdouble size );
566 #endif
567
568 /*
569  * Game mode functions, see freeglut_gamemode.c
570  */
571 FGAPI void    FGAPIENTRY glutGameModeString( const char* string );
572 FGAPI int     FGAPIENTRY glutEnterGameMode( void );
573 FGAPI void    FGAPIENTRY glutLeaveGameMode( void );
574 FGAPI int     FGAPIENTRY glutGameModeGet( GLenum query );
575
576 /*
577  * Video resize functions, see freeglut_videoresize.c
578  */
579 FGAPI int     FGAPIENTRY glutVideoResizeGet( GLenum query );
580 FGAPI void    FGAPIENTRY glutSetupVideoResizing( void );
581 FGAPI void    FGAPIENTRY glutStopVideoResizing( void );
582 FGAPI void    FGAPIENTRY glutVideoResize( int x, int y, int width, int height );
583 FGAPI void    FGAPIENTRY glutVideoPan( int x, int y, int width, int height );
584
585 /*
586  * Colormap functions, see freeglut_misc.c
587  */
588 FGAPI void    FGAPIENTRY glutSetColor( int color, GLfloat red, GLfloat green, GLfloat blue );
589 FGAPI GLfloat FGAPIENTRY glutGetColor( int color, int component );
590 FGAPI void    FGAPIENTRY glutCopyColormap( int window );
591
592 /*
593  * Misc keyboard and joystick functions, see freeglut_misc.c
594  */
595 FGAPI void    FGAPIENTRY glutIgnoreKeyRepeat( int ignore );
596 FGAPI void    FGAPIENTRY glutSetKeyRepeat( int repeatMode );
597 FGAPI void    FGAPIENTRY glutForceJoystickFunc( void );
598
599 /*
600  * Misc functions, see freeglut_misc.c
601  */
602 FGAPI int     FGAPIENTRY glutExtensionSupported( const char* extension );
603 FGAPI void    FGAPIENTRY glutReportErrors( void );
604
605 /* Comment from glut.h of classic GLUT:
606
607    Win32 has an annoying issue where there are multiple C run-time
608    libraries (CRTs).  If the executable is linked with a different CRT
609    from the GLUT DLL, the GLUT DLL will not share the same CRT static
610    data seen by the executable.  In particular, atexit callbacks registered
611    in the executable will not be called if GLUT calls its (different)
612    exit routine).  GLUT is typically built with the
613    "/MD" option (the CRT with multithreading DLL support), but the Visual
614    C++ linker default is "/ML" (the single threaded CRT).
615
616    One workaround to this issue is requiring users to always link with
617    the same CRT as GLUT is compiled with.  That requires users supply a
618    non-standard option.  GLUT 3.7 has its own built-in workaround where
619    the executable's "exit" function pointer is covertly passed to GLUT.
620    GLUT then calls the executable's exit function pointer to ensure that
621    any "atexit" calls registered by the application are called if GLUT
622    needs to exit.
623
624    Note that the __glut*WithExit routines should NEVER be called directly.
625    To avoid the atexit workaround, #define GLUT_DISABLE_ATEXIT_HACK. */
626
627 /* to get the prototype for exit() */
628 #include <stdlib.h>
629
630 #if defined(_WIN32) && !defined(GLUT_DISABLE_ATEXIT_HACK) && !defined(__WATCOMC__)
631 FGAPI void FGAPIENTRY __glutInitWithExit(int *argcp, char **argv, void (__cdecl *exitfunc)(int));
632 FGAPI int FGAPIENTRY __glutCreateWindowWithExit(const char *title, void (__cdecl *exitfunc)(int));
633 FGAPI int FGAPIENTRY __glutCreateMenuWithExit(void (* func)(int), void (__cdecl *exitfunc)(int));
634 #ifndef FREEGLUT_BUILDING_LIB
635 #if defined(__GNUC__)
636 #define FGUNUSED __attribute__((unused))
637 #else
638 #define FGUNUSED
639 #endif
640 static void FGAPIENTRY FGUNUSED glutInit_ATEXIT_HACK(int *argcp, char **argv) { __glutInitWithExit(argcp, argv, exit); }
641 #define glutInit glutInit_ATEXIT_HACK
642 static int FGAPIENTRY FGUNUSED glutCreateWindow_ATEXIT_HACK(const char *title) { return __glutCreateWindowWithExit(title, exit); }
643 #define glutCreateWindow glutCreateWindow_ATEXIT_HACK
644 static int FGAPIENTRY FGUNUSED glutCreateMenu_ATEXIT_HACK(void (* func)(int)) { return __glutCreateMenuWithExit(func, exit); }
645 #define glutCreateMenu glutCreateMenu_ATEXIT_HACK
646 #endif
647 #endif
648
649 #ifdef __cplusplus
650     }
651 #endif
652
653 /*** END OF FILE ***/
654
655 #endif /* __FREEGLUT_STD_H__ */
656