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__) || defined(__WATCOMC__)
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
76 #if defined(_MSC_VER) || defined(__WATCOMC__)
77 #define strdup _strdup
80 /* These files should be available on every platform. */
88 /* These are included based on autoconf directives. */
90 # include <sys/types.h>
95 #if TIME_WITH_SYS_TIME
96 # include <sys/time.h>
100 # include <sys/time.h>
106 /* The system-dependant include files should go here: */
107 #if TARGET_HOST_UNIX_X11
109 #include <X11/Xlib.h>
110 #include <X11/Xatom.h>
111 #include <X11/keysym.h>
113 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
114 #include <X11/extensions/xf86vmode.h>
118 /* Microsoft VisualC++ 5.0's <math.h> does not define the PI */
120 # define M_PI 3.14159265358979323846
131 /* General defines */
133 #define INVALID_MODIFIERS 0xffffffff
135 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
137 /* Freeglut callbacks type definitions */
138 typedef void (* FGCBDisplay )( void );
139 typedef void (* FGCBReshape )( int, int );
140 typedef void (* FGCBVisibility )( int );
141 typedef void (* FGCBKeyboard )( unsigned char, int, int );
142 typedef void (* FGCBSpecial )( int, int, int );
143 typedef void (* FGCBMouse )( int, int, int, int );
144 typedef void (* FGCBMouseWheel )( int, int, int, int );
145 typedef void (* FGCBMotion )( int, int );
146 typedef void (* FGCBPassive )( int, int );
147 typedef void (* FGCBEntry )( int );
148 typedef void (* FGCBWindowStatus )( int );
149 typedef void (* FGCBSelect )( int, int, int );
150 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
151 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
152 typedef void (* FGCBSpecialUp )( int, int, int );
153 typedef void (* FGCBOverlayDisplay)( void );
154 typedef void (* FGCBSpaceMotion )( int, int, int );
155 typedef void (* FGCBSpaceRotation )( int, int, int );
156 typedef void (* FGCBSpaceButton )( int, int );
157 typedef void (* FGCBDials )( int, int );
158 typedef void (* FGCBButtonBox )( int, int );
159 typedef void (* FGCBTabletMotion )( int, int );
160 typedef void (* FGCBTabletButton )( int, int, int, int );
161 typedef void (* FGCBDestroy )( void );
163 /* The global callbacks type definitions */
164 typedef void (* FGCBIdle )( void );
165 typedef void (* FGCBTimer )( int );
166 typedef void (* FGCBMenuState )( int );
167 typedef void (* FGCBMenuStatus )( int, int, int );
169 /* The callback used when creating/using menus */
170 typedef void (* FGCBMenu )( int );
173 /* A list structure */
174 typedef struct tagSFG_List SFG_List;
181 /* A list node structure */
182 typedef struct tagSFG_Node SFG_Node;
189 /* A helper structure holding two ints and a boolean */
190 typedef struct tagSFG_XYUse SFG_XYUse;
193 GLint X, Y; /* The two integers... */
194 GLboolean Use; /* ...and a single boolean. */
197 /* A helper structure holding a timeval and a boolean */
198 typedef struct tagSFG_Time SFG_Time;
201 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
204 struct timeval Value;
210 * An enumeration containing the state of the GLUT execution:
211 * initializing, running, or stopping
215 GLUT_EXEC_STATE_INIT,
216 GLUT_EXEC_STATE_RUNNING,
220 /* This structure holds different freeglut settings */
221 typedef struct tagSFG_State SFG_State;
224 SFG_XYUse Position; /* The default windows' position */
225 SFG_XYUse Size; /* The default windows' size */
226 unsigned int DisplayMode; /* Display mode for new windows */
228 GLboolean Initialised; /* freeglut has been initialised */
230 int DirectContext; /* Direct rendering state */
232 GLboolean ForceIconic; /* New top windows are iconified */
233 GLboolean UseCurrentContext; /* New windows share with current */
235 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
236 GLboolean XSyncSwitch; /* X11 sync protocol switch */
238 int KeyRepeat; /* Global key repeat mode. */
239 int Modifiers; /* Current ALT/SHIFT/CTRL state */
241 GLuint FPSInterval; /* Interval between FPS printfs */
242 GLuint SwapCount; /* Count of glutSwapBuffer calls */
243 GLuint SwapTime; /* Time of last SwapBuffers */
245 SFG_Time Time; /* Time that glutInit was called */
246 SFG_List Timers; /* The freeglut timer hooks */
247 SFG_List FreeTimers; /* The unused timer hooks */
249 FGCBIdle IdleCallback; /* The global idle callback */
251 int ActiveMenus; /* Num. of currently active menus */
252 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
253 FGCBMenuStatus MenuStatusCallback;
255 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
256 int GameModeDepth; /* The pixel depth for game mode */
257 int GameModeRefresh; /* The refresh rate for game mode */
259 int ActionOnWindowClose; /* Action when user closes window */
261 fgExecutionState ExecState; /* Used for GLUT termination */
262 char *ProgramName; /* Name of the invoking program */
263 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
264 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
267 /* The structure used by display initialization in freeglut_init.c */
268 typedef struct tagSFG_Display SFG_Display;
269 struct tagSFG_Display
271 #if TARGET_HOST_UNIX_X11
272 Display* Display; /* The display we are being run in. */
273 int Screen; /* The screen we are about to use. */
274 Window RootWindow; /* The screen's root window. */
275 int Connection; /* The display's connection number */
276 Atom DeleteWindow; /* The window deletion atom */
278 #ifdef X_XF86VidModeGetModeLine
280 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
281 * the validity of the VidMode has to be tracked
283 int DisplayModeValid; /* Flag that indicates runtime status*/
284 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
285 int DisplayModeClock; /* The display mode's refresh rate */
286 int DisplayViewPortX; /* saved X location of the viewport */
287 int DisplayViewPortY; /* saved Y location of the viewport */
288 int DisplayPointerX; /* saved X location of the pointer */
289 int DisplayPointerY; /* saved Y location of the pointer */
291 #endif /* X_XF86VidModeGetModeLine */
293 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
294 HINSTANCE Instance; /* The application's instance */
295 DEVMODE DisplayMode; /* Desktop's display settings */
299 int ScreenWidth; /* The screen's width in pixels */
300 int ScreenHeight; /* The screen's height in pixels */
301 int ScreenWidthMM; /* The screen's width in milimeters */
302 int ScreenHeightMM; /* The screen's height in milimeters */
306 /* The user can create any number of timer hooks */
307 typedef struct tagSFG_Timer SFG_Timer;
311 int ID; /* The timer ID integer */
312 FGCBTimer Callback; /* The timer callback */
313 long TriggerTime; /* The timer trigger time */
317 * Make "freeglut" window handle and context types so that we don't need so
318 * much conditionally-compiled code later in the library.
320 #if TARGET_HOST_UNIX_X11
322 typedef Window SFG_WindowHandleType ;
323 typedef GLXContext SFG_WindowContextType ;
325 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
327 typedef HWND SFG_WindowHandleType ;
328 typedef HGLRC SFG_WindowContextType ;
333 * A window and its OpenGL context. The contents of this structure
334 * are highly dependant on the target operating system we aim at...
336 typedef struct tagSFG_Context SFG_Context;
337 struct tagSFG_Context
339 SFG_WindowHandleType Handle; /* The window's handle */
340 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
342 #if TARGET_HOST_UNIX_X11
343 XVisualInfo* VisualInfo; /* The window's visual information */
344 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
345 HDC Device; /* The window's device context */
348 int DoubleBuffered; /* Treat the window as double-buffered */
351 /* Window's state description. This structure should be kept portable. */
352 typedef struct tagSFG_WindowState SFG_WindowState;
353 struct tagSFG_WindowState
355 int Width; /* Window's width in pixels */
356 int Height; /* The same about the height */
357 int OldWidth; /* Window width from before a resize */
358 int OldHeight; /* " height " " " " */
360 GLboolean Redisplay; /* Do we have to redisplay? */
361 GLboolean Visible; /* Is the window visible now */
363 int Cursor; /* The currently selected cursor */
365 long JoystickPollRate; /* The joystick polling rate */
366 long JoystickLastPoll; /* When the last poll happened */
368 int MouseX, MouseY; /* The most recent mouse position */
370 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
371 GLboolean KeyRepeating; /* Currently in repeat mode */
373 GLboolean IsGameMode; /* Is this the game mode window? */
374 GLboolean NeedToResize; /* Do we need to resize the window? */
379 * A generic function pointer. We should really use the GLUTproc type
380 * defined in freeglut_ext.h, but if we include that header in this file
381 * a bunch of other stuff (font-related) blows up!
383 typedef void (*SFG_Proc)();
387 * SET_WCB() is used as:
389 * SET_WCB( window, cbname, func );
391 * ...where {window} is the freeglut window to set the callback,
392 * {cbname} is the window-specific callback to set,
393 * {func} is a function-pointer.
395 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
396 * but this can cause warnings because the FETCH_WCB() macro type-
397 * casts its result, and a type-cast value shouldn't be an lvalue.
399 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
400 * and for no other reason. Since it's hidden in the macro, the
401 * ugliness is felt to be rather benign.
403 #define SET_WCB(window,cbname,func) \
406 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
407 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
411 * FETCH_WCB() is used as:
413 * FETCH_WCB( window, cbname );
415 * ...where {window} is the freeglut window to fetch the callback from,
416 * {cbname} is the window-specific callback to fetch.
418 * The result is correctly type-cast to the callback function pointer
421 #define FETCH_WCB(window,cbname) \
422 ((window).CallBacks[CB_ ## cbname])
425 * INVOKE_WCB() is used as:
427 * INVOKE_WCB( window, cbname, ( arg_list ) );
429 * ...where {window} is the freeglut window,
430 * {cbname} is the window-specific callback to be invoked,
431 * {(arg_list)} is the parameter list.
433 * The callback is invoked as:
435 * callback( arg_list );
437 * ...so the parentheses are REQUIRED in the {arg_list}.
439 * NOTE that it does a sanity-check and also sets the
443 #if TARGET_HOST_WIN32
444 #define INVOKE_WCB(window,cbname,arg_list) \
447 if( FETCH_WCB( window, cbname ) ) \
449 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
450 fgSetWindow( &window ); \
455 #define INVOKE_WCB(window,cbname,arg_list) \
458 if( FETCH_WCB( window, cbname ) ) \
460 fgSetWindow( &window ); \
461 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
467 * The window callbacks the user can supply us with. Should be kept portable.
469 * This enumeration provides the freeglut CallBack numbers.
470 * The symbolic constants are indices into a window's array of
471 * function callbacks. The names are formed by splicing a common
472 * prefix onto the callback's base name. (This was originally
473 * done so that an early stage of development could live side-by-
474 * side with the old callback code. The old callback code used
475 * the bare callback's name as a structure member, so I used a
476 * prefix for the array index name.)
478 * XXX For consistancy, perhaps the prefix should match the
479 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
500 /* Presently ignored */
511 /* Always make this the LAST one */
516 /* This structure holds the OpenGL rendering context for all the menu windows */
517 typedef struct tagSFG_MenuContext SFG_MenuContext;
518 struct tagSFG_MenuContext
520 #if TARGET_HOST_UNIX_X11
521 XVisualInfo* MVisualInfo; /* The window's visual information */
524 SFG_WindowContextType MContext; /* The menu window's WGL context */
527 /* This structure describes a menu */
528 typedef struct tagSFG_Window SFG_Window;
529 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
530 typedef struct tagSFG_Menu SFG_Menu;
534 void *UserData; /* User data passed back at callback */
535 int ID; /* The global menu ID */
536 SFG_List Entries; /* The menu entries list */
537 FGCBMenu Callback; /* The menu callback */
538 FGCBDestroy Destroy; /* Destruction callback */
539 GLboolean IsActive; /* Is the menu selected? */
540 int Width; /* Menu box width in pixels */
541 int Height; /* Menu box height in pixels */
542 int X, Y; /* Menu box raster position */
544 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
545 SFG_Window *Window; /* Window for menu */
546 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
549 /* This is a menu entry */
550 struct tagSFG_MenuEntry
553 int ID; /* The menu entry ID (local) */
554 int Ordinal; /* The menu's ordinal number */
555 char* Text; /* The text to be displayed */
556 SFG_Menu* SubMenu; /* Optional sub-menu tree */
557 GLboolean IsActive; /* Is the entry highlighted? */
558 int Width; /* Label's width in pixels */
562 * A window, making part of freeglut windows hierarchy.
563 * Should be kept portable.
565 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
570 int ID; /* Window's ID number */
572 SFG_Context Window; /* Window and OpenGL context */
573 SFG_WindowState State; /* The window state */
574 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
575 void *UserData ; /* For use by user */
577 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
578 SFG_Menu* ActiveMenu; /* The window's active menu */
580 SFG_Window* Parent; /* The parent to this window */
581 SFG_List Children; /* The subwindows d.l. list */
583 GLboolean IsMenu; /* Set to 1 if we are a menu */
587 /* A linked list structure of windows */
588 typedef struct tagSFG_WindowList SFG_WindowList ;
589 struct tagSFG_WindowList
595 /* This holds information about all the windows, menus etc. */
596 typedef struct tagSFG_Structure SFG_Structure;
597 struct tagSFG_Structure
599 SFG_List Windows; /* The global windows list */
600 SFG_List Menus; /* The global menus list */
601 SFG_List WindowsToDestroy;
603 SFG_Window* CurrentWindow; /* The currently set window */
604 SFG_Menu* CurrentMenu; /* Same, but menu... */
606 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
608 SFG_Window* GameModeWindow; /* The game mode window */
610 int WindowID; /* The new current window ID */
611 int MenuID; /* The new current menu ID */
615 * This structure is used for the enumeration purposes.
616 * You can easily extend its functionalities by declaring
617 * a structure containing enumerator's contents and custom
618 * data, then casting its pointer to (SFG_Enumerator *).
620 typedef struct tagSFG_Enumerator SFG_Enumerator;
621 struct tagSFG_Enumerator
623 GLboolean found; /* Used to terminate search */
624 void* data; /* Custom data pointer */
626 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
628 /* The bitmap font structure */
629 typedef struct tagSFG_Font SFG_Font;
632 char* Name; /* The source font name */
633 int Quantity; /* Number of chars in font */
634 int Height; /* Height of the characters */
635 const GLubyte** Characters; /* The characters mapping */
637 float xorig, yorig; /* Relative origin of the character */
640 /* The stroke font structures */
642 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
643 struct tagSFG_StrokeVertex
648 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
649 struct tagSFG_StrokeStrip
652 const SFG_StrokeVertex* Vertices;
655 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
656 struct tagSFG_StrokeChar
660 const SFG_StrokeStrip* Strips;
663 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
664 struct tagSFG_StrokeFont
666 char* Name; /* The source font name */
667 int Quantity; /* Number of chars in font */
668 GLfloat Height; /* Height of the characters */
669 const SFG_StrokeChar** Characters; /* The characters mapping */
672 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
674 /* Freeglut display related stuff (initialized once per session) */
675 extern SFG_Display fgDisplay;
677 /* Freeglut internal structure */
678 extern SFG_Structure fgStructure;
680 /* The current freeglut settings */
681 extern SFG_State fgState;
684 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
687 * A call to this function makes us sure that the Display and Structure
688 * subsystems have been properly initialized and are ready to be used
690 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
691 if ( ! fgState.Initialised ) \
693 fgError ( " ERROR: Function <%s> called" \
694 " without first calling 'glutInit'.", (string) ) ; \
697 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
698 if ( ! fgState.Initialised ) \
700 fgError ( " ERROR: Internal <%s> function called" \
701 " without first calling 'glutInit'.", (string) ) ; \
704 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
707 fgError ( " ERROR: Internal error <%s> in function %s", \
708 (string), (function) ) ; \
712 * Following definitions are somewhat similiar to GLib's,
713 * but do not generate any log messages:
715 #define freeglut_return_if_fail( expr ) \
718 #define freeglut_return_val_if_fail( expr, val ) \
723 * A call to those macros assures us that there is a current
724 * window set, respectively:
726 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
727 if ( ! fgStructure.CurrentWindow ) \
729 fgError ( " ERROR: Function <%s> called" \
730 " with no current window defined.", (string) ) ; \
734 * The deinitialize function gets called on glutMainLoop() end. It should clean up
735 * everything inside of the freeglut
737 void fgDeinitialize( void );
740 * Those two functions are used to create/destroy the freeglut internal
741 * structures. This actually happens when calling glutInit() and when
742 * quitting the glutMainLoop() (which actually happens, when all windows
745 void fgCreateStructure( void );
746 void fgDestroyStructure( void );
748 /* A helper function to check if a display mode is possible to use */
749 #if TARGET_HOST_UNIX_X11
750 XVisualInfo* fgChooseVisual( void );
753 /* The window procedure for Win32 events handling */
754 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
755 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
756 WPARAM wParam, LPARAM lParam );
757 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
758 unsigned char layer_type );
762 * Window creation, opening, closing and destruction.
763 * Also CallBack clearing/initialization.
764 * Defined in freeglut_structure.c, freeglut_window.c.
766 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
767 int x, int y, int w, int h,
768 GLboolean gameMode, GLboolean isMenu );
769 void fgSetWindow ( SFG_Window *window );
770 void fgOpenWindow( SFG_Window* window, const char* title,
771 int x, int y, int w, int h, GLboolean gameMode,
772 GLboolean isSubWindow );
773 void fgCloseWindow( SFG_Window* window );
774 void fgAddToWindowDestroyList ( SFG_Window* window );
775 void fgCloseWindows ();
776 void fgDestroyWindow( SFG_Window* window );
778 /* Menu creation and destruction. Defined in freeglut_structure.c */
779 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
780 void fgDestroyMenu( SFG_Menu* menu );
782 /* Joystick device management functions, defined in freeglut_joystick.c */
783 int fgJoystickDetect( void );
784 void fgInitialiseJoysticks( void );
785 void fgJoystickClose( void );
786 void fgJoystickPollWindow( SFG_Window* window );
788 /* InputDevice Initialisation and Closure */
789 int fgInputDeviceDetect( void );
790 void fgInitialiseInputDevices( void );
791 void fgInputDeviceClose( void );
793 /* Setting the cursor for a given window */
794 void fgSetCursor ( SFG_Window *window, int cursorID );
797 * Helper function to enumerate through all registered windows
798 * and one to enumerate all of a window's subwindows...
800 * The GFunc callback for those functions will be defined as:
802 * void enumCallback( gpointer window, gpointer enumerator );
804 * where window is the enumerated (sub)window pointer (SFG_Window *),
805 * and userData is the a custom user-supplied pointer. Functions
806 * are defined and exported from freeglut_structure.c file.
808 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
809 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
810 SFG_Enumerator* enumerator );
813 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
814 * first window in the queue matching the specified window handle.
815 * The function is defined in freeglut_structure.c file.
817 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
820 * This function is similiar to the previous one, except it is
821 * looking for a specified (sub)window identifier. The function
822 * is defined in freeglut_structure.c file.
824 SFG_Window* fgWindowByID( int windowID );
827 * Looks up a menu given its ID. This is easier than fgWindowByXXX
828 * as all menus are placed in a single doubly linked list...
830 SFG_Menu* fgMenuByID( int menuID );
833 * The menu activation and deactivation the code. This is the meat
834 * of the menu user interface handling code...
836 void fgUpdateMenuHighlight ( SFG_Menu *menu );
837 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
838 int mouse_x, int mouse_y );
839 void fgDeactivateMenu( SFG_Window *window );
842 * This function gets called just before the buffers swap, so that
843 * freeglut can display the pull-down menus via OpenGL. The function
844 * is defined in freeglut_menu.c file.
846 void fgDisplayMenu( void );
848 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
849 long fgElapsedTime( void );
852 void fgListInit(SFG_List *list);
853 void fgListAppend(SFG_List *list, SFG_Node *node);
854 void fgListRemove(SFG_List *list, SFG_Node *node);
855 int fgListLength(SFG_List *list);
856 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
858 /* Error Message functions */
859 void fgError( const char *fmt, ... );
860 void fgWarning( const char *fmt, ... );
862 #endif /* FREEGLUT_INTERNAL_H */
864 /*** END OF FILE ***/