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 intended to function under all Unix/X11 and Win32 platforms. */
41 /* XXX: Don't all MS-Windows compilers (except Cygwin) have _WIN32 defined?
42 * XXX: If so, remove the first set of defined()'s below.
44 #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__MINGW32__) \
45 || defined(_WIN32) || defined(_WIN32_WCE) \
46 || ( defined(__CYGWIN__) && defined(X_DISPLAY_MISSING) )
47 # define TARGET_HOST_MS_WINDOWS 1
49 #elif defined(__posix__) || defined(__unix__) || defined(__linux__)
50 # define TARGET_HOST_POSIX_X11 1
52 /* FIXME: no Macintosh support?
54 # define TARGET_HOST_MAC_OSX 1
56 # error "Unrecognized target host!"
60 #ifndef TARGET_HOST_MS_WINDOWS
61 # define TARGET_HOST_MS_WINDOWS 0
64 #ifndef TARGET_HOST_POSIX_X11
65 # define TARGET_HOST_POSIX_X11 0
68 #ifndef TARGET_HOST_MAC_OSX
69 # define TARGET_HOST_MAC_OSX 0
72 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
74 #define FREEGLUT_MAX_MENUS 3
76 /* -- PLATFORM-SPECIFIC INCLUDES ------------------------------------------- */
78 /* All Win32 headers depend on the huge Windows.h recursive include.
79 * Note: Let's use proper case for MS-Win headers. Even though it's
80 * not required due to case insensitivity, it's a good habit to keep
81 * because the cross-platform includes are case sensitive.
83 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE)
85 # include <WindowsX.h>
86 # include <MMSystem.h>
87 /* CYGWIN does not have tchar.h, but has TEXT(x), defined in winnt.h. */
91 # define _TEXT(x) TEXT(x)
92 # define _T(x) TEXT(x)
95 #elif TARGET_HOST_POSIX_X11
97 # include <X11/Xlib.h>
98 # include <X11/Xatom.h>
99 # include <X11/keysym.h>
100 # include <X11/extensions/XInput.h>
101 # ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
102 # include <X11/extensions/xf86vmode.h>
107 /* These files should be available on every platform. */
113 /* These are included based on autoconf directives. */
115 # include <sys/types.h>
120 #if TIME_WITH_SYS_TIME
121 # include <sys/time.h>
123 #elif HAVE_SYS_TIME_H
124 # include <sys/time.h>
129 /* -- AUTOCONF HACKS --------------------------------------------------------*/
131 /* XXX: Update autoconf to avoid these.
132 * XXX: Are non-POSIX platforms intended not to use autoconf?
133 * If so, perhaps there should be a config_guess.h for them. Alternatively,
134 * config guesses could be placed above, just after the config.h exclusion.
136 #if defined(__FreeBSD__) || defined(__NetBSD__)
137 # define HAVE_USB_JS 1
138 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
139 # define HAVE_USBHID_H 1
143 #if TARGET_HOST_MS_WINDOWS
144 # define HAVE_VPRINTF 1
147 #if !defined(HAVE_VPRINTF) && !defined(HAVE_DOPRNT)
148 /* XXX warning directive here? */
149 # define HAVE_VPRINTF 1
152 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */
153 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)
154 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
155 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
157 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
159 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
163 #if defined(_MSC_VER) || defined(__WATCOMC__)
164 /* strdup() is non-standard, for all but POSIX-2001 */
165 #define strdup _strdup
168 /* M_PI is non-standard (defined by BSD, not ISO-C) */
170 # define M_PI 3.14159265358979323846
181 /* General defines */
183 #define INVALID_MODIFIERS 0xffffffff
185 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
187 /* Freeglut callbacks type definitions */
188 typedef void (* FGCBDisplay )( void );
189 typedef void (* FGCBReshape )( int, int );
190 typedef void (* FGCBVisibility )( int );
191 typedef void (* FGCBKeyboard )( unsigned char, int, int );
192 typedef void (* FGCBSpecial )( int, int, int );
193 typedef void (* FGCBMouse )( int, int, int, int );
194 typedef void (* FGCBMouseWheel )( int, int, int, int );
195 typedef void (* FGCBMotion )( int, int );
196 typedef void (* FGCBPassive )( int, int );
197 typedef void (* FGCBEntry )( int );
198 typedef void (* FGCBWindowStatus )( int );
199 typedef void (* FGCBSelect )( int, int, int );
200 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
201 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
202 typedef void (* FGCBSpecialUp )( int, int, int );
203 typedef void (* FGCBOverlayDisplay)( void );
204 typedef void (* FGCBSpaceMotion )( int, int, int );
205 typedef void (* FGCBSpaceRotation )( int, int, int );
206 typedef void (* FGCBSpaceButton )( int, int );
207 typedef void (* FGCBDials )( int, int );
208 typedef void (* FGCBButtonBox )( int, int );
209 typedef void (* FGCBTabletMotion )( int, int );
210 typedef void (* FGCBTabletButton )( int, int, int, int );
211 typedef void (* FGCBDestroy )( void );
213 /* The global callbacks type definitions */
214 typedef void (* FGCBIdle )( void );
215 typedef void (* FGCBTimer )( int );
216 typedef void (* FGCBMenuState )( int );
217 typedef void (* FGCBMenuStatus )( int, int, int );
219 /* The callback used when creating/using menus */
220 typedef void (* FGCBMenu )( int );
223 /* A list structure */
224 typedef struct tagSFG_List SFG_List;
231 /* A list node structure */
232 typedef struct tagSFG_Node SFG_Node;
239 /* A helper structure holding two ints and a boolean */
240 typedef struct tagSFG_XYUse SFG_XYUse;
243 GLint X, Y; /* The two integers... */
244 GLboolean Use; /* ...and a single boolean. */
248 * An enumeration containing the state of the GLUT execution:
249 * initializing, running, or stopping
253 GLUT_EXEC_STATE_INIT,
254 GLUT_EXEC_STATE_RUNNING,
258 /* This structure holds different freeglut settings */
259 typedef struct tagSFG_State SFG_State;
262 SFG_XYUse Position; /* The default windows' position */
263 SFG_XYUse Size; /* The default windows' size */
264 unsigned int DisplayMode; /* Display mode for new windows */
266 GLboolean Initialised; /* freeglut has been initialised */
268 int DirectContext; /* Direct rendering state */
270 GLboolean ForceIconic; /* New top windows are iconified */
271 GLboolean UseCurrentContext; /* New windows share with current */
273 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
274 GLboolean XSyncSwitch; /* X11 sync protocol switch */
276 int KeyRepeat; /* Global key repeat mode. */
277 int Modifiers; /* Current ALT/SHIFT/CTRL state */
279 GLuint FPSInterval; /* Interval between FPS printfs */
280 GLuint SwapCount; /* Count of glutSwapBuffer calls */
281 GLuint SwapTime; /* Time of last SwapBuffers */
283 unsigned long Time; /* Time that glutInit was called */
284 SFG_List Timers; /* The freeglut timer hooks */
285 SFG_List FreeTimers; /* The unused timer hooks */
287 FGCBIdle IdleCallback; /* The global idle callback */
289 int ActiveMenus; /* Num. of currently active menus */
290 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
291 FGCBMenuStatus MenuStatusCallback;
293 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
294 int GameModeDepth; /* The pixel depth for game mode */
295 int GameModeRefresh; /* The refresh rate for game mode */
297 int ActionOnWindowClose; /* Action when user closes window */
299 fgExecutionState ExecState; /* Used for GLUT termination */
300 char *ProgramName; /* Name of the invoking program */
301 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
302 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
304 int AuxiliaryBufferNumber; /* Number of auxiliary buffers */
305 int SampleNumber; /* Number of samples per pixel */
307 int MajorVersion; /* Major OpenGL context version */
308 int MinorVersion; /* Minor OpenGL context version */
309 int ContextFlags; /* OpenGL context flags */
312 /* The structure used by display initialization in freeglut_init.c */
313 typedef struct tagSFG_Display SFG_Display;
314 struct tagSFG_Display
316 #if TARGET_HOST_POSIX_X11
317 Display* Display; /* The display we are being run in. */
318 int Screen; /* The screen we are about to use. */
319 Window RootWindow; /* The screen's root window. */
320 int Connection; /* The display's connection number */
321 Atom DeleteWindow; /* The window deletion atom */
322 Atom State; /* The state atom */
323 Atom StateFullScreen; /* The full screen atom */
325 #ifdef X_XF86VidModeGetModeLine
327 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
328 * the validity of the VidMode has to be tracked
330 int DisplayModeValid; /* Flag that indicates runtime status*/
331 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
332 int DisplayModeClock; /* The display mode's refresh rate */
333 int DisplayViewPortX; /* saved X location of the viewport */
334 int DisplayViewPortY; /* saved Y location of the viewport */
335 int DisplayPointerX; /* saved X location of the pointer */
336 int DisplayPointerY; /* saved Y location of the pointer */
338 #endif /* X_XF86VidModeGetModeLine */
340 #elif TARGET_HOST_MS_WINDOWS
341 HINSTANCE Instance; /* The application's instance */
342 DEVMODE DisplayMode; /* Desktop's display settings */
346 int ScreenWidth; /* The screen's width in pixels */
347 int ScreenHeight; /* The screen's height in pixels */
348 int ScreenWidthMM; /* The screen's width in milimeters */
349 int ScreenHeightMM; /* The screen's height in milimeters */
353 /* The user can create any number of timer hooks */
354 typedef struct tagSFG_Timer SFG_Timer;
358 int ID; /* The timer ID integer */
359 FGCBTimer Callback; /* The timer callback */
360 long TriggerTime; /* The timer trigger time */
364 * Make "freeglut" window handle and context types so that we don't need so
365 * much conditionally-compiled code later in the library.
367 #if TARGET_HOST_POSIX_X11
369 typedef Window SFG_WindowHandleType ;
370 typedef GLXContext SFG_WindowContextType ;
372 #elif TARGET_HOST_MS_WINDOWS
374 typedef HWND SFG_WindowHandleType ;
375 typedef HGLRC SFG_WindowContextType ;
380 * A window and its OpenGL context. The contents of this structure
381 * are highly dependant on the target operating system we aim at...
383 typedef struct tagSFG_Context SFG_Context;
384 struct tagSFG_Context
386 SFG_WindowHandleType Handle; /* The window's handle */
387 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
389 #if TARGET_HOST_POSIX_X11
390 GLXFBConfig* FBConfig; /* The window's FBConfig */
391 #elif TARGET_HOST_MS_WINDOWS
392 HDC Device; /* The window's device context */
395 int DoubleBuffered; /* Treat the window as double-buffered */
398 /* Window's state description. This structure should be kept portable. */
399 typedef struct tagSFG_WindowState SFG_WindowState;
400 struct tagSFG_WindowState
402 int Width; /* Window's width in pixels */
403 int Height; /* The same about the height */
404 int OldWidth; /* Window width from before a resize */
405 int OldHeight; /* " height " " " " */
407 GLboolean Redisplay; /* Do we have to redisplay? */
408 GLboolean Visible; /* Is the window visible now */
410 int Cursor; /* The currently selected cursor */
412 long JoystickPollRate; /* The joystick polling rate */
413 long JoystickLastPoll; /* When the last poll happened */
415 int MouseX, MouseY; /* The most recent mouse position */
417 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
418 GLboolean KeyRepeating; /* Currently in repeat mode */
420 GLboolean NeedToResize; /* Do we need to resize the window? */
425 * A generic function pointer. We should really use the GLUTproc type
426 * defined in freeglut_ext.h, but if we include that header in this file
427 * a bunch of other stuff (font-related) blows up!
429 typedef void (*SFG_Proc)();
433 * SET_WCB() is used as:
435 * SET_WCB( window, cbname, func );
437 * ...where {window} is the freeglut window to set the callback,
438 * {cbname} is the window-specific callback to set,
439 * {func} is a function-pointer.
441 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
442 * but this can cause warnings because the FETCH_WCB() macro type-
443 * casts its result, and a type-cast value shouldn't be an lvalue.
445 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
446 * and for no other reason. Since it's hidden in the macro, the
447 * ugliness is felt to be rather benign.
449 #define SET_WCB(window,cbname,func) \
452 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
453 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
457 * FETCH_WCB() is used as:
459 * FETCH_WCB( window, cbname );
461 * ...where {window} is the freeglut window to fetch the callback from,
462 * {cbname} is the window-specific callback to fetch.
464 * The result is correctly type-cast to the callback function pointer
467 #define FETCH_WCB(window,cbname) \
468 ((window).CallBacks[CB_ ## cbname])
471 * INVOKE_WCB() is used as:
473 * INVOKE_WCB( window, cbname, ( arg_list ) );
475 * ...where {window} is the freeglut window,
476 * {cbname} is the window-specific callback to be invoked,
477 * {(arg_list)} is the parameter list.
479 * The callback is invoked as:
481 * callback( arg_list );
483 * ...so the parentheses are REQUIRED in the {arg_list}.
485 * NOTE that it does a sanity-check and also sets the
489 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
490 #define INVOKE_WCB(window,cbname,arg_list) \
493 if( FETCH_WCB( window, cbname ) ) \
495 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
496 fgSetWindow( &window ); \
501 #define INVOKE_WCB(window,cbname,arg_list) \
504 if( FETCH_WCB( window, cbname ) ) \
506 fgSetWindow( &window ); \
507 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
513 * The window callbacks the user can supply us with. Should be kept portable.
515 * This enumeration provides the freeglut CallBack numbers.
516 * The symbolic constants are indices into a window's array of
517 * function callbacks. The names are formed by splicing a common
518 * prefix onto the callback's base name. (This was originally
519 * done so that an early stage of development could live side-by-
520 * side with the old callback code. The old callback code used
521 * the bare callback's name as a structure member, so I used a
522 * prefix for the array index name.)
524 * XXX For consistancy, perhaps the prefix should match the
525 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
546 /* Presently ignored */
557 /* Always make this the LAST one */
562 /* This structure holds the OpenGL rendering context for all the menu windows */
563 typedef struct tagSFG_MenuContext SFG_MenuContext;
564 struct tagSFG_MenuContext
566 SFG_WindowContextType MContext; /* The menu window's WGL context */
569 /* This structure describes a menu */
570 typedef struct tagSFG_Window SFG_Window;
571 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
572 typedef struct tagSFG_Menu SFG_Menu;
576 void *UserData; /* User data passed back at callback */
577 int ID; /* The global menu ID */
578 SFG_List Entries; /* The menu entries list */
579 FGCBMenu Callback; /* The menu callback */
580 FGCBDestroy Destroy; /* Destruction callback */
581 GLboolean IsActive; /* Is the menu selected? */
582 int Width; /* Menu box width in pixels */
583 int Height; /* Menu box height in pixels */
584 int X, Y; /* Menu box raster position */
586 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
587 SFG_Window *Window; /* Window for menu */
588 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
591 /* This is a menu entry */
592 struct tagSFG_MenuEntry
595 int ID; /* The menu entry ID (local) */
596 int Ordinal; /* The menu's ordinal number */
597 char* Text; /* The text to be displayed */
598 SFG_Menu* SubMenu; /* Optional sub-menu tree */
599 GLboolean IsActive; /* Is the entry highlighted? */
600 int Width; /* Label's width in pixels */
604 * A window, making part of freeglut windows hierarchy.
605 * Should be kept portable.
607 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
612 int ID; /* Window's ID number */
614 SFG_Context Window; /* Window and OpenGL context */
615 SFG_WindowState State; /* The window state */
616 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
617 void *UserData ; /* For use by user */
619 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
620 SFG_Menu* ActiveMenu; /* The window's active menu */
622 SFG_Window* Parent; /* The parent to this window */
623 SFG_List Children; /* The subwindows d.l. list */
625 GLboolean IsMenu; /* Set to 1 if we are a menu */
629 /* A linked list structure of windows */
630 typedef struct tagSFG_WindowList SFG_WindowList ;
631 struct tagSFG_WindowList
637 /* This holds information about all the windows, menus etc. */
638 typedef struct tagSFG_Structure SFG_Structure;
639 struct tagSFG_Structure
641 SFG_List Windows; /* The global windows list */
642 SFG_List Menus; /* The global menus list */
643 SFG_List WindowsToDestroy;
645 SFG_Window* CurrentWindow; /* The currently set window */
646 SFG_Menu* CurrentMenu; /* Same, but menu... */
648 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
650 SFG_Window* GameModeWindow; /* The game mode window */
652 int WindowID; /* The new current window ID */
653 int MenuID; /* The new current menu ID */
657 * This structure is used for the enumeration purposes.
658 * You can easily extend its functionalities by declaring
659 * a structure containing enumerator's contents and custom
660 * data, then casting its pointer to (SFG_Enumerator *).
662 typedef struct tagSFG_Enumerator SFG_Enumerator;
663 struct tagSFG_Enumerator
665 GLboolean found; /* Used to terminate search */
666 void* data; /* Custom data pointer */
668 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
670 /* The bitmap font structure */
671 typedef struct tagSFG_Font SFG_Font;
674 char* Name; /* The source font name */
675 int Quantity; /* Number of chars in font */
676 int Height; /* Height of the characters */
677 const GLubyte** Characters; /* The characters mapping */
679 float xorig, yorig; /* Relative origin of the character */
682 /* The stroke font structures */
684 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
685 struct tagSFG_StrokeVertex
690 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
691 struct tagSFG_StrokeStrip
694 const SFG_StrokeVertex* Vertices;
697 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
698 struct tagSFG_StrokeChar
702 const SFG_StrokeStrip* Strips;
705 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
706 struct tagSFG_StrokeFont
708 char* Name; /* The source font name */
709 int Quantity; /* Number of chars in font */
710 GLfloat Height; /* Height of the characters */
711 const SFG_StrokeChar** Characters; /* The characters mapping */
714 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
716 /* Freeglut display related stuff (initialized once per session) */
717 extern SFG_Display fgDisplay;
719 /* Freeglut internal structure */
720 extern SFG_Structure fgStructure;
722 /* The current freeglut settings */
723 extern SFG_State fgState;
726 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
729 * A call to this function makes us sure that the Display and Structure
730 * subsystems have been properly initialized and are ready to be used
732 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
733 if ( ! fgState.Initialised ) \
735 fgError ( " ERROR: Function <%s> called" \
736 " without first calling 'glutInit'.", (string) ) ; \
739 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
740 if ( ! fgState.Initialised ) \
742 fgError ( " ERROR: Internal <%s> function called" \
743 " without first calling 'glutInit'.", (string) ) ; \
746 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
749 fgError ( " ERROR: Internal error <%s> in function %s", \
750 (string), (function) ) ; \
754 * Following definitions are somewhat similiar to GLib's,
755 * but do not generate any log messages:
757 #define freeglut_return_if_fail( expr ) \
760 #define freeglut_return_val_if_fail( expr, val ) \
765 * A call to those macros assures us that there is a current
766 * window set, respectively:
768 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
769 if ( ! fgStructure.CurrentWindow ) \
771 fgError ( " ERROR: Function <%s> called" \
772 " with no current window defined.", (string) ) ; \
776 * The deinitialize function gets called on glutMainLoop() end. It should clean up
777 * everything inside of the freeglut
779 void fgDeinitialize( void );
782 * Those two functions are used to create/destroy the freeglut internal
783 * structures. This actually happens when calling glutInit() and when
784 * quitting the glutMainLoop() (which actually happens, when all windows
787 void fgCreateStructure( void );
788 void fgDestroyStructure( void );
790 /* A helper function to check if a display mode is possible to use */
791 #if TARGET_HOST_POSIX_X11
792 GLXFBConfig* fgChooseFBConfig( void );
795 /* The window procedure for Win32 events handling */
796 #if TARGET_HOST_MS_WINDOWS
797 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
798 WPARAM wParam, LPARAM lParam );
799 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
800 unsigned char layer_type );
804 * Window creation, opening, closing and destruction.
805 * Also CallBack clearing/initialization.
806 * Defined in freeglut_structure.c, freeglut_window.c.
808 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
809 GLboolean positionUse, int x, int y,
810 GLboolean sizeUse, int w, int h,
811 GLboolean gameMode, GLboolean isMenu );
812 void fgSetWindow ( SFG_Window *window );
813 void fgOpenWindow( SFG_Window* window, const char* title,
814 GLboolean positionUse, int x, int y,
815 GLboolean sizeUse, int w, int h,
816 GLboolean gameMode, GLboolean isSubWindow );
817 void fgCloseWindow( SFG_Window* window );
818 void fgAddToWindowDestroyList ( SFG_Window* window );
819 void fgCloseWindows ();
820 void fgDestroyWindow( SFG_Window* window );
822 /* Menu creation and destruction. Defined in freeglut_structure.c */
823 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
824 void fgDestroyMenu( SFG_Menu* menu );
826 /* Joystick device management functions, defined in freeglut_joystick.c */
827 int fgJoystickDetect( void );
828 void fgInitialiseJoysticks( void );
829 void fgJoystickClose( void );
830 void fgJoystickPollWindow( SFG_Window* window );
832 /* InputDevice Initialisation and Closure */
833 int fgInputDeviceDetect( void );
834 void fgInitialiseInputDevices( void );
835 void fgInputDeviceClose( void );
837 /* Setting the cursor for a given window */
838 void fgSetCursor ( SFG_Window *window, int cursorID );
841 * Helper function to enumerate through all registered windows
842 * and one to enumerate all of a window's subwindows...
844 * The GFunc callback for those functions will be defined as:
846 * void enumCallback( gpointer window, gpointer enumerator );
848 * where window is the enumerated (sub)window pointer (SFG_Window *),
849 * and userData is the a custom user-supplied pointer. Functions
850 * are defined and exported from freeglut_structure.c file.
852 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
853 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
854 SFG_Enumerator* enumerator );
857 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
858 * first window in the queue matching the specified window handle.
859 * The function is defined in freeglut_structure.c file.
861 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
864 * This function is similiar to the previous one, except it is
865 * looking for a specified (sub)window identifier. The function
866 * is defined in freeglut_structure.c file.
868 SFG_Window* fgWindowByID( int windowID );
871 * Looks up a menu given its ID. This is easier than fgWindowByXXX
872 * as all menus are placed in a single doubly linked list...
874 SFG_Menu* fgMenuByID( int menuID );
877 * The menu activation and deactivation the code. This is the meat
878 * of the menu user interface handling code...
880 void fgUpdateMenuHighlight ( SFG_Menu *menu );
881 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
882 int mouse_x, int mouse_y );
883 void fgDeactivateMenu( SFG_Window *window );
886 * This function gets called just before the buffers swap, so that
887 * freeglut can display the pull-down menus via OpenGL. The function
888 * is defined in freeglut_menu.c file.
890 void fgDisplayMenu( void );
892 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
893 long fgElapsedTime( void );
895 /* System time in milliseconds */
896 long unsigned fgSystemTime(void);
899 void fgListInit(SFG_List *list);
900 void fgListAppend(SFG_List *list, SFG_Node *node);
901 void fgListRemove(SFG_List *list, SFG_Node *node);
902 int fgListLength(SFG_List *list);
903 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
905 /* Error Message functions */
906 void fgError( const char *fmt, ... );
907 void fgWarning( const char *fmt, ... );
910 * Check if "hint" is present in "property" for "window". See freeglut_init.c
912 #if TARGET_HOST_POSIX_X11
913 int fgHintPresent(Window window, Atom property, Atom hint);
916 SFG_Proc fghGetProcAddress( const char *procName );
918 #endif /* FREEGLUT_INTERNAL_H */
920 /*** END OF FILE ***/