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. */
115 /* These are included based on autoconf directives. */
117 # include <sys/types.h>
122 #if TIME_WITH_SYS_TIME
123 # include <sys/time.h>
125 #elif HAVE_SYS_TIME_H
126 # include <sys/time.h>
131 /* -- AUTOCONF HACKS --------------------------------------------------------*/
133 /* XXX: Update autoconf to avoid these.
134 * XXX: Are non-POSIX platforms intended not to use autoconf?
135 * If so, perhaps there should be a config_guess.h for them. Alternatively,
136 * config guesses could be placed above, just after the config.h exclusion.
138 #if defined(__FreeBSD__) || defined(__NetBSD__)
139 # define HAVE_USB_JS 1
140 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
141 # define HAVE_USBHID_H 1
145 #if TARGET_HOST_MS_WINDOWS
146 # define HAVE_VPRINTF 1
149 #if !defined(HAVE_VPRINTF) && !defined(HAVE_DOPRNT)
150 /* XXX warning directive here? */
151 # define HAVE_VPRINTF 1
154 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */
155 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)
156 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
157 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
159 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
161 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
165 #if defined(_MSC_VER) || defined(__WATCOMC__)
166 /* strdup() is non-standard, for all but POSIX-2001 */
167 #define strdup _strdup
170 /* M_PI is non-standard (defined by BSD, not ISO-C) */
172 # define M_PI 3.14159265358979323846
183 /* General defines */
185 #define INVALID_MODIFIERS 0xffffffff
187 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
189 /* Freeglut callbacks type definitions */
190 typedef void (* FGCBDisplay )( void );
191 typedef void (* FGCBReshape )( int, int );
192 typedef void (* FGCBVisibility )( int );
193 typedef void (* FGCBKeyboard )( unsigned char, int, int );
194 typedef void (* FGCBSpecial )( int, int, int );
195 typedef void (* FGCBMouse )( int, int, int, int );
196 typedef void (* FGCBMouseWheel )( int, int, int, int );
197 typedef void (* FGCBMotion )( int, int );
198 typedef void (* FGCBPassive )( int, int );
199 typedef void (* FGCBEntry )( int );
200 typedef void (* FGCBWindowStatus )( int );
201 typedef void (* FGCBSelect )( int, int, int );
202 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
203 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
204 typedef void (* FGCBSpecialUp )( int, int, int );
205 typedef void (* FGCBOverlayDisplay)( void );
206 typedef void (* FGCBSpaceMotion )( int, int, int );
207 typedef void (* FGCBSpaceRotation )( int, int, int );
208 typedef void (* FGCBSpaceButton )( int, int );
209 typedef void (* FGCBDials )( int, int );
210 typedef void (* FGCBButtonBox )( int, int );
211 typedef void (* FGCBTabletMotion )( int, int );
212 typedef void (* FGCBTabletButton )( int, int, int, int );
213 typedef void (* FGCBDestroy )( void );
215 /* The global callbacks type definitions */
216 typedef void (* FGCBIdle )( void );
217 typedef void (* FGCBTimer )( int );
218 typedef void (* FGCBMenuState )( int );
219 typedef void (* FGCBMenuStatus )( int, int, int );
221 /* The callback used when creating/using menus */
222 typedef void (* FGCBMenu )( int );
225 /* A list structure */
226 typedef struct tagSFG_List SFG_List;
233 /* A list node structure */
234 typedef struct tagSFG_Node SFG_Node;
241 /* A helper structure holding two ints and a boolean */
242 typedef struct tagSFG_XYUse SFG_XYUse;
245 GLint X, Y; /* The two integers... */
246 GLboolean Use; /* ...and a single boolean. */
250 * An enumeration containing the state of the GLUT execution:
251 * initializing, running, or stopping
255 GLUT_EXEC_STATE_INIT,
256 GLUT_EXEC_STATE_RUNNING,
260 /* This structure holds different freeglut settings */
261 typedef struct tagSFG_State SFG_State;
264 SFG_XYUse Position; /* The default windows' position */
265 SFG_XYUse Size; /* The default windows' size */
266 unsigned int DisplayMode; /* Display mode for new windows */
268 GLboolean Initialised; /* freeglut has been initialised */
270 int DirectContext; /* Direct rendering state */
272 GLboolean ForceIconic; /* New top windows are iconified */
273 GLboolean UseCurrentContext; /* New windows share with current */
275 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
276 GLboolean XSyncSwitch; /* X11 sync protocol switch */
278 int KeyRepeat; /* Global key repeat mode. */
279 int Modifiers; /* Current ALT/SHIFT/CTRL state */
281 GLuint FPSInterval; /* Interval between FPS printfs */
282 GLuint SwapCount; /* Count of glutSwapBuffer calls */
283 GLuint SwapTime; /* Time of last SwapBuffers */
285 unsigned long Time; /* Time that glutInit was called */
286 SFG_List Timers; /* The freeglut timer hooks */
287 SFG_List FreeTimers; /* The unused timer hooks */
289 FGCBIdle IdleCallback; /* The global idle callback */
291 int ActiveMenus; /* Num. of currently active menus */
292 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
293 FGCBMenuStatus MenuStatusCallback;
295 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
296 int GameModeDepth; /* The pixel depth for game mode */
297 int GameModeRefresh; /* The refresh rate for game mode */
299 int ActionOnWindowClose; /* Action when user closes window */
301 fgExecutionState ExecState; /* Used for GLUT termination */
302 char *ProgramName; /* Name of the invoking program */
303 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
304 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
307 /* The structure used by display initialization in freeglut_init.c */
308 typedef struct tagSFG_Display SFG_Display;
309 struct tagSFG_Display
311 #if TARGET_HOST_POSIX_X11
312 Display* Display; /* The display we are being run in. */
313 int Screen; /* The screen we are about to use. */
314 Window RootWindow; /* The screen's root window. */
315 int Connection; /* The display's connection number */
316 Atom DeleteWindow; /* The window deletion atom */
318 #ifdef X_XF86VidModeGetModeLine
320 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
321 * the validity of the VidMode has to be tracked
323 int DisplayModeValid; /* Flag that indicates runtime status*/
324 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
325 int DisplayModeClock; /* The display mode's refresh rate */
326 int DisplayViewPortX; /* saved X location of the viewport */
327 int DisplayViewPortY; /* saved Y location of the viewport */
328 int DisplayPointerX; /* saved X location of the pointer */
329 int DisplayPointerY; /* saved Y location of the pointer */
331 #endif /* X_XF86VidModeGetModeLine */
333 #elif TARGET_HOST_MS_WINDOWS
334 HINSTANCE Instance; /* The application's instance */
335 DEVMODE DisplayMode; /* Desktop's display settings */
339 int ScreenWidth; /* The screen's width in pixels */
340 int ScreenHeight; /* The screen's height in pixels */
341 int ScreenWidthMM; /* The screen's width in milimeters */
342 int ScreenHeightMM; /* The screen's height in milimeters */
346 /* The user can create any number of timer hooks */
347 typedef struct tagSFG_Timer SFG_Timer;
351 int ID; /* The timer ID integer */
352 FGCBTimer Callback; /* The timer callback */
353 long TriggerTime; /* The timer trigger time */
357 * Make "freeglut" window handle and context types so that we don't need so
358 * much conditionally-compiled code later in the library.
360 #if TARGET_HOST_POSIX_X11
362 typedef Window SFG_WindowHandleType ;
363 typedef GLXContext SFG_WindowContextType ;
365 #elif TARGET_HOST_MS_WINDOWS
367 typedef HWND SFG_WindowHandleType ;
368 typedef HGLRC SFG_WindowContextType ;
373 * A window and its OpenGL context. The contents of this structure
374 * are highly dependant on the target operating system we aim at...
376 typedef struct tagSFG_Context SFG_Context;
377 struct tagSFG_Context
379 SFG_WindowHandleType Handle; /* The window's handle */
380 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
382 #if TARGET_HOST_POSIX_X11
383 GLXFBConfig* FBConfig; /* The window's FBConfig */
384 #elif TARGET_HOST_MS_WINDOWS
385 HDC Device; /* The window's device context */
388 int DoubleBuffered; /* Treat the window as double-buffered */
391 /* Window's state description. This structure should be kept portable. */
392 typedef struct tagSFG_WindowState SFG_WindowState;
393 struct tagSFG_WindowState
395 int Width; /* Window's width in pixels */
396 int Height; /* The same about the height */
397 int OldWidth; /* Window width from before a resize */
398 int OldHeight; /* " height " " " " */
400 GLboolean Redisplay; /* Do we have to redisplay? */
401 GLboolean Visible; /* Is the window visible now */
403 int Cursor; /* The currently selected cursor */
405 long JoystickPollRate; /* The joystick polling rate */
406 long JoystickLastPoll; /* When the last poll happened */
408 int MouseX, MouseY; /* The most recent mouse position */
410 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
411 GLboolean KeyRepeating; /* Currently in repeat mode */
413 GLboolean NeedToResize; /* Do we need to resize the window? */
418 * A generic function pointer. We should really use the GLUTproc type
419 * defined in freeglut_ext.h, but if we include that header in this file
420 * a bunch of other stuff (font-related) blows up!
422 typedef void (*SFG_Proc)();
426 * SET_WCB() is used as:
428 * SET_WCB( window, cbname, func );
430 * ...where {window} is the freeglut window to set the callback,
431 * {cbname} is the window-specific callback to set,
432 * {func} is a function-pointer.
434 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
435 * but this can cause warnings because the FETCH_WCB() macro type-
436 * casts its result, and a type-cast value shouldn't be an lvalue.
438 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
439 * and for no other reason. Since it's hidden in the macro, the
440 * ugliness is felt to be rather benign.
442 #define SET_WCB(window,cbname,func) \
445 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
446 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
450 * FETCH_WCB() is used as:
452 * FETCH_WCB( window, cbname );
454 * ...where {window} is the freeglut window to fetch the callback from,
455 * {cbname} is the window-specific callback to fetch.
457 * The result is correctly type-cast to the callback function pointer
460 #define FETCH_WCB(window,cbname) \
461 ((window).CallBacks[CB_ ## cbname])
464 * INVOKE_WCB() is used as:
466 * INVOKE_WCB( window, cbname, ( arg_list ) );
468 * ...where {window} is the freeglut window,
469 * {cbname} is the window-specific callback to be invoked,
470 * {(arg_list)} is the parameter list.
472 * The callback is invoked as:
474 * callback( arg_list );
476 * ...so the parentheses are REQUIRED in the {arg_list}.
478 * NOTE that it does a sanity-check and also sets the
482 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
483 #define INVOKE_WCB(window,cbname,arg_list) \
486 if( FETCH_WCB( window, cbname ) ) \
488 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
489 fgSetWindow( &window ); \
494 #define INVOKE_WCB(window,cbname,arg_list) \
497 if( FETCH_WCB( window, cbname ) ) \
499 fgSetWindow( &window ); \
500 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
506 * The window callbacks the user can supply us with. Should be kept portable.
508 * This enumeration provides the freeglut CallBack numbers.
509 * The symbolic constants are indices into a window's array of
510 * function callbacks. The names are formed by splicing a common
511 * prefix onto the callback's base name. (This was originally
512 * done so that an early stage of development could live side-by-
513 * side with the old callback code. The old callback code used
514 * the bare callback's name as a structure member, so I used a
515 * prefix for the array index name.)
517 * XXX For consistancy, perhaps the prefix should match the
518 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
539 /* Presently ignored */
550 /* Always make this the LAST one */
555 /* This structure holds the OpenGL rendering context for all the menu windows */
556 typedef struct tagSFG_MenuContext SFG_MenuContext;
557 struct tagSFG_MenuContext
559 SFG_WindowContextType MContext; /* The menu window's WGL context */
562 /* This structure describes a menu */
563 typedef struct tagSFG_Window SFG_Window;
564 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
565 typedef struct tagSFG_Menu SFG_Menu;
569 void *UserData; /* User data passed back at callback */
570 int ID; /* The global menu ID */
571 SFG_List Entries; /* The menu entries list */
572 FGCBMenu Callback; /* The menu callback */
573 FGCBDestroy Destroy; /* Destruction callback */
574 GLboolean IsActive; /* Is the menu selected? */
575 int Width; /* Menu box width in pixels */
576 int Height; /* Menu box height in pixels */
577 int X, Y; /* Menu box raster position */
579 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
580 SFG_Window *Window; /* Window for menu */
581 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
584 /* This is a menu entry */
585 struct tagSFG_MenuEntry
588 int ID; /* The menu entry ID (local) */
589 int Ordinal; /* The menu's ordinal number */
590 char* Text; /* The text to be displayed */
591 SFG_Menu* SubMenu; /* Optional sub-menu tree */
592 GLboolean IsActive; /* Is the entry highlighted? */
593 int Width; /* Label's width in pixels */
597 * A window, making part of freeglut windows hierarchy.
598 * Should be kept portable.
600 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
605 int ID; /* Window's ID number */
607 SFG_Context Window; /* Window and OpenGL context */
608 SFG_WindowState State; /* The window state */
609 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
610 void *UserData ; /* For use by user */
612 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
613 SFG_Menu* ActiveMenu; /* The window's active menu */
615 SFG_Window* Parent; /* The parent to this window */
616 SFG_List Children; /* The subwindows d.l. list */
618 GLboolean IsMenu; /* Set to 1 if we are a menu */
622 /* A linked list structure of windows */
623 typedef struct tagSFG_WindowList SFG_WindowList ;
624 struct tagSFG_WindowList
630 /* This holds information about all the windows, menus etc. */
631 typedef struct tagSFG_Structure SFG_Structure;
632 struct tagSFG_Structure
634 SFG_List Windows; /* The global windows list */
635 SFG_List Menus; /* The global menus list */
636 SFG_List WindowsToDestroy;
638 SFG_Window* CurrentWindow; /* The currently set window */
639 SFG_Menu* CurrentMenu; /* Same, but menu... */
641 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
643 SFG_Window* GameModeWindow; /* The game mode window */
645 int WindowID; /* The new current window ID */
646 int MenuID; /* The new current menu ID */
650 * This structure is used for the enumeration purposes.
651 * You can easily extend its functionalities by declaring
652 * a structure containing enumerator's contents and custom
653 * data, then casting its pointer to (SFG_Enumerator *).
655 typedef struct tagSFG_Enumerator SFG_Enumerator;
656 struct tagSFG_Enumerator
658 GLboolean found; /* Used to terminate search */
659 void* data; /* Custom data pointer */
661 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
663 /* The bitmap font structure */
664 typedef struct tagSFG_Font SFG_Font;
667 char* Name; /* The source font name */
668 int Quantity; /* Number of chars in font */
669 int Height; /* Height of the characters */
670 const GLubyte** Characters; /* The characters mapping */
672 float xorig, yorig; /* Relative origin of the character */
675 /* The stroke font structures */
677 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
678 struct tagSFG_StrokeVertex
683 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
684 struct tagSFG_StrokeStrip
687 const SFG_StrokeVertex* Vertices;
690 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
691 struct tagSFG_StrokeChar
695 const SFG_StrokeStrip* Strips;
698 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
699 struct tagSFG_StrokeFont
701 char* Name; /* The source font name */
702 int Quantity; /* Number of chars in font */
703 GLfloat Height; /* Height of the characters */
704 const SFG_StrokeChar** Characters; /* The characters mapping */
707 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
709 /* Freeglut display related stuff (initialized once per session) */
710 extern SFG_Display fgDisplay;
712 /* Freeglut internal structure */
713 extern SFG_Structure fgStructure;
715 /* The current freeglut settings */
716 extern SFG_State fgState;
719 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
722 * A call to this function makes us sure that the Display and Structure
723 * subsystems have been properly initialized and are ready to be used
725 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
726 if ( ! fgState.Initialised ) \
728 fgError ( " ERROR: Function <%s> called" \
729 " without first calling 'glutInit'.", (string) ) ; \
732 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
733 if ( ! fgState.Initialised ) \
735 fgError ( " ERROR: Internal <%s> function called" \
736 " without first calling 'glutInit'.", (string) ) ; \
739 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
742 fgError ( " ERROR: Internal error <%s> in function %s", \
743 (string), (function) ) ; \
747 * Following definitions are somewhat similiar to GLib's,
748 * but do not generate any log messages:
750 #define freeglut_return_if_fail( expr ) \
753 #define freeglut_return_val_if_fail( expr, val ) \
758 * A call to those macros assures us that there is a current
759 * window set, respectively:
761 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
762 if ( ! fgStructure.CurrentWindow ) \
764 fgError ( " ERROR: Function <%s> called" \
765 " with no current window defined.", (string) ) ; \
769 * The deinitialize function gets called on glutMainLoop() end. It should clean up
770 * everything inside of the freeglut
772 void fgDeinitialize( void );
775 * Those two functions are used to create/destroy the freeglut internal
776 * structures. This actually happens when calling glutInit() and when
777 * quitting the glutMainLoop() (which actually happens, when all windows
780 void fgCreateStructure( void );
781 void fgDestroyStructure( void );
783 /* A helper function to check if a display mode is possible to use */
784 #if TARGET_HOST_POSIX_X11
785 GLXFBConfig* fgChooseFBConfig( void );
788 /* The window procedure for Win32 events handling */
789 #if TARGET_HOST_MS_WINDOWS
790 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
791 WPARAM wParam, LPARAM lParam );
792 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
793 unsigned char layer_type );
797 * Window creation, opening, closing and destruction.
798 * Also CallBack clearing/initialization.
799 * Defined in freeglut_structure.c, freeglut_window.c.
801 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
802 GLboolean positionUse, int x, int y,
803 GLboolean sizeUse, int w, int h,
804 GLboolean gameMode, GLboolean isMenu );
805 void fgSetWindow ( SFG_Window *window );
806 void fgOpenWindow( SFG_Window* window, const char* title,
807 GLboolean positionUse, int x, int y,
808 GLboolean sizeUse, int w, int h,
809 GLboolean gameMode, GLboolean isSubWindow );
810 void fgCloseWindow( SFG_Window* window );
811 void fgAddToWindowDestroyList ( SFG_Window* window );
812 void fgCloseWindows ();
813 void fgDestroyWindow( SFG_Window* window );
815 /* Menu creation and destruction. Defined in freeglut_structure.c */
816 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
817 void fgDestroyMenu( SFG_Menu* menu );
819 /* Joystick device management functions, defined in freeglut_joystick.c */
820 int fgJoystickDetect( void );
821 void fgInitialiseJoysticks( void );
822 void fgJoystickClose( void );
823 void fgJoystickPollWindow( SFG_Window* window );
825 /* InputDevice Initialisation and Closure */
826 int fgInputDeviceDetect( void );
827 void fgInitialiseInputDevices( void );
828 void fgInputDeviceClose( void );
830 /* Setting the cursor for a given window */
831 void fgSetCursor ( SFG_Window *window, int cursorID );
834 * Helper function to enumerate through all registered windows
835 * and one to enumerate all of a window's subwindows...
837 * The GFunc callback for those functions will be defined as:
839 * void enumCallback( gpointer window, gpointer enumerator );
841 * where window is the enumerated (sub)window pointer (SFG_Window *),
842 * and userData is the a custom user-supplied pointer. Functions
843 * are defined and exported from freeglut_structure.c file.
845 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
846 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
847 SFG_Enumerator* enumerator );
850 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
851 * first window in the queue matching the specified window handle.
852 * The function is defined in freeglut_structure.c file.
854 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
857 * This function is similiar to the previous one, except it is
858 * looking for a specified (sub)window identifier. The function
859 * is defined in freeglut_structure.c file.
861 SFG_Window* fgWindowByID( int windowID );
864 * Looks up a menu given its ID. This is easier than fgWindowByXXX
865 * as all menus are placed in a single doubly linked list...
867 SFG_Menu* fgMenuByID( int menuID );
870 * The menu activation and deactivation the code. This is the meat
871 * of the menu user interface handling code...
873 void fgUpdateMenuHighlight ( SFG_Menu *menu );
874 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
875 int mouse_x, int mouse_y );
876 void fgDeactivateMenu( SFG_Window *window );
879 * This function gets called just before the buffers swap, so that
880 * freeglut can display the pull-down menus via OpenGL. The function
881 * is defined in freeglut_menu.c file.
883 void fgDisplayMenu( void );
885 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
886 long fgElapsedTime( void );
888 /* System time in milliseconds */
889 long unsigned fgSystemTime(void);
892 void fgListInit(SFG_List *list);
893 void fgListAppend(SFG_List *list, SFG_Node *node);
894 void fgListRemove(SFG_List *list, SFG_Node *node);
895 int fgListLength(SFG_List *list);
896 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
898 /* Error Message functions */
899 void fgError( const char *fmt, ... );
900 void fgWarning( const char *fmt, ... );
902 #endif /* FREEGLUT_INTERNAL_H */
904 /*** END OF FILE ***/