4 * The freeglut library private include file.
6 * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
7 * Written by Pawel W. Olszta, <olszta@sourceforge.net>
8 * Creation date: Thu Dec 2 1999
10 * Permission is hereby granted, free of charge, to any person obtaining a
11 * copy of this software and associated documentation files (the "Software"),
12 * to deal in the Software without restriction, including without limitation
13 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
14 * and/or sell copies of the Software, and to permit persons to whom the
15 * Software is furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included
18 * in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
24 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
25 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 #ifndef FREEGLUT_INTERNAL_H
29 #define FREEGLUT_INTERNAL_H
35 /* XXX Update these for each release! */
36 #define VERSION_MAJOR 2
37 #define VERSION_MINOR 4
38 #define VERSION_PATCH 0
40 /* Freeglut is meant to be available under all Unix/X11 and Win32 platforms. */
41 #if defined(_WIN32_WCE)
42 # define TARGET_HOST_UNIX_X11 0
43 # define TARGET_HOST_WIN32 0
44 # define TARGET_HOST_WINCE 1
45 #elif defined(_MSC_VER) || defined(__CYGWIN__) || defined(__MINGW32__)
46 # define TARGET_HOST_UNIX_X11 0
47 # define TARGET_HOST_WIN32 1
48 # define TARGET_HOST_WINCE 0
50 # define TARGET_HOST_UNIX_X11 1
51 # define TARGET_HOST_WIN32 0
52 # define TARGET_HOST_WINCE 0
55 #define FREEGLUT_MAX_MENUS 3
57 /* Somehow all Win32 include headers depend on this one: */
64 /* TODO: MinGW is lacking a prototype, this should better be handled via autoconf! */
65 #ifndef ChangeDisplaySettingsEx
66 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
67 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
69 #define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
71 #define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
77 #define strdup _strdup
80 /* Those files should be available on every platform. */
88 # include <sys/types.h>
93 #if TIME_WITH_SYS_TIME
94 # include <sys/time.h>
98 # include <sys/time.h>
104 /* The system-dependant include files should go here: */
105 #if TARGET_HOST_UNIX_X11
107 #include <X11/Xlib.h>
108 #include <X11/Xatom.h>
109 #include <X11/keysym.h>
111 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
112 #include <X11/extensions/xf86vmode.h>
116 /* Microsoft VisualC++ 5.0's <math.h> does not define the PI */
118 # define M_PI 3.14159265358979323846
129 #define INVALID_MODIFIERS 0xffffffff
131 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
133 /* Freeglut callbacks type definitions */
134 typedef void (* FGCBDisplay )( void );
135 typedef void (* FGCBReshape )( int, int );
136 typedef void (* FGCBVisibility )( int );
137 typedef void (* FGCBKeyboard )( unsigned char, int, int );
138 typedef void (* FGCBSpecial )( int, int, int );
139 typedef void (* FGCBMouse )( int, int, int, int );
140 typedef void (* FGCBMouseWheel )( int, int, int, int );
141 typedef void (* FGCBMotion )( int, int );
142 typedef void (* FGCBPassive )( int, int );
143 typedef void (* FGCBEntry )( int );
144 typedef void (* FGCBWindowStatus )( int );
145 typedef void (* FGCBSelect )( int, int, int );
146 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
147 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
148 typedef void (* FGCBSpecialUp )( int, int, int );
149 typedef void (* FGCBOverlayDisplay)( void );
150 typedef void (* FGCBSpaceMotion )( int, int, int );
151 typedef void (* FGCBSpaceRotation )( int, int, int );
152 typedef void (* FGCBSpaceButton )( int, int );
153 typedef void (* FGCBDials )( int, int );
154 typedef void (* FGCBButtonBox )( int, int );
155 typedef void (* FGCBTabletMotion )( int, int );
156 typedef void (* FGCBTabletButton )( int, int, int, int );
157 typedef void (* FGCBDestroy )( void );
159 /* The global callbacks type definitions */
160 typedef void (* FGCBIdle )( void );
161 typedef void (* FGCBTimer )( int );
162 typedef void (* FGCBMenuState )( int );
163 typedef void (* FGCBMenuStatus )( int, int, int );
165 /* The callback used when creating/using menus */
166 typedef void (* FGCBMenu )( int );
169 /* A list structure */
170 typedef struct tagSFG_List SFG_List;
177 /* A list node structure */
178 typedef struct tagSFG_Node SFG_Node;
185 /* A helper structure holding two ints and a boolean */
186 typedef struct tagSFG_XYUse SFG_XYUse;
189 GLint X, Y; /* The two integers... */
190 GLboolean Use; /* ...and a single boolean. */
193 /* A helper structure holding a timeval and a boolean */
194 typedef struct tagSFG_Time SFG_Time;
197 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
200 struct timeval Value;
206 * An enumeration containing the state of the GLUT execution:
207 * initializing, running, or stopping
211 GLUT_EXEC_STATE_INIT,
212 GLUT_EXEC_STATE_RUNNING,
216 /* This structure holds different freeglut settings */
217 typedef struct tagSFG_State SFG_State;
220 SFG_XYUse Position; /* The default windows' position */
221 SFG_XYUse Size; /* The default windows' size */
222 unsigned int DisplayMode; /* Display mode for new windows */
224 GLboolean Initialised; /* freeglut has been initialised */
226 int DirectContext; /* Direct rendering state */
228 GLboolean ForceIconic; /* New top windows are iconified */
229 GLboolean UseCurrentContext; /* New windows share with current */
231 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
232 GLboolean XSyncSwitch; /* X11 sync protocol switch */
234 int KeyRepeat; /* Global key repeat mode. */
235 int Modifiers; /* Current ALT/SHIFT/CTRL state */
237 GLuint FPSInterval; /* Interval between FPS printfs */
238 GLuint SwapCount; /* Count of glutSwapBuffer calls */
239 GLuint SwapTime; /* Time of last SwapBuffers */
241 SFG_Time Time; /* Time that glutInit was called */
242 SFG_List Timers; /* The freeglut timer hooks */
243 SFG_List FreeTimers; /* The unused timer hooks */
245 FGCBIdle IdleCallback; /* The global idle callback */
247 int ActiveMenus; /* Num. of currently active menus */
248 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
249 FGCBMenuStatus MenuStatusCallback;
251 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
252 int GameModeDepth; /* The pixel depth for game mode */
253 int GameModeRefresh; /* The refresh rate for game mode */
255 int ActionOnWindowClose; /* Action when user closes window */
257 fgExecutionState ExecState; /* Used for GLUT termination */
258 char *ProgramName; /* Name of the invoking program */
259 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
260 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
263 /* The structure used by display initialization in freeglut_init.c */
264 typedef struct tagSFG_Display SFG_Display;
265 struct tagSFG_Display
267 #if TARGET_HOST_UNIX_X11
268 Display* Display; /* The display we are being run in. */
269 int Screen; /* The screen we are about to use. */
270 Window RootWindow; /* The screen's root window. */
271 int Connection; /* The display's connection number */
272 Atom DeleteWindow; /* The window deletion atom */
274 #ifdef X_XF86VidModeGetModeLine
276 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
277 * the validity of the VidMode has to be tracked
279 int DisplayModeValid; /* Flag that indicates runtime status*/
280 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
281 int DisplayModeClock; /* The display mode's refresh rate */
282 int DisplayViewPortX; /* saved X location of the viewport */
283 int DisplayViewPortY; /* saved Y location of the viewport */
284 int DisplayPointerX; /* saved X location of the pointer */
285 int DisplayPointerY; /* saved Y location of the pointer */
289 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
290 HINSTANCE Instance; /* The application's instance */
291 DEVMODE DisplayMode; /* Desktop's display settings */
295 int ScreenWidth; /* The screen's width in pixels */
296 int ScreenHeight; /* The screen's height in pixels */
297 int ScreenWidthMM; /* The screen's width in milimeters */
298 int ScreenHeightMM; /* The screen's height in milimeters */
302 /* The user can create any number of timer hooks */
303 typedef struct tagSFG_Timer SFG_Timer;
307 int ID; /* The timer ID integer */
308 FGCBTimer Callback; /* The timer callback */
309 long TriggerTime; /* The timer trigger time */
313 * Make "freeglut" window handle and context types so that we don't need so
314 * much conditionally-compiled code later in the library.
316 #if TARGET_HOST_UNIX_X11
318 typedef Window SFG_WindowHandleType ;
319 typedef GLXContext SFG_WindowContextType ;
321 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
323 typedef HWND SFG_WindowHandleType ;
324 typedef HGLRC SFG_WindowContextType ;
329 * A window and its OpenGL context. The contents of this structure
330 * are highly dependant on the target operating system we aim at...
332 typedef struct tagSFG_Context SFG_Context;
333 struct tagSFG_Context
335 SFG_WindowHandleType Handle; /* The window's handle */
336 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
338 #if TARGET_HOST_UNIX_X11
339 XVisualInfo* VisualInfo; /* The window's visual information */
340 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
341 HDC Device; /* The window's device context */
344 int DoubleBuffered; /* Treat the window as double-buffered */
347 /* Window's state description. This structure should be kept portable. */
348 typedef struct tagSFG_WindowState SFG_WindowState;
349 struct tagSFG_WindowState
351 int Width; /* Window's width in pixels */
352 int Height; /* The same about the height */
353 int OldWidth; /* Window width from before a resize */
354 int OldHeight; /* " height " " " " */
356 GLboolean Redisplay; /* Do we have to redisplay? */
357 GLboolean Visible; /* Is the window visible now */
359 int Cursor; /* The currently selected cursor */
361 long JoystickPollRate; /* The joystick polling rate */
362 long JoystickLastPoll; /* When the last poll happened */
364 int MouseX, MouseY; /* The most recent mouse position */
366 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
367 GLboolean KeyRepeating; /* Currently in repeat mode */
369 GLboolean IsGameMode; /* Is this the game mode window? */
370 GLboolean NeedToResize; /* Do we need to resize the window? */
375 * A generic function pointer. We should really use the GLUTproc type
376 * defined in freeglut_ext.h, but if we include that header in this file
377 * a bunch of other stuff (font-related) blows up!
379 typedef void (*SFG_Proc)();
383 * SET_WCB() is used as:
385 * SET_WCB( window, cbname, func );
387 * ...where {window} is the freeglut window to set the callback,
388 * {cbname} is the window-specific callback to set,
389 * {func} is a function-pointer.
391 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
392 * but this can cause warnings because the FETCH_WCB() macro type-
393 * casts its result, and a type-cast value shouldn't be an lvalue.
395 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
396 * and for no other reason. Since it's hidden in the macro, the
397 * ugliness is felt to be rather benign.
399 #define SET_WCB(window,cbname,func) \
402 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
403 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
407 * FETCH_WCB() is used as:
409 * FETCH_WCB( window, cbname );
411 * ...where {window} is the freeglut window to fetch the callback from,
412 * {cbname} is the window-specific callback to fetch.
414 * The result is correctly type-cast to the callback function pointer
417 #define FETCH_WCB(window,cbname) \
418 ((window).CallBacks[CB_ ## cbname])
421 * INVOKE_WCB() is used as:
423 * INVOKE_WCB( window, cbname, ( arg_list ) );
425 * ...where {window} is the freeglut window,
426 * {cbname} is the window-specific callback to be invoked,
427 * {(arg_list)} is the parameter list.
429 * The callback is invoked as:
431 * callback( arg_list );
433 * ...so the parentheses are REQUIRED in the {arg_list}.
435 * NOTE that it does a sanity-check and also sets the
439 #if TARGET_HOST_WIN32
440 #define INVOKE_WCB(window,cbname,arg_list) \
443 if( FETCH_WCB( window, cbname ) ) \
445 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
446 fgSetWindow( &window ); \
451 #define INVOKE_WCB(window,cbname,arg_list) \
454 if( FETCH_WCB( window, cbname ) ) \
456 fgSetWindow( &window ); \
457 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
463 * The window callbacks the user can supply us with. Should be kept portable.
465 * This enumeration provides the freeglut CallBack numbers.
466 * The symbolic constants are indices into a window's array of
467 * function callbacks. The names are formed by splicing a common
468 * prefix onto the callback's base name. (This was originally
469 * done so that an early stage of development could live side-by-
470 * side with the old callback code. The old callback code used
471 * the bare callback's name as a structure member, so I used a
472 * prefix for the array index name.)
474 * XXX For consistancy, perhaps the prefix should match the
475 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
496 /* Presently ignored */
507 /* Always make this the LAST one */
512 /* This structure holds the OpenGL rendering context for all the menu windows */
513 typedef struct tagSFG_MenuContext SFG_MenuContext;
514 struct tagSFG_MenuContext
516 #if TARGET_HOST_UNIX_X11
517 XVisualInfo* MVisualInfo; /* The window's visual information */
520 SFG_WindowContextType MContext; /* The menu window's WGL context */
523 /* This structure describes a menu */
524 typedef struct tagSFG_Window SFG_Window;
525 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
526 typedef struct tagSFG_Menu SFG_Menu;
530 void *UserData; /* User data passed back at callback */
531 int ID; /* The global menu ID */
532 SFG_List Entries; /* The menu entries list */
533 FGCBMenu Callback; /* The menu callback */
534 FGCBDestroy Destroy; /* Destruction callback */
535 GLboolean IsActive; /* Is the menu selected? */
536 int Width; /* Menu box width in pixels */
537 int Height; /* Menu box height in pixels */
538 int X, Y; /* Menu box raster position */
540 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
541 SFG_Window *Window; /* Window for menu */
542 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
545 /* This is a menu entry */
546 struct tagSFG_MenuEntry
549 int ID; /* The menu entry ID (local) */
550 int Ordinal; /* The menu's ordinal number */
551 char* Text; /* The text to be displayed */
552 SFG_Menu* SubMenu; /* Optional sub-menu tree */
553 GLboolean IsActive; /* Is the entry highlighted? */
554 int Width; /* Label's width in pixels */
558 * A window, making part of freeglut windows hierarchy.
559 * Should be kept portable.
561 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
566 int ID; /* Window's ID number */
568 SFG_Context Window; /* Window and OpenGL context */
569 SFG_WindowState State; /* The window state */
570 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
571 void *UserData ; /* For use by user */
573 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
574 SFG_Menu* ActiveMenu; /* The window's active menu */
576 SFG_Window* Parent; /* The parent to this window */
577 SFG_List Children; /* The subwindows d.l. list */
579 GLboolean IsMenu; /* Set to 1 if we are a menu */
583 /* A linked list structure of windows */
584 typedef struct tagSFG_WindowList SFG_WindowList ;
585 struct tagSFG_WindowList
591 /* This holds information about all the windows, menus etc. */
592 typedef struct tagSFG_Structure SFG_Structure;
593 struct tagSFG_Structure
595 SFG_List Windows; /* The global windows list */
596 SFG_List Menus; /* The global menus list */
597 SFG_List WindowsToDestroy;
599 SFG_Window* CurrentWindow; /* The currently set window */
600 SFG_Menu* CurrentMenu; /* Same, but menu... */
602 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
604 SFG_Window* GameMode; /* The game mode window */
606 int WindowID; /* The new current window ID */
607 int MenuID; /* The new current menu ID */
611 * This structure is used for the enumeration purposes.
612 * You can easily extend its functionalities by declaring
613 * a structure containing enumerator's contents and custom
614 * data, then casting its pointer to (SFG_Enumerator *).
616 typedef struct tagSFG_Enumerator SFG_Enumerator;
617 struct tagSFG_Enumerator
619 GLboolean found; /* Used to terminate search */
620 void* data; /* Custom data pointer */
622 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
624 /* The bitmap font structure */
625 typedef struct tagSFG_Font SFG_Font;
628 char* Name; /* The source font name */
629 int Quantity; /* Number of chars in font */
630 int Height; /* Height of the characters */
631 const GLubyte** Characters; /* The characters mapping */
633 float xorig, yorig; /* Relative origin of the character */
636 /* The stroke font structures */
638 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
639 struct tagSFG_StrokeVertex
644 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
645 struct tagSFG_StrokeStrip
648 const SFG_StrokeVertex* Vertices;
651 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
652 struct tagSFG_StrokeChar
656 const SFG_StrokeStrip* Strips;
659 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
660 struct tagSFG_StrokeFont
662 char* Name; /* The source font name */
663 int Quantity; /* Number of chars in font */
664 GLfloat Height; /* Height of the characters */
665 const SFG_StrokeChar** Characters; /* The characters mapping */
668 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
670 /* Freeglut display related stuff (initialized once per session) */
671 extern SFG_Display fgDisplay;
673 /* Freeglut internal structure */
674 extern SFG_Structure fgStructure;
676 /* The current freeglut settings */
677 extern SFG_State fgState;
680 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
683 * A call to this function makes us sure that the Display and Structure
684 * subsystems have been properly initialized and are ready to be used
686 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
687 if ( ! fgState.Initialised ) \
689 fgError ( " ERROR: Function <%s> called" \
690 " without first calling 'glutInit'.", (string) ) ; \
693 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
694 if ( ! fgState.Initialised ) \
696 fgError ( " ERROR: Internal <%s> function called" \
697 " without first calling 'glutInit'.", (string) ) ; \
700 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
703 fgError ( " ERROR: Internal error <%s> in function %s", \
704 (string), (function) ) ; \
708 * Following definitions are somewhat similiar to GLib's,
709 * but do not generate any log messages:
711 #define freeglut_return_if_fail( expr ) \
714 #define freeglut_return_val_if_fail( expr, val ) \
719 * A call to those macros assures us that there is a current
720 * window set, respectively:
722 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
723 if ( ! fgStructure.CurrentWindow ) \
725 fgError ( " ERROR: Function <%s> called" \
726 " with no current window defined.", (string) ) ; \
730 * The deinitialize function gets called on glutMainLoop() end. It should clean up
731 * everything inside of the freeglut
733 void fgDeinitialize( void );
736 * Those two functions are used to create/destroy the freeglut internal
737 * structures. This actually happens when calling glutInit() and when
738 * quitting the glutMainLoop() (which actually happens, when all windows
741 void fgCreateStructure( void );
742 void fgDestroyStructure( void );
744 /* A helper function to check if a display mode is possible to use */
745 #if TARGET_HOST_UNIX_X11
746 XVisualInfo* fgChooseVisual( void );
749 /* The window procedure for Win32 events handling */
750 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
751 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
752 WPARAM wParam, LPARAM lParam );
753 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
754 unsigned char layer_type );
758 * Window creation, opening, closing and destruction.
759 * Also CallBack clearing/initialization.
760 * Defined in freeglut_structure.c, freeglut_window.c.
762 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
763 int x, int y, int w, int h,
764 GLboolean gameMode, GLboolean isMenu );
765 void fgSetWindow ( SFG_Window *window );
766 void fgOpenWindow( SFG_Window* window, const char* title,
767 int x, int y, int w, int h, GLboolean gameMode,
768 GLboolean isSubWindow );
769 void fgCloseWindow( SFG_Window* window );
770 void fgAddToWindowDestroyList ( SFG_Window* window );
771 void fgCloseWindows ();
772 void fgDestroyWindow( SFG_Window* window );
774 /* Menu creation and destruction. Defined in freeglut_structure.c */
775 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
776 void fgDestroyMenu( SFG_Menu* menu );
778 /* Joystick device management functions, defined in freeglut_joystick.c */
779 int fgJoystickDetect( void );
780 void fgInitialiseJoysticks( void );
781 void fgJoystickClose( void );
782 void fgJoystickPollWindow( SFG_Window* window );
784 /* InputDevice Initialisation and Closure */
785 int fgInputDeviceDetect( void );
786 void fgInitialiseInputDevices( void );
787 void fgInputDeviceClose( void );
789 /* Setting the cursor for a given window */
790 void fgSetCursor ( SFG_Window *window, int cursorID );
793 * Helper function to enumerate through all registered windows
794 * and one to enumerate all of a window's subwindows...
796 * The GFunc callback for those functions will be defined as:
798 * void enumCallback( gpointer window, gpointer enumerator );
800 * where window is the enumerated (sub)window pointer (SFG_Window *),
801 * and userData is the a custom user-supplied pointer. Functions
802 * are defined and exported from freeglut_structure.c file.
804 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
805 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
806 SFG_Enumerator* enumerator );
809 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
810 * first window in the queue matching the specified window handle.
811 * The function is defined in freeglut_structure.c file.
813 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
816 * This function is similiar to the previous one, except it is
817 * looking for a specified (sub)window identifier. The function
818 * is defined in freeglut_structure.c file.
820 SFG_Window* fgWindowByID( int windowID );
823 * Looks up a menu given its ID. This is easier than fgWindowByXXX
824 * as all menus are placed in a single doubly linked list...
826 SFG_Menu* fgMenuByID( int menuID );
829 * The menu activation and deactivation the code. This is the meat
830 * of the menu user interface handling code...
832 void fgUpdateMenuHighlight ( SFG_Menu *menu );
833 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
834 int mouse_x, int mouse_y );
835 void fgDeactivateMenu( SFG_Window *window );
838 * This function gets called just before the buffers swap, so that
839 * freeglut can display the pull-down menus via OpenGL. The function
840 * is defined in freeglut_menu.c file.
842 void fgDisplayMenu( void );
844 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
845 long fgElapsedTime( void );
848 void fgListInit(SFG_List *list);
849 void fgListAppend(SFG_List *list, SFG_Node *node);
850 void fgListRemove(SFG_List *list, SFG_Node *node);
851 int fgListLength(SFG_List *list);
852 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
854 /* Error Message functions */
855 void fgError( const char *fmt, ... );
856 void fgWarning( const char *fmt, ... );
858 #endif /* FREEGLUT_INTERNAL_H */
860 /*** END OF FILE ***/