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 6
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 /* Detect both SunPro and gcc compilers on Sun Solaris */
61 #if defined (__SVR4) && defined (__sun)
62 # define TARGET_HOST_SOLARIS 1
65 #ifndef TARGET_HOST_MS_WINDOWS
66 # define TARGET_HOST_MS_WINDOWS 0
69 #ifndef TARGET_HOST_POSIX_X11
70 # define TARGET_HOST_POSIX_X11 0
73 #ifndef TARGET_HOST_MAC_OSX
74 # define TARGET_HOST_MAC_OSX 0
77 #ifndef TARGET_HOST_SOLARIS
78 # define TARGET_HOST_SOLARIS 0
81 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
83 #define FREEGLUT_MAX_MENUS 3
85 /* -- PLATFORM-SPECIFIC INCLUDES ------------------------------------------- */
87 /* All Win32 headers depend on the huge Windows.h recursive include.
88 * Note: Let's use proper case for MS-Win headers. Even though it's
89 * not required due to case insensitivity, it's a good habit to keep
90 * because the cross-platform includes are case sensitive.
92 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE)
94 # include <WindowsX.h>
95 # include <MMSystem.h>
96 /* CYGWIN does not have tchar.h, but has TEXT(x), defined in winnt.h. */
100 # define _TEXT(x) TEXT(x)
101 # define _T(x) TEXT(x)
104 #elif TARGET_HOST_POSIX_X11
106 # include <X11/Xlib.h>
107 # include <X11/Xatom.h>
108 # include <X11/keysym.h>
109 # include <X11/extensions/XInput.h>
110 # ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
111 # include <X11/extensions/xf86vmode.h>
113 /* If GLX is too old, we will fail during runtime when multisampling
114 is requested, but at least freeglut compiles. */
115 # ifndef GLX_SAMPLE_BUFFERS
116 # define GLX_SAMPLE_BUFFERS 0x80A8
119 # define GLX_SAMPLES 0x80A9
124 /* These files should be available on every platform. */
130 /* These are included based on autoconf directives. */
132 # include <sys/types.h>
137 #if TIME_WITH_SYS_TIME
138 # include <sys/time.h>
140 #elif HAVE_SYS_TIME_H
141 # include <sys/time.h>
146 /* -- AUTOCONF HACKS --------------------------------------------------------*/
148 /* XXX: Update autoconf to avoid these.
149 * XXX: Are non-POSIX platforms intended not to use autoconf?
150 * If so, perhaps there should be a config_guess.h for them. Alternatively,
151 * config guesses could be placed above, just after the config.h exclusion.
153 #if defined(__FreeBSD__) || defined(__NetBSD__)
154 # define HAVE_USB_JS 1
155 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
156 # define HAVE_USBHID_H 1
160 #if TARGET_HOST_MS_WINDOWS
161 # define HAVE_VPRINTF 1
164 #if !defined(HAVE_VPRINTF) && !defined(HAVE_DOPRNT)
165 /* XXX warning directive here? */
166 # define HAVE_VPRINTF 1
169 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */
170 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)
171 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
172 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
174 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
176 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
180 #if defined(_MSC_VER) || defined(__WATCOMC__)
181 /* strdup() is non-standard, for all but POSIX-2001 */
182 #define strdup _strdup
185 /* M_PI is non-standard (defined by BSD, not ISO-C) */
187 # define M_PI 3.14159265358979323846
198 /* General defines */
200 #define INVALID_MODIFIERS 0xffffffff
202 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
204 /* Freeglut callbacks type definitions */
205 typedef void (* FGCBDisplay )( void );
206 typedef void (* FGCBReshape )( int, int );
207 typedef void (* FGCBVisibility )( int );
208 typedef void (* FGCBKeyboard )( unsigned char, int, int );
209 typedef void (* FGCBSpecial )( int, int, int );
210 typedef void (* FGCBMouse )( int, int, int, int );
211 typedef void (* FGCBMouseWheel )( int, int, int, int );
212 typedef void (* FGCBMotion )( int, int );
213 typedef void (* FGCBPassive )( int, int );
214 typedef void (* FGCBEntry )( int );
215 typedef void (* FGCBWindowStatus )( int );
216 typedef void (* FGCBSelect )( int, int, int );
217 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
218 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
219 typedef void (* FGCBSpecialUp )( int, int, int );
220 typedef void (* FGCBOverlayDisplay)( void );
221 typedef void (* FGCBSpaceMotion )( int, int, int );
222 typedef void (* FGCBSpaceRotation )( int, int, int );
223 typedef void (* FGCBSpaceButton )( int, int );
224 typedef void (* FGCBDials )( int, int );
225 typedef void (* FGCBButtonBox )( int, int );
226 typedef void (* FGCBTabletMotion )( int, int );
227 typedef void (* FGCBTabletButton )( int, int, int, int );
228 typedef void (* FGCBDestroy )( void );
230 /* The global callbacks type definitions */
231 typedef void (* FGCBIdle )( void );
232 typedef void (* FGCBTimer )( int );
233 typedef void (* FGCBMenuState )( int );
234 typedef void (* FGCBMenuStatus )( int, int, int );
236 /* The callback used when creating/using menus */
237 typedef void (* FGCBMenu )( int );
240 /* A list structure */
241 typedef struct tagSFG_List SFG_List;
248 /* A list node structure */
249 typedef struct tagSFG_Node SFG_Node;
256 /* A helper structure holding two ints and a boolean */
257 typedef struct tagSFG_XYUse SFG_XYUse;
260 GLint X, Y; /* The two integers... */
261 GLboolean Use; /* ...and a single boolean. */
265 * An enumeration containing the state of the GLUT execution:
266 * initializing, running, or stopping
270 GLUT_EXEC_STATE_INIT,
271 GLUT_EXEC_STATE_RUNNING,
275 /* This structure holds different freeglut settings */
276 typedef struct tagSFG_State SFG_State;
279 SFG_XYUse Position; /* The default windows' position */
280 SFG_XYUse Size; /* The default windows' size */
281 unsigned int DisplayMode; /* Display mode for new windows */
283 GLboolean Initialised; /* freeglut has been initialised */
285 int DirectContext; /* Direct rendering state */
287 GLboolean ForceIconic; /* New top windows are iconified */
288 GLboolean UseCurrentContext; /* New windows share with current */
290 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
291 GLboolean XSyncSwitch; /* X11 sync protocol switch */
293 int KeyRepeat; /* Global key repeat mode. */
294 int Modifiers; /* Current ALT/SHIFT/CTRL state */
296 GLuint FPSInterval; /* Interval between FPS printfs */
297 GLuint SwapCount; /* Count of glutSwapBuffer calls */
298 GLuint SwapTime; /* Time of last SwapBuffers */
300 unsigned long Time; /* Time that glutInit was called */
301 SFG_List Timers; /* The freeglut timer hooks */
302 SFG_List FreeTimers; /* The unused timer hooks */
304 FGCBIdle IdleCallback; /* The global idle callback */
306 int ActiveMenus; /* Num. of currently active menus */
307 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
308 FGCBMenuStatus MenuStatusCallback;
310 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
311 int GameModeDepth; /* The pixel depth for game mode */
312 int GameModeRefresh; /* The refresh rate for game mode */
314 int ActionOnWindowClose; /* Action when user closes window */
316 fgExecutionState ExecState; /* Used for GLUT termination */
317 char *ProgramName; /* Name of the invoking program */
318 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
319 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
321 int AuxiliaryBufferNumber; /* Number of auxiliary buffers */
322 int SampleNumber; /* Number of samples per pixel */
324 int MajorVersion; /* Major OpenGL context version */
325 int MinorVersion; /* Minor OpenGL context version */
326 int ContextFlags; /* OpenGL context flags */
327 int ContextProfile; /* OpenGL context profile */
330 /* The structure used by display initialization in freeglut_init.c */
331 typedef struct tagSFG_Display SFG_Display;
332 struct tagSFG_Display
334 #if TARGET_HOST_POSIX_X11
335 Display* Display; /* The display we are being run in. */
336 int Screen; /* The screen we are about to use. */
337 Window RootWindow; /* The screen's root window. */
338 int Connection; /* The display's connection number */
339 Atom DeleteWindow; /* The window deletion atom */
340 Atom State; /* The state atom */
341 Atom StateFullScreen; /* The full screen atom */
343 #ifdef X_XF86VidModeGetModeLine
345 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
346 * the validity of the VidMode has to be tracked
348 int DisplayModeValid; /* Flag that indicates runtime status*/
349 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
350 int DisplayModeClock; /* The display mode's refresh rate */
351 int DisplayViewPortX; /* saved X location of the viewport */
352 int DisplayViewPortY; /* saved Y location of the viewport */
353 int DisplayPointerX; /* saved X location of the pointer */
354 int DisplayPointerY; /* saved Y location of the pointer */
356 #endif /* X_XF86VidModeGetModeLine */
358 #elif TARGET_HOST_MS_WINDOWS
359 HINSTANCE Instance; /* The application's instance */
360 DEVMODE DisplayMode; /* Desktop's display settings */
364 int ScreenWidth; /* The screen's width in pixels */
365 int ScreenHeight; /* The screen's height in pixels */
366 int ScreenWidthMM; /* The screen's width in milimeters */
367 int ScreenHeightMM; /* The screen's height in milimeters */
371 /* The user can create any number of timer hooks */
372 typedef struct tagSFG_Timer SFG_Timer;
376 int ID; /* The timer ID integer */
377 FGCBTimer Callback; /* The timer callback */
378 long TriggerTime; /* The timer trigger time */
382 * Make "freeglut" window handle and context types so that we don't need so
383 * much conditionally-compiled code later in the library.
385 #if TARGET_HOST_POSIX_X11
387 typedef Window SFG_WindowHandleType ;
388 typedef GLXContext SFG_WindowContextType ;
390 #elif TARGET_HOST_MS_WINDOWS
392 typedef HWND SFG_WindowHandleType ;
393 typedef HGLRC SFG_WindowContextType ;
398 * A window and its OpenGL context. The contents of this structure
399 * are highly dependant on the target operating system we aim at...
401 typedef struct tagSFG_Context SFG_Context;
402 struct tagSFG_Context
404 SFG_WindowHandleType Handle; /* The window's handle */
405 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
407 #if TARGET_HOST_POSIX_X11
408 GLXFBConfig* FBConfig; /* The window's FBConfig */
409 #elif TARGET_HOST_MS_WINDOWS
410 HDC Device; /* The window's device context */
413 int DoubleBuffered; /* Treat the window as double-buffered */
416 /* Window's state description. This structure should be kept portable. */
417 typedef struct tagSFG_WindowState SFG_WindowState;
418 struct tagSFG_WindowState
420 int Width; /* Window's width in pixels */
421 int Height; /* The same about the height */
422 int OldWidth; /* Window width from before a resize */
423 int OldHeight; /* " height " " " " */
425 GLboolean Redisplay; /* Do we have to redisplay? */
426 GLboolean Visible; /* Is the window visible now */
428 int Cursor; /* The currently selected cursor */
430 long JoystickPollRate; /* The joystick polling rate */
431 long JoystickLastPoll; /* When the last poll happened */
433 int MouseX, MouseY; /* The most recent mouse position */
435 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
436 GLboolean KeyRepeating; /* Currently in repeat mode */
438 GLboolean NeedToResize; /* Do we need to resize the window? */
443 * A generic function pointer. We should really use the GLUTproc type
444 * defined in freeglut_ext.h, but if we include that header in this file
445 * a bunch of other stuff (font-related) blows up!
447 typedef void (*SFG_Proc)();
451 * SET_WCB() is used as:
453 * SET_WCB( window, cbname, func );
455 * ...where {window} is the freeglut window to set the callback,
456 * {cbname} is the window-specific callback to set,
457 * {func} is a function-pointer.
459 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
460 * but this can cause warnings because the FETCH_WCB() macro type-
461 * casts its result, and a type-cast value shouldn't be an lvalue.
463 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
464 * and for no other reason. Since it's hidden in the macro, the
465 * ugliness is felt to be rather benign.
467 #define SET_WCB(window,cbname,func) \
470 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
471 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
475 * FETCH_WCB() is used as:
477 * FETCH_WCB( window, cbname );
479 * ...where {window} is the freeglut window to fetch the callback from,
480 * {cbname} is the window-specific callback to fetch.
482 * The result is correctly type-cast to the callback function pointer
485 #define FETCH_WCB(window,cbname) \
486 ((window).CallBacks[CB_ ## cbname])
489 * INVOKE_WCB() is used as:
491 * INVOKE_WCB( window, cbname, ( arg_list ) );
493 * ...where {window} is the freeglut window,
494 * {cbname} is the window-specific callback to be invoked,
495 * {(arg_list)} is the parameter list.
497 * The callback is invoked as:
499 * callback( arg_list );
501 * ...so the parentheses are REQUIRED in the {arg_list}.
503 * NOTE that it does a sanity-check and also sets the
507 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
508 #define INVOKE_WCB(window,cbname,arg_list) \
511 if( FETCH_WCB( window, cbname ) ) \
513 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
514 fgSetWindow( &window ); \
519 #define INVOKE_WCB(window,cbname,arg_list) \
522 if( FETCH_WCB( window, cbname ) ) \
524 fgSetWindow( &window ); \
525 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
531 * The window callbacks the user can supply us with. Should be kept portable.
533 * This enumeration provides the freeglut CallBack numbers.
534 * The symbolic constants are indices into a window's array of
535 * function callbacks. The names are formed by splicing a common
536 * prefix onto the callback's base name. (This was originally
537 * done so that an early stage of development could live side-by-
538 * side with the old callback code. The old callback code used
539 * the bare callback's name as a structure member, so I used a
540 * prefix for the array index name.)
542 * XXX For consistancy, perhaps the prefix should match the
543 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
564 /* Presently ignored */
567 CB_SpaceMotion, /* presently implemented only on UNIX/X11 */
568 CB_SpaceRotation, /* presently implemented only on UNIX/X11 */
569 CB_SpaceButton, /* presently implemented only on UNIX/X11 */
575 /* Always make this the LAST one */
580 /* This structure holds the OpenGL rendering context for all the menu windows */
581 typedef struct tagSFG_MenuContext SFG_MenuContext;
582 struct tagSFG_MenuContext
584 SFG_WindowContextType MContext; /* The menu window's WGL context */
587 /* This structure describes a menu */
588 typedef struct tagSFG_Window SFG_Window;
589 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
590 typedef struct tagSFG_Menu SFG_Menu;
594 void *UserData; /* User data passed back at callback */
595 int ID; /* The global menu ID */
596 SFG_List Entries; /* The menu entries list */
597 FGCBMenu Callback; /* The menu callback */
598 FGCBDestroy Destroy; /* Destruction callback */
599 GLboolean IsActive; /* Is the menu selected? */
600 int Width; /* Menu box width in pixels */
601 int Height; /* Menu box height in pixels */
602 int X, Y; /* Menu box raster position */
604 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
605 SFG_Window *Window; /* Window for menu */
606 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
609 /* This is a menu entry */
610 struct tagSFG_MenuEntry
613 int ID; /* The menu entry ID (local) */
614 int Ordinal; /* The menu's ordinal number */
615 char* Text; /* The text to be displayed */
616 SFG_Menu* SubMenu; /* Optional sub-menu tree */
617 GLboolean IsActive; /* Is the entry highlighted? */
618 int Width; /* Label's width in pixels */
622 * A window, making part of freeglut windows hierarchy.
623 * Should be kept portable.
625 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
630 int ID; /* Window's ID number */
632 SFG_Context Window; /* Window and OpenGL context */
633 SFG_WindowState State; /* The window state */
634 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
635 void *UserData ; /* For use by user */
637 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
638 SFG_Menu* ActiveMenu; /* The window's active menu */
640 SFG_Window* Parent; /* The parent to this window */
641 SFG_List Children; /* The subwindows d.l. list */
643 GLboolean IsMenu; /* Set to 1 if we are a menu */
647 /* A linked list structure of windows */
648 typedef struct tagSFG_WindowList SFG_WindowList ;
649 struct tagSFG_WindowList
655 /* This holds information about all the windows, menus etc. */
656 typedef struct tagSFG_Structure SFG_Structure;
657 struct tagSFG_Structure
659 SFG_List Windows; /* The global windows list */
660 SFG_List Menus; /* The global menus list */
661 SFG_List WindowsToDestroy;
663 SFG_Window* CurrentWindow; /* The currently set window */
664 SFG_Menu* CurrentMenu; /* Same, but menu... */
666 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
668 SFG_Window* GameModeWindow; /* The game mode window */
670 int WindowID; /* The new current window ID */
671 int MenuID; /* The new current menu ID */
675 * This structure is used for the enumeration purposes.
676 * You can easily extend its functionalities by declaring
677 * a structure containing enumerator's contents and custom
678 * data, then casting its pointer to (SFG_Enumerator *).
680 typedef struct tagSFG_Enumerator SFG_Enumerator;
681 struct tagSFG_Enumerator
683 GLboolean found; /* Used to terminate search */
684 void* data; /* Custom data pointer */
686 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
688 /* The bitmap font structure */
689 typedef struct tagSFG_Font SFG_Font;
692 char* Name; /* The source font name */
693 int Quantity; /* Number of chars in font */
694 int Height; /* Height of the characters */
695 const GLubyte** Characters; /* The characters mapping */
697 float xorig, yorig; /* Relative origin of the character */
700 /* The stroke font structures */
702 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
703 struct tagSFG_StrokeVertex
708 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
709 struct tagSFG_StrokeStrip
712 const SFG_StrokeVertex* Vertices;
715 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
716 struct tagSFG_StrokeChar
720 const SFG_StrokeStrip* Strips;
723 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
724 struct tagSFG_StrokeFont
726 char* Name; /* The source font name */
727 int Quantity; /* Number of chars in font */
728 GLfloat Height; /* Height of the characters */
729 const SFG_StrokeChar** Characters; /* The characters mapping */
732 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
734 /* Freeglut display related stuff (initialized once per session) */
735 extern SFG_Display fgDisplay;
737 /* Freeglut internal structure */
738 extern SFG_Structure fgStructure;
740 /* The current freeglut settings */
741 extern SFG_State fgState;
744 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
747 * A call to this function makes us sure that the Display and Structure
748 * subsystems have been properly initialized and are ready to be used
750 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
751 if ( ! fgState.Initialised ) \
753 fgError ( " ERROR: Function <%s> called" \
754 " without first calling 'glutInit'.", (string) ) ; \
757 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
758 if ( ! fgState.Initialised ) \
760 fgError ( " ERROR: Internal <%s> function called" \
761 " without first calling 'glutInit'.", (string) ) ; \
764 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
767 fgError ( " ERROR: Internal error <%s> in function %s", \
768 (string), (function) ) ; \
772 * Following definitions are somewhat similiar to GLib's,
773 * but do not generate any log messages:
775 #define freeglut_return_if_fail( expr ) \
778 #define freeglut_return_val_if_fail( expr, val ) \
783 * A call to those macros assures us that there is a current
784 * window set, respectively:
786 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
787 if ( ! fgStructure.CurrentWindow ) \
789 fgError ( " ERROR: Function <%s> called" \
790 " with no current window defined.", (string) ) ; \
794 * The deinitialize function gets called on glutMainLoop() end. It should clean up
795 * everything inside of the freeglut
797 void fgDeinitialize( void );
800 * Those two functions are used to create/destroy the freeglut internal
801 * structures. This actually happens when calling glutInit() and when
802 * quitting the glutMainLoop() (which actually happens, when all windows
805 void fgCreateStructure( void );
806 void fgDestroyStructure( void );
808 /* A helper function to check if a display mode is possible to use */
809 #if TARGET_HOST_POSIX_X11
810 GLXFBConfig* fgChooseFBConfig( void );
813 /* The window procedure for Win32 events handling */
814 #if TARGET_HOST_MS_WINDOWS
815 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
816 WPARAM wParam, LPARAM lParam );
817 void fgNewWGLCreateContext( SFG_Window* window );
818 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
819 unsigned char layer_type );
823 * Window creation, opening, closing and destruction.
824 * Also CallBack clearing/initialization.
825 * Defined in freeglut_structure.c, freeglut_window.c.
827 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
828 GLboolean positionUse, int x, int y,
829 GLboolean sizeUse, int w, int h,
830 GLboolean gameMode, GLboolean isMenu );
831 void fgSetWindow ( SFG_Window *window );
832 void fgOpenWindow( SFG_Window* window, const char* title,
833 GLboolean positionUse, int x, int y,
834 GLboolean sizeUse, int w, int h,
835 GLboolean gameMode, GLboolean isSubWindow );
836 void fgCloseWindow( SFG_Window* window );
837 void fgAddToWindowDestroyList ( SFG_Window* window );
838 void fgCloseWindows ();
839 void fgDestroyWindow( SFG_Window* window );
841 /* Menu creation and destruction. Defined in freeglut_structure.c */
842 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
843 void fgDestroyMenu( SFG_Menu* menu );
845 /* Joystick device management functions, defined in freeglut_joystick.c */
846 int fgJoystickDetect( void );
847 void fgInitialiseJoysticks( void );
848 void fgJoystickClose( void );
849 void fgJoystickPollWindow( SFG_Window* window );
851 /* InputDevice Initialisation and Closure */
852 int fgInputDeviceDetect( void );
853 void fgInitialiseInputDevices( void );
854 void fgInputDeviceClose( void );
856 /* spaceball device functions, defined in freeglut_spaceball.c */
857 void fgInitialiseSpaceball( void );
858 void fgSpaceballClose( void );
859 void fgSpaceballSetWindow( SFG_Window *window );
861 int fgHasSpaceball( void );
862 int fgSpaceballNumButtons( void );
864 #if TARGET_HOST_POSIX_X11
865 int fgIsSpaceballXEvent( const XEvent *ev );
866 void fgSpaceballHandleXEvent( const XEvent *ev );
869 /* Setting the cursor for a given window */
870 void fgSetCursor ( SFG_Window *window, int cursorID );
873 * Helper function to enumerate through all registered windows
874 * and one to enumerate all of a window's subwindows...
876 * The GFunc callback for those functions will be defined as:
878 * void enumCallback( gpointer window, gpointer enumerator );
880 * where window is the enumerated (sub)window pointer (SFG_Window *),
881 * and userData is the a custom user-supplied pointer. Functions
882 * are defined and exported from freeglut_structure.c file.
884 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
885 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
886 SFG_Enumerator* enumerator );
889 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
890 * first window in the queue matching the specified window handle.
891 * The function is defined in freeglut_structure.c file.
893 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
896 * This function is similiar to the previous one, except it is
897 * looking for a specified (sub)window identifier. The function
898 * is defined in freeglut_structure.c file.
900 SFG_Window* fgWindowByID( int windowID );
903 * Looks up a menu given its ID. This is easier than fgWindowByXXX
904 * as all menus are placed in a single doubly linked list...
906 SFG_Menu* fgMenuByID( int menuID );
909 * The menu activation and deactivation the code. This is the meat
910 * of the menu user interface handling code...
912 void fgUpdateMenuHighlight ( SFG_Menu *menu );
913 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
914 int mouse_x, int mouse_y );
915 void fgDeactivateMenu( SFG_Window *window );
918 * This function gets called just before the buffers swap, so that
919 * freeglut can display the pull-down menus via OpenGL. The function
920 * is defined in freeglut_menu.c file.
922 void fgDisplayMenu( void );
924 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
925 long fgElapsedTime( void );
927 /* System time in milliseconds */
928 long unsigned fgSystemTime(void);
931 void fgListInit(SFG_List *list);
932 void fgListAppend(SFG_List *list, SFG_Node *node);
933 void fgListRemove(SFG_List *list, SFG_Node *node);
934 int fgListLength(SFG_List *list);
935 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
937 /* Error Message functions */
938 void fgError( const char *fmt, ... );
939 void fgWarning( const char *fmt, ... );
942 * Check if "hint" is present in "property" for "window". See freeglut_init.c
944 #if TARGET_HOST_POSIX_X11
945 int fgHintPresent(Window window, Atom property, Atom hint);
948 SFG_Proc fghGetProcAddress( const char *procName );
950 #if TARGET_HOST_MS_WINDOWS
951 extern void (__cdecl *__glutExitFunc)( int return_value );
954 #endif /* FREEGLUT_INTERNAL_H */
956 /*** END OF FILE ***/