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 7
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(TARGET_HOST_POSIX_X11) && !defined(TARGET_HOST_MS_WINDOWS) && !defined(TARGET_HOST_MAC_OSX) && !defined(TARGET_HOST_SOLARIS)
45 #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__MINGW32__) \
46 || defined(_WIN32) || defined(_WIN32_WCE) \
47 || ( defined(__CYGWIN__) && defined(X_DISPLAY_MISSING) )
48 # define TARGET_HOST_MS_WINDOWS 1
50 #elif defined(__posix__) || defined(__unix__) || defined(__linux__)
51 # define TARGET_HOST_POSIX_X11 1
53 #elif defined(__APPLE__)
54 /* This is a placeholder until we get native OSX support ironed out -- JFF 11/18/09 */
55 # define TARGET_HOST_POSIX_X11 1
56 /* # define TARGET_HOST_MAC_OSX 1 */
59 # error "Unrecognized target host!"
64 /* Detect both SunPro and gcc compilers on Sun Solaris */
65 #if defined (__SVR4) && defined (__sun)
66 # define TARGET_HOST_SOLARIS 1
69 #ifndef TARGET_HOST_MS_WINDOWS
70 # define TARGET_HOST_MS_WINDOWS 0
73 #ifndef TARGET_HOST_POSIX_X11
74 # define TARGET_HOST_POSIX_X11 0
77 #ifndef TARGET_HOST_MAC_OSX
78 # define TARGET_HOST_MAC_OSX 0
81 #ifndef TARGET_HOST_SOLARIS
82 # define TARGET_HOST_SOLARIS 0
85 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
87 #define FREEGLUT_MAX_MENUS 3
89 /* -- PLATFORM-SPECIFIC INCLUDES ------------------------------------------- */
91 /* All Win32 headers depend on the huge windows.h recursive include.
92 * Note: Lower-case header names are used, for best cross-platform
95 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE)
97 # include <windowsx.h>
98 # include <mmsystem.h>
99 /* CYGWIN does not have tchar.h, but has TEXT(x), defined in winnt.h. */
103 # define _TEXT(x) TEXT(x)
104 # define _T(x) TEXT(x)
107 #elif TARGET_HOST_POSIX_X11
109 # include <X11/Xlib.h>
110 # include <X11/Xatom.h>
111 # include <X11/keysym.h>
112 # include <X11/extensions/XInput.h>
114 # include <X11/extensions/xf86vmode.h>
116 /* If GLX is too old, we will fail during runtime when multisampling
117 is requested, but at least freeglut compiles. */
118 # ifndef GLX_SAMPLE_BUFFERS
119 # define GLX_SAMPLE_BUFFERS 0x80A8
122 # define GLX_SAMPLES 0x80A9
127 /* These files should be available on every platform. */
134 /* These are included based on autoconf directives. */
135 #ifdef HAVE_SYS_TYPES_H
136 # include <sys/types.h>
141 #ifdef TIME_WITH_SYS_TIME
142 # include <sys/time.h>
144 #elif defined(HAVE_SYS_TIME_H)
145 # include <sys/time.h>
150 /* -- AUTOCONF HACKS --------------------------------------------------------*/
152 /* XXX: Update autoconf to avoid these.
153 * XXX: Are non-POSIX platforms intended not to use autoconf?
154 * If so, perhaps there should be a config_guess.h for them. Alternatively,
155 * config guesses could be placed above, just after the config.h exclusion.
157 #if defined(__FreeBSD__) || defined(__NetBSD__)
158 # define HAVE_USB_JS 1
159 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
160 # define HAVE_USBHID_H 1
164 #if TARGET_HOST_MS_WINDOWS
165 # define HAVE_VFPRINTF 1
168 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */
169 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)
170 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
171 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
173 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
175 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
179 #if defined(_MSC_VER) || defined(__WATCOMC__)
180 /* strdup() is non-standard, for all but POSIX-2001 */
181 #define strdup _strdup
184 /* M_PI is non-standard (defined by BSD, not ISO-C) */
186 # define M_PI 3.14159265358979323846
189 #ifdef HAVE_STDBOOL_H
190 # include <stdbool.h>
206 /* General defines */
208 #define INVALID_MODIFIERS 0xffffffff
210 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
212 /* Freeglut callbacks type definitions */
213 typedef void (* FGCBDisplay )( void );
214 typedef void (* FGCBReshape )( int, int );
215 typedef void (* FGCBVisibility )( int );
216 typedef void (* FGCBKeyboard )( unsigned char, int, int );
217 typedef void (* FGCBSpecial )( int, int, int );
218 typedef void (* FGCBMouse )( int, int, int, int );
219 typedef void (* FGCBMouseWheel )( int, int, int, int );
220 typedef void (* FGCBMotion )( int, int );
221 typedef void (* FGCBPassive )( int, int );
222 typedef void (* FGCBEntry )( int );
223 typedef void (* FGCBWindowStatus )( int );
224 typedef void (* FGCBSelect )( int, int, int );
225 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
226 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
227 typedef void (* FGCBSpecialUp )( int, int, int );
228 typedef void (* FGCBOverlayDisplay)( void );
229 typedef void (* FGCBSpaceMotion )( int, int, int );
230 typedef void (* FGCBSpaceRotation )( int, int, int );
231 typedef void (* FGCBSpaceButton )( int, int );
232 typedef void (* FGCBDials )( int, int );
233 typedef void (* FGCBButtonBox )( int, int );
234 typedef void (* FGCBTabletMotion )( int, int );
235 typedef void (* FGCBTabletButton )( int, int, int, int );
236 typedef void (* FGCBDestroy )( void );
238 /* The global callbacks type definitions */
239 typedef void (* FGCBIdle )( void );
240 typedef void (* FGCBTimer )( int );
241 typedef void (* FGCBMenuState )( int );
242 typedef void (* FGCBMenuStatus )( int, int, int );
244 /* The callback used when creating/using menus */
245 typedef void (* FGCBMenu )( int );
247 /* The FreeGLUT error/warning handler type definition */
248 typedef void (* FGError ) ( const char *fmt, va_list ap);
249 typedef void (* FGWarning ) ( const char *fmt, va_list ap);
252 /* A list structure */
253 typedef struct tagSFG_List SFG_List;
260 /* A list node structure */
261 typedef struct tagSFG_Node SFG_Node;
268 /* A helper structure holding two ints and a boolean */
269 typedef struct tagSFG_XYUse SFG_XYUse;
272 GLint X, Y; /* The two integers... */
273 GLboolean Use; /* ...and a single boolean. */
277 * An enumeration containing the state of the GLUT execution:
278 * initializing, running, or stopping
282 GLUT_EXEC_STATE_INIT,
283 GLUT_EXEC_STATE_RUNNING,
287 /* This structure holds different freeglut settings */
288 typedef struct tagSFG_State SFG_State;
291 SFG_XYUse Position; /* The default windows' position */
292 SFG_XYUse Size; /* The default windows' size */
293 unsigned int DisplayMode; /* Display mode for new windows */
295 GLboolean Initialised; /* freeglut has been initialised */
297 int DirectContext; /* Direct rendering state */
299 GLboolean ForceIconic; /* New top windows are iconified */
300 GLboolean UseCurrentContext; /* New windows share with current */
302 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
303 GLboolean XSyncSwitch; /* X11 sync protocol switch */
305 int KeyRepeat; /* Global key repeat mode. */
306 int Modifiers; /* Current ALT/SHIFT/CTRL state */
308 GLuint FPSInterval; /* Interval between FPS printfs */
309 GLuint SwapCount; /* Count of glutSwapBuffer calls */
310 GLuint SwapTime; /* Time of last SwapBuffers */
312 unsigned long Time; /* Time that glutInit was called */
313 SFG_List Timers; /* The freeglut timer hooks */
314 SFG_List FreeTimers; /* The unused timer hooks */
316 FGCBIdle IdleCallback; /* The global idle callback */
318 int ActiveMenus; /* Num. of currently active menus */
319 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
320 FGCBMenuStatus MenuStatusCallback;
322 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
323 int GameModeDepth; /* The pixel depth for game mode */
324 int GameModeRefresh; /* The refresh rate for game mode */
326 int ActionOnWindowClose; /* Action when user closes window */
328 fgExecutionState ExecState; /* Used for GLUT termination */
329 char *ProgramName; /* Name of the invoking program */
330 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
331 int NumActiveJoysticks; /* Number of active joysticks -- if zero, don't poll joysticks */
332 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
334 int AuxiliaryBufferNumber; /* Number of auxiliary buffers */
335 int SampleNumber; /* Number of samples per pixel */
337 int MajorVersion; /* Major OpenGL context version */
338 int MinorVersion; /* Minor OpenGL context version */
339 int ContextFlags; /* OpenGL context flags */
340 int ContextProfile; /* OpenGL context profile */
341 FGError ErrorFunc; /* User defined error handler */
342 FGWarning WarningFunc; /* User defined warning handler */
345 /* The structure used by display initialization in freeglut_init.c */
346 typedef struct tagSFG_Display SFG_Display;
347 struct tagSFG_Display
349 #if TARGET_HOST_POSIX_X11
350 Display* Display; /* The display we are being run in. */
351 int Screen; /* The screen we are about to use. */
352 Window RootWindow; /* The screen's root window. */
353 int Connection; /* The display's connection number */
354 Atom DeleteWindow; /* The window deletion atom */
355 Atom State; /* The state atom */
356 Atom StateFullScreen; /* The full screen atom */
358 #ifdef X_XF86VidModeGetModeLine
360 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
361 * the validity of the VidMode has to be tracked
363 int DisplayModeValid; /* Flag that indicates runtime status*/
364 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
365 int DisplayModeClock; /* The display mode's refresh rate */
366 int DisplayViewPortX; /* saved X location of the viewport */
367 int DisplayViewPortY; /* saved Y location of the viewport */
368 int DisplayPointerX; /* saved X location of the pointer */
369 int DisplayPointerY; /* saved Y location of the pointer */
371 #endif /* X_XF86VidModeGetModeLine */
373 #elif TARGET_HOST_MS_WINDOWS
374 HINSTANCE Instance; /* The application's instance */
375 DEVMODE DisplayMode; /* Desktop's display settings */
376 char *DisplayName; /* Display name for multi display support*/
380 int ScreenWidth; /* The screen's width in pixels */
381 int ScreenHeight; /* The screen's height in pixels */
382 int ScreenWidthMM; /* The screen's width in milimeters */
383 int ScreenHeightMM; /* The screen's height in milimeters */
387 /* The user can create any number of timer hooks */
388 typedef struct tagSFG_Timer SFG_Timer;
392 int ID; /* The timer ID integer */
393 FGCBTimer Callback; /* The timer callback */
394 long TriggerTime; /* The timer trigger time */
398 * Make "freeglut" window handle and context types so that we don't need so
399 * much conditionally-compiled code later in the library.
401 #if TARGET_HOST_POSIX_X11
403 typedef Window SFG_WindowHandleType ;
404 typedef GLXContext SFG_WindowContextType ;
406 #elif TARGET_HOST_MS_WINDOWS
408 typedef HWND SFG_WindowHandleType ;
409 typedef HGLRC SFG_WindowContextType ;
414 * A window and its OpenGL context. The contents of this structure
415 * are highly dependant on the target operating system we aim at...
417 typedef struct tagSFG_Context SFG_Context;
418 struct tagSFG_Context
420 SFG_WindowHandleType Handle; /* The window's handle */
421 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
423 #if TARGET_HOST_POSIX_X11
424 GLXFBConfig* FBConfig; /* The window's FBConfig */
425 #elif TARGET_HOST_MS_WINDOWS
426 HDC Device; /* The window's device context */
429 int DoubleBuffered; /* Treat the window as double-buffered */
432 /* Window's state description. This structure should be kept portable. */
433 typedef struct tagSFG_WindowState SFG_WindowState;
434 struct tagSFG_WindowState
436 int Width; /* Window's width in pixels */
437 int Height; /* The same about the height */
438 int OldWidth; /* Window width from before a resize */
439 int OldHeight; /* " height " " " " */
441 GLboolean Redisplay; /* Do we have to redisplay? */
442 GLboolean Visible; /* Is the window visible now */
444 int Cursor; /* The currently selected cursor */
446 long JoystickPollRate; /* The joystick polling rate */
447 long JoystickLastPoll; /* When the last poll happened */
449 int MouseX, MouseY; /* The most recent mouse position */
451 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
452 GLboolean KeyRepeating; /* Currently in repeat mode */
454 GLboolean NeedToResize; /* Do we need to resize the window? */
456 GLboolean IsFullscreen; /* is the window fullscreen? */
461 * A generic function pointer. We should really use the GLUTproc type
462 * defined in freeglut_ext.h, but if we include that header in this file
463 * a bunch of other stuff (font-related) blows up!
465 typedef void (*SFG_Proc)();
469 * SET_WCB() is used as:
471 * SET_WCB( window, cbname, func );
473 * ...where {window} is the freeglut window to set the callback,
474 * {cbname} is the window-specific callback to set,
475 * {func} is a function-pointer.
477 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
478 * but this can cause warnings because the FETCH_WCB() macro type-
479 * casts its result, and a type-cast value shouldn't be an lvalue.
481 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
482 * and for no other reason. Since it's hidden in the macro, the
483 * ugliness is felt to be rather benign.
485 #define SET_WCB(window,cbname,func) \
488 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
489 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
493 * FETCH_WCB() is used as:
495 * FETCH_WCB( window, cbname );
497 * ...where {window} is the freeglut window to fetch the callback from,
498 * {cbname} is the window-specific callback to fetch.
500 * The result is correctly type-cast to the callback function pointer
503 #define FETCH_WCB(window,cbname) \
504 ((window).CallBacks[CB_ ## cbname])
507 * INVOKE_WCB() is used as:
509 * INVOKE_WCB( window, cbname, ( arg_list ) );
511 * ...where {window} is the freeglut window,
512 * {cbname} is the window-specific callback to be invoked,
513 * {(arg_list)} is the parameter list.
515 * The callback is invoked as:
517 * callback( arg_list );
519 * ...so the parentheses are REQUIRED in the {arg_list}.
521 * NOTE that it does a sanity-check and also sets the
525 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
526 #define INVOKE_WCB(window,cbname,arg_list) \
529 if( FETCH_WCB( window, cbname ) ) \
531 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
532 fgSetWindow( &window ); \
537 #define INVOKE_WCB(window,cbname,arg_list) \
540 if( FETCH_WCB( window, cbname ) ) \
542 fgSetWindow( &window ); \
543 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
549 * The window callbacks the user can supply us with. Should be kept portable.
551 * This enumeration provides the freeglut CallBack numbers.
552 * The symbolic constants are indices into a window's array of
553 * function callbacks. The names are formed by splicing a common
554 * prefix onto the callback's base name. (This was originally
555 * done so that an early stage of development could live side-by-
556 * side with the old callback code. The old callback code used
557 * the bare callback's name as a structure member, so I used a
558 * prefix for the array index name.)
560 * XXX For consistancy, perhaps the prefix should match the
561 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
582 /* Presently ignored */
585 CB_SpaceMotion, /* presently implemented only on UNIX/X11 */
586 CB_SpaceRotation, /* presently implemented only on UNIX/X11 */
587 CB_SpaceButton, /* presently implemented only on UNIX/X11 */
593 /* Always make this the LAST one */
598 /* This structure holds the OpenGL rendering context for all the menu windows */
599 typedef struct tagSFG_MenuContext SFG_MenuContext;
600 struct tagSFG_MenuContext
602 SFG_WindowContextType MContext; /* The menu window's WGL context */
605 /* This structure describes a menu */
606 typedef struct tagSFG_Window SFG_Window;
607 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
608 typedef struct tagSFG_Menu SFG_Menu;
612 void *UserData; /* User data passed back at callback */
613 int ID; /* The global menu ID */
614 SFG_List Entries; /* The menu entries list */
615 FGCBMenu Callback; /* The menu callback */
616 FGCBDestroy Destroy; /* Destruction callback */
617 GLboolean IsActive; /* Is the menu selected? */
618 int Width; /* Menu box width in pixels */
619 int Height; /* Menu box height in pixels */
620 int X, Y; /* Menu box raster position */
622 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
623 SFG_Window *Window; /* Window for menu */
624 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
627 /* This is a menu entry */
628 struct tagSFG_MenuEntry
631 int ID; /* The menu entry ID (local) */
632 int Ordinal; /* The menu's ordinal number */
633 char* Text; /* The text to be displayed */
634 SFG_Menu* SubMenu; /* Optional sub-menu tree */
635 GLboolean IsActive; /* Is the entry highlighted? */
636 int Width; /* Label's width in pixels */
640 * A window, making part of freeglut windows hierarchy.
641 * Should be kept portable.
643 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
648 int ID; /* Window's ID number */
650 SFG_Context Window; /* Window and OpenGL context */
651 SFG_WindowState State; /* The window state */
652 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
653 void *UserData ; /* For use by user */
655 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
656 SFG_Menu* ActiveMenu; /* The window's active menu */
658 SFG_Window* Parent; /* The parent to this window */
659 SFG_List Children; /* The subwindows d.l. list */
661 GLboolean IsMenu; /* Set to 1 if we are a menu */
665 /* A linked list structure of windows */
666 typedef struct tagSFG_WindowList SFG_WindowList ;
667 struct tagSFG_WindowList
673 /* This holds information about all the windows, menus etc. */
674 typedef struct tagSFG_Structure SFG_Structure;
675 struct tagSFG_Structure
677 SFG_List Windows; /* The global windows list */
678 SFG_List Menus; /* The global menus list */
679 SFG_List WindowsToDestroy;
681 SFG_Window* CurrentWindow; /* The currently set window */
682 SFG_Menu* CurrentMenu; /* Same, but menu... */
684 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
686 SFG_Window* GameModeWindow; /* The game mode window */
688 int WindowID; /* The new current window ID */
689 int MenuID; /* The new current menu ID */
693 * This structure is used for the enumeration purposes.
694 * You can easily extend its functionalities by declaring
695 * a structure containing enumerator's contents and custom
696 * data, then casting its pointer to (SFG_Enumerator *).
698 typedef struct tagSFG_Enumerator SFG_Enumerator;
699 struct tagSFG_Enumerator
701 GLboolean found; /* Used to terminate search */
702 void* data; /* Custom data pointer */
704 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
706 /* The bitmap font structure */
707 typedef struct tagSFG_Font SFG_Font;
710 char* Name; /* The source font name */
711 int Quantity; /* Number of chars in font */
712 int Height; /* Height of the characters */
713 const GLubyte** Characters; /* The characters mapping */
715 float xorig, yorig; /* Relative origin of the character */
718 /* The stroke font structures */
720 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
721 struct tagSFG_StrokeVertex
726 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
727 struct tagSFG_StrokeStrip
730 const SFG_StrokeVertex* Vertices;
733 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
734 struct tagSFG_StrokeChar
738 const SFG_StrokeStrip* Strips;
741 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
742 struct tagSFG_StrokeFont
744 char* Name; /* The source font name */
745 int Quantity; /* Number of chars in font */
746 GLfloat Height; /* Height of the characters */
747 const SFG_StrokeChar** Characters; /* The characters mapping */
750 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
752 /* Freeglut display related stuff (initialized once per session) */
753 extern SFG_Display fgDisplay;
755 /* Freeglut internal structure */
756 extern SFG_Structure fgStructure;
758 /* The current freeglut settings */
759 extern SFG_State fgState;
762 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
765 * A call to this function makes us sure that the Display and Structure
766 * subsystems have been properly initialized and are ready to be used
768 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
769 if ( ! fgState.Initialised ) \
771 fgError ( " ERROR: Function <%s> called" \
772 " without first calling 'glutInit'.", (string) ) ; \
775 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
776 if ( ! fgState.Initialised ) \
778 fgError ( " ERROR: Internal <%s> function called" \
779 " without first calling 'glutInit'.", (string) ) ; \
782 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
785 fgError ( " ERROR: Internal error <%s> in function %s", \
786 (string), (function) ) ; \
790 * Following definitions are somewhat similiar to GLib's,
791 * but do not generate any log messages:
793 #define freeglut_return_if_fail( expr ) \
796 #define freeglut_return_val_if_fail( expr, val ) \
801 * A call to those macros assures us that there is a current
802 * window set, respectively:
804 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
805 if ( ! fgStructure.CurrentWindow ) \
807 fgError ( " ERROR: Function <%s> called" \
808 " with no current window defined.", (string) ) ; \
812 * The deinitialize function gets called on glutMainLoop() end. It should clean up
813 * everything inside of the freeglut
815 void fgDeinitialize( void );
818 * Those two functions are used to create/destroy the freeglut internal
819 * structures. This actually happens when calling glutInit() and when
820 * quitting the glutMainLoop() (which actually happens, when all windows
823 void fgCreateStructure( void );
824 void fgDestroyStructure( void );
826 /* A helper function to check if a display mode is possible to use */
827 #if TARGET_HOST_POSIX_X11
828 GLXFBConfig* fgChooseFBConfig( void );
831 /* The window procedure for Win32 events handling */
832 #if TARGET_HOST_MS_WINDOWS
833 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
834 WPARAM wParam, LPARAM lParam );
835 void fgNewWGLCreateContext( SFG_Window* window );
836 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
837 unsigned char layer_type );
841 * Window creation, opening, closing and destruction.
842 * Also CallBack clearing/initialization.
843 * Defined in freeglut_structure.c, freeglut_window.c.
845 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
846 GLboolean positionUse, int x, int y,
847 GLboolean sizeUse, int w, int h,
848 GLboolean gameMode, GLboolean isMenu );
849 void fgSetWindow ( SFG_Window *window );
850 void fgOpenWindow( SFG_Window* window, const char* title,
851 GLboolean positionUse, int x, int y,
852 GLboolean sizeUse, int w, int h,
853 GLboolean gameMode, GLboolean isSubWindow );
854 void fgCloseWindow( SFG_Window* window );
855 void fgAddToWindowDestroyList ( SFG_Window* window );
856 void fgCloseWindows ();
857 void fgDestroyWindow( SFG_Window* window );
859 /* Menu creation and destruction. Defined in freeglut_structure.c */
860 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
861 void fgDestroyMenu( SFG_Menu* menu );
863 /* Joystick device management functions, defined in freeglut_joystick.c */
864 int fgJoystickDetect( void );
865 void fgInitialiseJoysticks( void );
866 void fgJoystickClose( void );
867 void fgJoystickPollWindow( SFG_Window* window );
869 /* InputDevice Initialisation and Closure */
870 int fgInputDeviceDetect( void );
871 void fgInitialiseInputDevices( void );
872 void fgInputDeviceClose( void );
874 /* spaceball device functions, defined in freeglut_spaceball.c */
875 void fgInitialiseSpaceball( void );
876 void fgSpaceballClose( void );
877 void fgSpaceballSetWindow( SFG_Window *window );
879 int fgHasSpaceball( void );
880 int fgSpaceballNumButtons( void );
882 #if TARGET_HOST_POSIX_X11
883 int fgIsSpaceballXEvent( const XEvent *ev );
884 void fgSpaceballHandleXEvent( const XEvent *ev );
887 /* Setting the cursor for a given window */
888 void fgSetCursor ( SFG_Window *window, int cursorID );
891 * Helper function to enumerate through all registered windows
892 * and one to enumerate all of a window's subwindows...
894 * The GFunc callback for those functions will be defined as:
896 * void enumCallback( gpointer window, gpointer enumerator );
898 * where window is the enumerated (sub)window pointer (SFG_Window *),
899 * and userData is the a custom user-supplied pointer. Functions
900 * are defined and exported from freeglut_structure.c file.
902 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
903 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
904 SFG_Enumerator* enumerator );
907 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
908 * first window in the queue matching the specified window handle.
909 * The function is defined in freeglut_structure.c file.
911 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
914 * This function is similiar to the previous one, except it is
915 * looking for a specified (sub)window identifier. The function
916 * is defined in freeglut_structure.c file.
918 SFG_Window* fgWindowByID( int windowID );
921 * Looks up a menu given its ID. This is easier than fgWindowByXXX
922 * as all menus are placed in a single doubly linked list...
924 SFG_Menu* fgMenuByID( int menuID );
927 * The menu activation and deactivation the code. This is the meat
928 * of the menu user interface handling code...
930 void fgUpdateMenuHighlight ( SFG_Menu *menu );
931 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
932 int mouse_x, int mouse_y );
933 void fgDeactivateMenu( SFG_Window *window );
936 * This function gets called just before the buffers swap, so that
937 * freeglut can display the pull-down menus via OpenGL. The function
938 * is defined in freeglut_menu.c file.
940 void fgDisplayMenu( void );
942 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
943 long fgElapsedTime( void );
945 /* System time in milliseconds */
946 long unsigned fgSystemTime(void);
949 void fgListInit(SFG_List *list);
950 void fgListAppend(SFG_List *list, SFG_Node *node);
951 void fgListRemove(SFG_List *list, SFG_Node *node);
952 int fgListLength(SFG_List *list);
953 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
955 /* Error Message functions */
956 void fgError( const char *fmt, ... );
957 void fgWarning( const char *fmt, ... );
960 * Check if "hint" is present in "property" for "window". See freeglut_init.c
962 #if TARGET_HOST_POSIX_X11
963 int fgHintPresent(Window window, Atom property, Atom hint);
966 SFG_Proc fghGetProcAddress( const char *procName );
968 #if TARGET_HOST_MS_WINDOWS
969 extern void (__cdecl *__glutExitFunc)( int return_value );
972 #endif /* FREEGLUT_INTERNAL_H */
974 /*** END OF FILE ***/