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>
104 /* If GLX is too old, we will fail during runtime when multisampling
105 is requested, but at least freeglut compiles. */
106 # ifndef GLX_SAMPLE_BUFFERS
107 # define GLX_SAMPLE_BUFFERS 0x80A8
110 # define GLX_SAMPLES 0x80A9
115 /* These files should be available on every platform. */
121 /* These are included based on autoconf directives. */
123 # include <sys/types.h>
128 #if TIME_WITH_SYS_TIME
129 # include <sys/time.h>
131 #elif HAVE_SYS_TIME_H
132 # include <sys/time.h>
137 /* -- AUTOCONF HACKS --------------------------------------------------------*/
139 /* XXX: Update autoconf to avoid these.
140 * XXX: Are non-POSIX platforms intended not to use autoconf?
141 * If so, perhaps there should be a config_guess.h for them. Alternatively,
142 * config guesses could be placed above, just after the config.h exclusion.
144 #if defined(__FreeBSD__) || defined(__NetBSD__)
145 # define HAVE_USB_JS 1
146 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
147 # define HAVE_USBHID_H 1
151 #if TARGET_HOST_MS_WINDOWS
152 # define HAVE_VPRINTF 1
155 #if !defined(HAVE_VPRINTF) && !defined(HAVE_DOPRNT)
156 /* XXX warning directive here? */
157 # define HAVE_VPRINTF 1
160 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */
161 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)
162 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
163 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
165 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
167 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
171 #if defined(_MSC_VER) || defined(__WATCOMC__)
172 /* strdup() is non-standard, for all but POSIX-2001 */
173 #define strdup _strdup
176 /* M_PI is non-standard (defined by BSD, not ISO-C) */
178 # define M_PI 3.14159265358979323846
189 /* General defines */
191 #define INVALID_MODIFIERS 0xffffffff
193 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
195 /* Freeglut callbacks type definitions */
196 typedef void (* FGCBDisplay )( void );
197 typedef void (* FGCBReshape )( int, int );
198 typedef void (* FGCBVisibility )( int );
199 typedef void (* FGCBKeyboard )( unsigned char, int, int );
200 typedef void (* FGCBSpecial )( int, int, int );
201 typedef void (* FGCBMouse )( int, int, int, int );
202 typedef void (* FGCBMouseWheel )( int, int, int, int );
203 typedef void (* FGCBMotion )( int, int );
204 typedef void (* FGCBPassive )( int, int );
205 typedef void (* FGCBEntry )( int );
206 typedef void (* FGCBWindowStatus )( int );
207 typedef void (* FGCBSelect )( int, int, int );
208 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
209 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
210 typedef void (* FGCBSpecialUp )( int, int, int );
211 typedef void (* FGCBOverlayDisplay)( void );
212 typedef void (* FGCBSpaceMotion )( int, int, int );
213 typedef void (* FGCBSpaceRotation )( int, int, int );
214 typedef void (* FGCBSpaceButton )( int, int );
215 typedef void (* FGCBDials )( int, int );
216 typedef void (* FGCBButtonBox )( int, int );
217 typedef void (* FGCBTabletMotion )( int, int );
218 typedef void (* FGCBTabletButton )( int, int, int, int );
219 typedef void (* FGCBDestroy )( void );
221 /* The global callbacks type definitions */
222 typedef void (* FGCBIdle )( void );
223 typedef void (* FGCBTimer )( int );
224 typedef void (* FGCBMenuState )( int );
225 typedef void (* FGCBMenuStatus )( int, int, int );
227 /* The callback used when creating/using menus */
228 typedef void (* FGCBMenu )( int );
231 /* A list structure */
232 typedef struct tagSFG_List SFG_List;
239 /* A list node structure */
240 typedef struct tagSFG_Node SFG_Node;
247 /* A helper structure holding two ints and a boolean */
248 typedef struct tagSFG_XYUse SFG_XYUse;
251 GLint X, Y; /* The two integers... */
252 GLboolean Use; /* ...and a single boolean. */
256 * An enumeration containing the state of the GLUT execution:
257 * initializing, running, or stopping
261 GLUT_EXEC_STATE_INIT,
262 GLUT_EXEC_STATE_RUNNING,
266 /* This structure holds different freeglut settings */
267 typedef struct tagSFG_State SFG_State;
270 SFG_XYUse Position; /* The default windows' position */
271 SFG_XYUse Size; /* The default windows' size */
272 unsigned int DisplayMode; /* Display mode for new windows */
274 GLboolean Initialised; /* freeglut has been initialised */
276 int DirectContext; /* Direct rendering state */
278 GLboolean ForceIconic; /* New top windows are iconified */
279 GLboolean UseCurrentContext; /* New windows share with current */
281 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
282 GLboolean XSyncSwitch; /* X11 sync protocol switch */
284 int KeyRepeat; /* Global key repeat mode. */
285 int Modifiers; /* Current ALT/SHIFT/CTRL state */
287 GLuint FPSInterval; /* Interval between FPS printfs */
288 GLuint SwapCount; /* Count of glutSwapBuffer calls */
289 GLuint SwapTime; /* Time of last SwapBuffers */
291 unsigned long Time; /* Time that glutInit was called */
292 SFG_List Timers; /* The freeglut timer hooks */
293 SFG_List FreeTimers; /* The unused timer hooks */
295 FGCBIdle IdleCallback; /* The global idle callback */
297 int ActiveMenus; /* Num. of currently active menus */
298 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
299 FGCBMenuStatus MenuStatusCallback;
301 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
302 int GameModeDepth; /* The pixel depth for game mode */
303 int GameModeRefresh; /* The refresh rate for game mode */
305 int ActionOnWindowClose; /* Action when user closes window */
307 fgExecutionState ExecState; /* Used for GLUT termination */
308 char *ProgramName; /* Name of the invoking program */
309 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
310 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
312 int AuxiliaryBufferNumber; /* Number of auxiliary buffers */
313 int SampleNumber; /* Number of samples per pixel */
315 int MajorVersion; /* Major OpenGL context version */
316 int MinorVersion; /* Minor OpenGL context version */
317 int ContextFlags; /* OpenGL context flags */
320 /* The structure used by display initialization in freeglut_init.c */
321 typedef struct tagSFG_Display SFG_Display;
322 struct tagSFG_Display
324 #if TARGET_HOST_POSIX_X11
325 Display* Display; /* The display we are being run in. */
326 int Screen; /* The screen we are about to use. */
327 Window RootWindow; /* The screen's root window. */
328 int Connection; /* The display's connection number */
329 Atom DeleteWindow; /* The window deletion atom */
330 Atom State; /* The state atom */
331 Atom StateFullScreen; /* The full screen atom */
333 #ifdef X_XF86VidModeGetModeLine
335 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
336 * the validity of the VidMode has to be tracked
338 int DisplayModeValid; /* Flag that indicates runtime status*/
339 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
340 int DisplayModeClock; /* The display mode's refresh rate */
341 int DisplayViewPortX; /* saved X location of the viewport */
342 int DisplayViewPortY; /* saved Y location of the viewport */
343 int DisplayPointerX; /* saved X location of the pointer */
344 int DisplayPointerY; /* saved Y location of the pointer */
346 #endif /* X_XF86VidModeGetModeLine */
348 #elif TARGET_HOST_MS_WINDOWS
349 HINSTANCE Instance; /* The application's instance */
350 DEVMODE DisplayMode; /* Desktop's display settings */
354 int ScreenWidth; /* The screen's width in pixels */
355 int ScreenHeight; /* The screen's height in pixels */
356 int ScreenWidthMM; /* The screen's width in milimeters */
357 int ScreenHeightMM; /* The screen's height in milimeters */
361 /* The user can create any number of timer hooks */
362 typedef struct tagSFG_Timer SFG_Timer;
366 int ID; /* The timer ID integer */
367 FGCBTimer Callback; /* The timer callback */
368 long TriggerTime; /* The timer trigger time */
372 * Make "freeglut" window handle and context types so that we don't need so
373 * much conditionally-compiled code later in the library.
375 #if TARGET_HOST_POSIX_X11
377 typedef Window SFG_WindowHandleType ;
378 typedef GLXContext SFG_WindowContextType ;
380 #elif TARGET_HOST_MS_WINDOWS
382 typedef HWND SFG_WindowHandleType ;
383 typedef HGLRC SFG_WindowContextType ;
388 * A window and its OpenGL context. The contents of this structure
389 * are highly dependant on the target operating system we aim at...
391 typedef struct tagSFG_Context SFG_Context;
392 struct tagSFG_Context
394 SFG_WindowHandleType Handle; /* The window's handle */
395 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
397 #if TARGET_HOST_POSIX_X11
398 GLXFBConfig* FBConfig; /* The window's FBConfig */
399 #elif TARGET_HOST_MS_WINDOWS
400 HDC Device; /* The window's device context */
403 int DoubleBuffered; /* Treat the window as double-buffered */
406 /* Window's state description. This structure should be kept portable. */
407 typedef struct tagSFG_WindowState SFG_WindowState;
408 struct tagSFG_WindowState
410 int Width; /* Window's width in pixels */
411 int Height; /* The same about the height */
412 int OldWidth; /* Window width from before a resize */
413 int OldHeight; /* " height " " " " */
415 GLboolean Redisplay; /* Do we have to redisplay? */
416 GLboolean Visible; /* Is the window visible now */
418 int Cursor; /* The currently selected cursor */
420 long JoystickPollRate; /* The joystick polling rate */
421 long JoystickLastPoll; /* When the last poll happened */
423 int MouseX, MouseY; /* The most recent mouse position */
425 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
426 GLboolean KeyRepeating; /* Currently in repeat mode */
428 GLboolean NeedToResize; /* Do we need to resize the window? */
433 * A generic function pointer. We should really use the GLUTproc type
434 * defined in freeglut_ext.h, but if we include that header in this file
435 * a bunch of other stuff (font-related) blows up!
437 typedef void (*SFG_Proc)();
441 * SET_WCB() is used as:
443 * SET_WCB( window, cbname, func );
445 * ...where {window} is the freeglut window to set the callback,
446 * {cbname} is the window-specific callback to set,
447 * {func} is a function-pointer.
449 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
450 * but this can cause warnings because the FETCH_WCB() macro type-
451 * casts its result, and a type-cast value shouldn't be an lvalue.
453 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
454 * and for no other reason. Since it's hidden in the macro, the
455 * ugliness is felt to be rather benign.
457 #define SET_WCB(window,cbname,func) \
460 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
461 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
465 * FETCH_WCB() is used as:
467 * FETCH_WCB( window, cbname );
469 * ...where {window} is the freeglut window to fetch the callback from,
470 * {cbname} is the window-specific callback to fetch.
472 * The result is correctly type-cast to the callback function pointer
475 #define FETCH_WCB(window,cbname) \
476 ((window).CallBacks[CB_ ## cbname])
479 * INVOKE_WCB() is used as:
481 * INVOKE_WCB( window, cbname, ( arg_list ) );
483 * ...where {window} is the freeglut window,
484 * {cbname} is the window-specific callback to be invoked,
485 * {(arg_list)} is the parameter list.
487 * The callback is invoked as:
489 * callback( arg_list );
491 * ...so the parentheses are REQUIRED in the {arg_list}.
493 * NOTE that it does a sanity-check and also sets the
497 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
498 #define INVOKE_WCB(window,cbname,arg_list) \
501 if( FETCH_WCB( window, cbname ) ) \
503 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
504 fgSetWindow( &window ); \
509 #define INVOKE_WCB(window,cbname,arg_list) \
512 if( FETCH_WCB( window, cbname ) ) \
514 fgSetWindow( &window ); \
515 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
521 * The window callbacks the user can supply us with. Should be kept portable.
523 * This enumeration provides the freeglut CallBack numbers.
524 * The symbolic constants are indices into a window's array of
525 * function callbacks. The names are formed by splicing a common
526 * prefix onto the callback's base name. (This was originally
527 * done so that an early stage of development could live side-by-
528 * side with the old callback code. The old callback code used
529 * the bare callback's name as a structure member, so I used a
530 * prefix for the array index name.)
532 * XXX For consistancy, perhaps the prefix should match the
533 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
554 /* Presently ignored */
565 /* Always make this the LAST one */
570 /* This structure holds the OpenGL rendering context for all the menu windows */
571 typedef struct tagSFG_MenuContext SFG_MenuContext;
572 struct tagSFG_MenuContext
574 SFG_WindowContextType MContext; /* The menu window's WGL context */
577 /* This structure describes a menu */
578 typedef struct tagSFG_Window SFG_Window;
579 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
580 typedef struct tagSFG_Menu SFG_Menu;
584 void *UserData; /* User data passed back at callback */
585 int ID; /* The global menu ID */
586 SFG_List Entries; /* The menu entries list */
587 FGCBMenu Callback; /* The menu callback */
588 FGCBDestroy Destroy; /* Destruction callback */
589 GLboolean IsActive; /* Is the menu selected? */
590 int Width; /* Menu box width in pixels */
591 int Height; /* Menu box height in pixels */
592 int X, Y; /* Menu box raster position */
594 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
595 SFG_Window *Window; /* Window for menu */
596 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
599 /* This is a menu entry */
600 struct tagSFG_MenuEntry
603 int ID; /* The menu entry ID (local) */
604 int Ordinal; /* The menu's ordinal number */
605 char* Text; /* The text to be displayed */
606 SFG_Menu* SubMenu; /* Optional sub-menu tree */
607 GLboolean IsActive; /* Is the entry highlighted? */
608 int Width; /* Label's width in pixels */
612 * A window, making part of freeglut windows hierarchy.
613 * Should be kept portable.
615 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
620 int ID; /* Window's ID number */
622 SFG_Context Window; /* Window and OpenGL context */
623 SFG_WindowState State; /* The window state */
624 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
625 void *UserData ; /* For use by user */
627 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
628 SFG_Menu* ActiveMenu; /* The window's active menu */
630 SFG_Window* Parent; /* The parent to this window */
631 SFG_List Children; /* The subwindows d.l. list */
633 GLboolean IsMenu; /* Set to 1 if we are a menu */
637 /* A linked list structure of windows */
638 typedef struct tagSFG_WindowList SFG_WindowList ;
639 struct tagSFG_WindowList
645 /* This holds information about all the windows, menus etc. */
646 typedef struct tagSFG_Structure SFG_Structure;
647 struct tagSFG_Structure
649 SFG_List Windows; /* The global windows list */
650 SFG_List Menus; /* The global menus list */
651 SFG_List WindowsToDestroy;
653 SFG_Window* CurrentWindow; /* The currently set window */
654 SFG_Menu* CurrentMenu; /* Same, but menu... */
656 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
658 SFG_Window* GameModeWindow; /* The game mode window */
660 int WindowID; /* The new current window ID */
661 int MenuID; /* The new current menu ID */
665 * This structure is used for the enumeration purposes.
666 * You can easily extend its functionalities by declaring
667 * a structure containing enumerator's contents and custom
668 * data, then casting its pointer to (SFG_Enumerator *).
670 typedef struct tagSFG_Enumerator SFG_Enumerator;
671 struct tagSFG_Enumerator
673 GLboolean found; /* Used to terminate search */
674 void* data; /* Custom data pointer */
676 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
678 /* The bitmap font structure */
679 typedef struct tagSFG_Font SFG_Font;
682 char* Name; /* The source font name */
683 int Quantity; /* Number of chars in font */
684 int Height; /* Height of the characters */
685 const GLubyte** Characters; /* The characters mapping */
687 float xorig, yorig; /* Relative origin of the character */
690 /* The stroke font structures */
692 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
693 struct tagSFG_StrokeVertex
698 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
699 struct tagSFG_StrokeStrip
702 const SFG_StrokeVertex* Vertices;
705 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
706 struct tagSFG_StrokeChar
710 const SFG_StrokeStrip* Strips;
713 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
714 struct tagSFG_StrokeFont
716 char* Name; /* The source font name */
717 int Quantity; /* Number of chars in font */
718 GLfloat Height; /* Height of the characters */
719 const SFG_StrokeChar** Characters; /* The characters mapping */
722 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
724 /* Freeglut display related stuff (initialized once per session) */
725 extern SFG_Display fgDisplay;
727 /* Freeglut internal structure */
728 extern SFG_Structure fgStructure;
730 /* The current freeglut settings */
731 extern SFG_State fgState;
734 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
737 * A call to this function makes us sure that the Display and Structure
738 * subsystems have been properly initialized and are ready to be used
740 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
741 if ( ! fgState.Initialised ) \
743 fgError ( " ERROR: Function <%s> called" \
744 " without first calling 'glutInit'.", (string) ) ; \
747 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
748 if ( ! fgState.Initialised ) \
750 fgError ( " ERROR: Internal <%s> function called" \
751 " without first calling 'glutInit'.", (string) ) ; \
754 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
757 fgError ( " ERROR: Internal error <%s> in function %s", \
758 (string), (function) ) ; \
762 * Following definitions are somewhat similiar to GLib's,
763 * but do not generate any log messages:
765 #define freeglut_return_if_fail( expr ) \
768 #define freeglut_return_val_if_fail( expr, val ) \
773 * A call to those macros assures us that there is a current
774 * window set, respectively:
776 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
777 if ( ! fgStructure.CurrentWindow ) \
779 fgError ( " ERROR: Function <%s> called" \
780 " with no current window defined.", (string) ) ; \
784 * The deinitialize function gets called on glutMainLoop() end. It should clean up
785 * everything inside of the freeglut
787 void fgDeinitialize( void );
790 * Those two functions are used to create/destroy the freeglut internal
791 * structures. This actually happens when calling glutInit() and when
792 * quitting the glutMainLoop() (which actually happens, when all windows
795 void fgCreateStructure( void );
796 void fgDestroyStructure( void );
798 /* A helper function to check if a display mode is possible to use */
799 #if TARGET_HOST_POSIX_X11
800 GLXFBConfig* fgChooseFBConfig( void );
803 /* The window procedure for Win32 events handling */
804 #if TARGET_HOST_MS_WINDOWS
805 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
806 WPARAM wParam, LPARAM lParam );
807 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
808 unsigned char layer_type );
812 * Window creation, opening, closing and destruction.
813 * Also CallBack clearing/initialization.
814 * Defined in freeglut_structure.c, freeglut_window.c.
816 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
817 GLboolean positionUse, int x, int y,
818 GLboolean sizeUse, int w, int h,
819 GLboolean gameMode, GLboolean isMenu );
820 void fgSetWindow ( SFG_Window *window );
821 void fgOpenWindow( SFG_Window* window, const char* title,
822 GLboolean positionUse, int x, int y,
823 GLboolean sizeUse, int w, int h,
824 GLboolean gameMode, GLboolean isSubWindow );
825 void fgCloseWindow( SFG_Window* window );
826 void fgAddToWindowDestroyList ( SFG_Window* window );
827 void fgCloseWindows ();
828 void fgDestroyWindow( SFG_Window* window );
830 /* Menu creation and destruction. Defined in freeglut_structure.c */
831 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
832 void fgDestroyMenu( SFG_Menu* menu );
834 /* Joystick device management functions, defined in freeglut_joystick.c */
835 int fgJoystickDetect( void );
836 void fgInitialiseJoysticks( void );
837 void fgJoystickClose( void );
838 void fgJoystickPollWindow( SFG_Window* window );
840 /* InputDevice Initialisation and Closure */
841 int fgInputDeviceDetect( void );
842 void fgInitialiseInputDevices( void );
843 void fgInputDeviceClose( void );
845 /* Setting the cursor for a given window */
846 void fgSetCursor ( SFG_Window *window, int cursorID );
849 * Helper function to enumerate through all registered windows
850 * and one to enumerate all of a window's subwindows...
852 * The GFunc callback for those functions will be defined as:
854 * void enumCallback( gpointer window, gpointer enumerator );
856 * where window is the enumerated (sub)window pointer (SFG_Window *),
857 * and userData is the a custom user-supplied pointer. Functions
858 * are defined and exported from freeglut_structure.c file.
860 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
861 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
862 SFG_Enumerator* enumerator );
865 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
866 * first window in the queue matching the specified window handle.
867 * The function is defined in freeglut_structure.c file.
869 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
872 * This function is similiar to the previous one, except it is
873 * looking for a specified (sub)window identifier. The function
874 * is defined in freeglut_structure.c file.
876 SFG_Window* fgWindowByID( int windowID );
879 * Looks up a menu given its ID. This is easier than fgWindowByXXX
880 * as all menus are placed in a single doubly linked list...
882 SFG_Menu* fgMenuByID( int menuID );
885 * The menu activation and deactivation the code. This is the meat
886 * of the menu user interface handling code...
888 void fgUpdateMenuHighlight ( SFG_Menu *menu );
889 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
890 int mouse_x, int mouse_y );
891 void fgDeactivateMenu( SFG_Window *window );
894 * This function gets called just before the buffers swap, so that
895 * freeglut can display the pull-down menus via OpenGL. The function
896 * is defined in freeglut_menu.c file.
898 void fgDisplayMenu( void );
900 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
901 long fgElapsedTime( void );
903 /* System time in milliseconds */
904 long unsigned fgSystemTime(void);
907 void fgListInit(SFG_List *list);
908 void fgListAppend(SFG_List *list, SFG_Node *node);
909 void fgListRemove(SFG_List *list, SFG_Node *node);
910 int fgListLength(SFG_List *list);
911 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
913 /* Error Message functions */
914 void fgError( const char *fmt, ... );
915 void fgWarning( const char *fmt, ... );
918 * Check if "hint" is present in "property" for "window". See freeglut_init.c
920 #if TARGET_HOST_POSIX_X11
921 int fgHintPresent(Window window, Atom property, Atom hint);
924 SFG_Proc fghGetProcAddress( const char *procName );
926 #endif /* FREEGLUT_INTERNAL_H */
928 /*** END OF FILE ***/