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. */
133 /* These are included based on autoconf directives. */
134 #ifdef HAVE_SYS_TYPES_H
135 # include <sys/types.h>
140 #ifdef TIME_WITH_SYS_TIME
141 # include <sys/time.h>
143 #elif defined(HAVE_SYS_TIME_H)
144 # include <sys/time.h>
149 /* -- AUTOCONF HACKS --------------------------------------------------------*/
151 /* XXX: Update autoconf to avoid these.
152 * XXX: Are non-POSIX platforms intended not to use autoconf?
153 * If so, perhaps there should be a config_guess.h for them. Alternatively,
154 * config guesses could be placed above, just after the config.h exclusion.
156 #if defined(__FreeBSD__) || defined(__NetBSD__)
157 # define HAVE_USB_JS 1
158 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
159 # define HAVE_USBHID_H 1
163 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */
164 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)
165 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
166 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
168 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
170 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
174 #if defined(_MSC_VER) || defined(__WATCOMC__)
175 /* strdup() is non-standard, for all but POSIX-2001 */
176 #define strdup _strdup
179 /* M_PI is non-standard (defined by BSD, not ISO-C) */
181 # define M_PI 3.14159265358979323846
184 #ifdef HAVE_STDBOOL_H
185 # include <stdbool.h>
201 /* General defines */
203 #define INVALID_MODIFIERS 0xffffffff
205 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
207 /* Freeglut callbacks type definitions */
208 typedef void (* FGCBDisplay )( void );
209 typedef void (* FGCBReshape )( int, int );
210 typedef void (* FGCBVisibility )( int );
211 typedef void (* FGCBKeyboard )( unsigned char, int, int );
212 typedef void (* FGCBSpecial )( int, int, int );
213 typedef void (* FGCBMouse )( int, int, int, int );
214 typedef void (* FGCBMouseWheel )( int, int, int, int );
215 typedef void (* FGCBMotion )( int, int );
216 typedef void (* FGCBPassive )( int, int );
217 typedef void (* FGCBEntry )( int );
218 typedef void (* FGCBWindowStatus )( int );
219 typedef void (* FGCBSelect )( int, int, int );
220 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
221 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
222 typedef void (* FGCBSpecialUp )( int, int, int );
223 typedef void (* FGCBOverlayDisplay)( void );
224 typedef void (* FGCBSpaceMotion )( int, int, int );
225 typedef void (* FGCBSpaceRotation )( int, int, int );
226 typedef void (* FGCBSpaceButton )( int, int );
227 typedef void (* FGCBDials )( int, int );
228 typedef void (* FGCBButtonBox )( int, int );
229 typedef void (* FGCBTabletMotion )( int, int );
230 typedef void (* FGCBTabletButton )( int, int, int, int );
231 typedef void (* FGCBDestroy )( void );
233 /* The global callbacks type definitions */
234 typedef void (* FGCBIdle )( void );
235 typedef void (* FGCBTimer )( int );
236 typedef void (* FGCBMenuState )( int );
237 typedef void (* FGCBMenuStatus )( int, int, int );
239 /* The callback used when creating/using menus */
240 typedef void (* FGCBMenu )( int );
243 /* A list structure */
244 typedef struct tagSFG_List SFG_List;
251 /* A list node structure */
252 typedef struct tagSFG_Node SFG_Node;
259 /* A helper structure holding two ints and a boolean */
260 typedef struct tagSFG_XYUse SFG_XYUse;
263 GLint X, Y; /* The two integers... */
264 GLboolean Use; /* ...and a single boolean. */
268 * An enumeration containing the state of the GLUT execution:
269 * initializing, running, or stopping
273 GLUT_EXEC_STATE_INIT,
274 GLUT_EXEC_STATE_RUNNING,
278 /* This structure holds different freeglut settings */
279 typedef struct tagSFG_State SFG_State;
282 SFG_XYUse Position; /* The default windows' position */
283 SFG_XYUse Size; /* The default windows' size */
284 unsigned int DisplayMode; /* Display mode for new windows */
286 GLboolean Initialised; /* freeglut has been initialised */
288 int DirectContext; /* Direct rendering state */
290 GLboolean ForceIconic; /* New top windows are iconified */
291 GLboolean UseCurrentContext; /* New windows share with current */
293 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
294 GLboolean XSyncSwitch; /* X11 sync protocol switch */
296 int KeyRepeat; /* Global key repeat mode. */
297 int Modifiers; /* Current ALT/SHIFT/CTRL state */
299 GLuint FPSInterval; /* Interval between FPS printfs */
300 GLuint SwapCount; /* Count of glutSwapBuffer calls */
301 GLuint SwapTime; /* Time of last SwapBuffers */
303 unsigned long Time; /* Time that glutInit was called */
304 SFG_List Timers; /* The freeglut timer hooks */
305 SFG_List FreeTimers; /* The unused timer hooks */
307 FGCBIdle IdleCallback; /* The global idle callback */
309 int ActiveMenus; /* Num. of currently active menus */
310 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
311 FGCBMenuStatus MenuStatusCallback;
313 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
314 int GameModeDepth; /* The pixel depth for game mode */
315 int GameModeRefresh; /* The refresh rate for game mode */
317 int ActionOnWindowClose; /* Action when user closes window */
319 fgExecutionState ExecState; /* Used for GLUT termination */
320 char *ProgramName; /* Name of the invoking program */
321 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
322 int NumActiveJoysticks; /* Number of active joysticks -- if zero, don't poll joysticks */
323 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
325 int AuxiliaryBufferNumber; /* Number of auxiliary buffers */
326 int SampleNumber; /* Number of samples per pixel */
328 int MajorVersion; /* Major OpenGL context version */
329 int MinorVersion; /* Minor OpenGL context version */
330 int ContextFlags; /* OpenGL context flags */
331 int ContextProfile; /* OpenGL context profile */
334 /* The structure used by display initialization in freeglut_init.c */
335 typedef struct tagSFG_Display SFG_Display;
336 struct tagSFG_Display
338 #if TARGET_HOST_POSIX_X11
339 Display* Display; /* The display we are being run in. */
340 int Screen; /* The screen we are about to use. */
341 Window RootWindow; /* The screen's root window. */
342 int Connection; /* The display's connection number */
343 Atom DeleteWindow; /* The window deletion atom */
344 Atom State; /* The state atom */
345 Atom StateFullScreen; /* The full screen atom */
347 #ifdef X_XF86VidModeGetModeLine
349 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
350 * the validity of the VidMode has to be tracked
352 int DisplayModeValid; /* Flag that indicates runtime status*/
353 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
354 int DisplayModeClock; /* The display mode's refresh rate */
355 int DisplayViewPortX; /* saved X location of the viewport */
356 int DisplayViewPortY; /* saved Y location of the viewport */
357 int DisplayPointerX; /* saved X location of the pointer */
358 int DisplayPointerY; /* saved Y location of the pointer */
360 #endif /* X_XF86VidModeGetModeLine */
362 #elif TARGET_HOST_MS_WINDOWS
363 HINSTANCE Instance; /* The application's instance */
364 DEVMODE DisplayMode; /* Desktop's display settings */
368 int ScreenWidth; /* The screen's width in pixels */
369 int ScreenHeight; /* The screen's height in pixels */
370 int ScreenWidthMM; /* The screen's width in milimeters */
371 int ScreenHeightMM; /* The screen's height in milimeters */
375 /* The user can create any number of timer hooks */
376 typedef struct tagSFG_Timer SFG_Timer;
380 int ID; /* The timer ID integer */
381 FGCBTimer Callback; /* The timer callback */
382 long TriggerTime; /* The timer trigger time */
386 * Make "freeglut" window handle and context types so that we don't need so
387 * much conditionally-compiled code later in the library.
389 #if TARGET_HOST_POSIX_X11
391 typedef Window SFG_WindowHandleType ;
392 typedef GLXContext SFG_WindowContextType ;
394 #elif TARGET_HOST_MS_WINDOWS
396 typedef HWND SFG_WindowHandleType ;
397 typedef HGLRC SFG_WindowContextType ;
402 * A window and its OpenGL context. The contents of this structure
403 * are highly dependant on the target operating system we aim at...
405 typedef struct tagSFG_Context SFG_Context;
406 struct tagSFG_Context
408 SFG_WindowHandleType Handle; /* The window's handle */
409 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
411 #if TARGET_HOST_POSIX_X11
412 GLXFBConfig* FBConfig; /* The window's FBConfig */
413 #elif TARGET_HOST_MS_WINDOWS
414 HDC Device; /* The window's device context */
417 int DoubleBuffered; /* Treat the window as double-buffered */
420 /* Window's state description. This structure should be kept portable. */
421 typedef struct tagSFG_WindowState SFG_WindowState;
422 struct tagSFG_WindowState
424 int Width; /* Window's width in pixels */
425 int Height; /* The same about the height */
426 int OldWidth; /* Window width from before a resize */
427 int OldHeight; /* " height " " " " */
429 GLboolean Redisplay; /* Do we have to redisplay? */
430 GLboolean Visible; /* Is the window visible now */
432 int Cursor; /* The currently selected cursor */
434 long JoystickPollRate; /* The joystick polling rate */
435 long JoystickLastPoll; /* When the last poll happened */
437 int MouseX, MouseY; /* The most recent mouse position */
439 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
440 GLboolean KeyRepeating; /* Currently in repeat mode */
442 GLboolean NeedToResize; /* Do we need to resize the window? */
444 GLboolean IsFullscreen; /* is the window fullscreen? */
449 * A generic function pointer. We should really use the GLUTproc type
450 * defined in freeglut_ext.h, but if we include that header in this file
451 * a bunch of other stuff (font-related) blows up!
453 typedef void (*SFG_Proc)();
457 * SET_WCB() is used as:
459 * SET_WCB( window, cbname, func );
461 * ...where {window} is the freeglut window to set the callback,
462 * {cbname} is the window-specific callback to set,
463 * {func} is a function-pointer.
465 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
466 * but this can cause warnings because the FETCH_WCB() macro type-
467 * casts its result, and a type-cast value shouldn't be an lvalue.
469 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
470 * and for no other reason. Since it's hidden in the macro, the
471 * ugliness is felt to be rather benign.
473 #define SET_WCB(window,cbname,func) \
476 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
477 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
481 * FETCH_WCB() is used as:
483 * FETCH_WCB( window, cbname );
485 * ...where {window} is the freeglut window to fetch the callback from,
486 * {cbname} is the window-specific callback to fetch.
488 * The result is correctly type-cast to the callback function pointer
491 #define FETCH_WCB(window,cbname) \
492 ((window).CallBacks[CB_ ## cbname])
495 * INVOKE_WCB() is used as:
497 * INVOKE_WCB( window, cbname, ( arg_list ) );
499 * ...where {window} is the freeglut window,
500 * {cbname} is the window-specific callback to be invoked,
501 * {(arg_list)} is the parameter list.
503 * The callback is invoked as:
505 * callback( arg_list );
507 * ...so the parentheses are REQUIRED in the {arg_list}.
509 * NOTE that it does a sanity-check and also sets the
513 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
514 #define INVOKE_WCB(window,cbname,arg_list) \
517 if( FETCH_WCB( window, cbname ) ) \
519 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
520 fgSetWindow( &window ); \
525 #define INVOKE_WCB(window,cbname,arg_list) \
528 if( FETCH_WCB( window, cbname ) ) \
530 fgSetWindow( &window ); \
531 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
537 * The window callbacks the user can supply us with. Should be kept portable.
539 * This enumeration provides the freeglut CallBack numbers.
540 * The symbolic constants are indices into a window's array of
541 * function callbacks. The names are formed by splicing a common
542 * prefix onto the callback's base name. (This was originally
543 * done so that an early stage of development could live side-by-
544 * side with the old callback code. The old callback code used
545 * the bare callback's name as a structure member, so I used a
546 * prefix for the array index name.)
548 * XXX For consistancy, perhaps the prefix should match the
549 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
570 /* Presently ignored */
573 CB_SpaceMotion, /* presently implemented only on UNIX/X11 */
574 CB_SpaceRotation, /* presently implemented only on UNIX/X11 */
575 CB_SpaceButton, /* presently implemented only on UNIX/X11 */
581 /* Always make this the LAST one */
586 /* This structure holds the OpenGL rendering context for all the menu windows */
587 typedef struct tagSFG_MenuContext SFG_MenuContext;
588 struct tagSFG_MenuContext
590 SFG_WindowContextType MContext; /* The menu window's WGL context */
593 /* This structure describes a menu */
594 typedef struct tagSFG_Window SFG_Window;
595 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
596 typedef struct tagSFG_Menu SFG_Menu;
600 void *UserData; /* User data passed back at callback */
601 int ID; /* The global menu ID */
602 SFG_List Entries; /* The menu entries list */
603 FGCBMenu Callback; /* The menu callback */
604 FGCBDestroy Destroy; /* Destruction callback */
605 GLboolean IsActive; /* Is the menu selected? */
606 int Width; /* Menu box width in pixels */
607 int Height; /* Menu box height in pixels */
608 int X, Y; /* Menu box raster position */
610 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
611 SFG_Window *Window; /* Window for menu */
612 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
615 /* This is a menu entry */
616 struct tagSFG_MenuEntry
619 int ID; /* The menu entry ID (local) */
620 int Ordinal; /* The menu's ordinal number */
621 char* Text; /* The text to be displayed */
622 SFG_Menu* SubMenu; /* Optional sub-menu tree */
623 GLboolean IsActive; /* Is the entry highlighted? */
624 int Width; /* Label's width in pixels */
628 * A window, making part of freeglut windows hierarchy.
629 * Should be kept portable.
631 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
636 int ID; /* Window's ID number */
638 SFG_Context Window; /* Window and OpenGL context */
639 SFG_WindowState State; /* The window state */
640 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
641 void *UserData ; /* For use by user */
643 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
644 SFG_Menu* ActiveMenu; /* The window's active menu */
646 SFG_Window* Parent; /* The parent to this window */
647 SFG_List Children; /* The subwindows d.l. list */
649 GLboolean IsMenu; /* Set to 1 if we are a menu */
653 /* A linked list structure of windows */
654 typedef struct tagSFG_WindowList SFG_WindowList ;
655 struct tagSFG_WindowList
661 /* This holds information about all the windows, menus etc. */
662 typedef struct tagSFG_Structure SFG_Structure;
663 struct tagSFG_Structure
665 SFG_List Windows; /* The global windows list */
666 SFG_List Menus; /* The global menus list */
667 SFG_List WindowsToDestroy;
669 SFG_Window* CurrentWindow; /* The currently set window */
670 SFG_Menu* CurrentMenu; /* Same, but menu... */
672 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
674 SFG_Window* GameModeWindow; /* The game mode window */
676 int WindowID; /* The new current window ID */
677 int MenuID; /* The new current menu ID */
681 * This structure is used for the enumeration purposes.
682 * You can easily extend its functionalities by declaring
683 * a structure containing enumerator's contents and custom
684 * data, then casting its pointer to (SFG_Enumerator *).
686 typedef struct tagSFG_Enumerator SFG_Enumerator;
687 struct tagSFG_Enumerator
689 GLboolean found; /* Used to terminate search */
690 void* data; /* Custom data pointer */
692 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
694 /* The bitmap font structure */
695 typedef struct tagSFG_Font SFG_Font;
698 char* Name; /* The source font name */
699 int Quantity; /* Number of chars in font */
700 int Height; /* Height of the characters */
701 const GLubyte** Characters; /* The characters mapping */
703 float xorig, yorig; /* Relative origin of the character */
706 /* The stroke font structures */
708 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
709 struct tagSFG_StrokeVertex
714 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
715 struct tagSFG_StrokeStrip
718 const SFG_StrokeVertex* Vertices;
721 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
722 struct tagSFG_StrokeChar
726 const SFG_StrokeStrip* Strips;
729 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
730 struct tagSFG_StrokeFont
732 char* Name; /* The source font name */
733 int Quantity; /* Number of chars in font */
734 GLfloat Height; /* Height of the characters */
735 const SFG_StrokeChar** Characters; /* The characters mapping */
738 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
740 /* Freeglut display related stuff (initialized once per session) */
741 extern SFG_Display fgDisplay;
743 /* Freeglut internal structure */
744 extern SFG_Structure fgStructure;
746 /* The current freeglut settings */
747 extern SFG_State fgState;
750 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
753 * A call to this function makes us sure that the Display and Structure
754 * subsystems have been properly initialized and are ready to be used
756 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
757 if ( ! fgState.Initialised ) \
759 fgError ( " ERROR: Function <%s> called" \
760 " without first calling 'glutInit'.", (string) ) ; \
763 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
764 if ( ! fgState.Initialised ) \
766 fgError ( " ERROR: Internal <%s> function called" \
767 " without first calling 'glutInit'.", (string) ) ; \
770 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
773 fgError ( " ERROR: Internal error <%s> in function %s", \
774 (string), (function) ) ; \
778 * Following definitions are somewhat similiar to GLib's,
779 * but do not generate any log messages:
781 #define freeglut_return_if_fail( expr ) \
784 #define freeglut_return_val_if_fail( expr, val ) \
789 * A call to those macros assures us that there is a current
790 * window set, respectively:
792 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
793 if ( ! fgStructure.CurrentWindow ) \
795 fgError ( " ERROR: Function <%s> called" \
796 " with no current window defined.", (string) ) ; \
800 * The deinitialize function gets called on glutMainLoop() end. It should clean up
801 * everything inside of the freeglut
803 void fgDeinitialize( void );
806 * Those two functions are used to create/destroy the freeglut internal
807 * structures. This actually happens when calling glutInit() and when
808 * quitting the glutMainLoop() (which actually happens, when all windows
811 void fgCreateStructure( void );
812 void fgDestroyStructure( void );
814 /* A helper function to check if a display mode is possible to use */
815 #if TARGET_HOST_POSIX_X11
816 GLXFBConfig* fgChooseFBConfig( void );
819 /* The window procedure for Win32 events handling */
820 #if TARGET_HOST_MS_WINDOWS
821 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
822 WPARAM wParam, LPARAM lParam );
823 void fgNewWGLCreateContext( SFG_Window* window );
824 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
825 unsigned char layer_type );
829 * Window creation, opening, closing and destruction.
830 * Also CallBack clearing/initialization.
831 * Defined in freeglut_structure.c, freeglut_window.c.
833 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
834 GLboolean positionUse, int x, int y,
835 GLboolean sizeUse, int w, int h,
836 GLboolean gameMode, GLboolean isMenu );
837 void fgSetWindow ( SFG_Window *window );
838 void fgOpenWindow( SFG_Window* window, const char* title,
839 GLboolean positionUse, int x, int y,
840 GLboolean sizeUse, int w, int h,
841 GLboolean gameMode, GLboolean isSubWindow );
842 void fgCloseWindow( SFG_Window* window );
843 void fgAddToWindowDestroyList ( SFG_Window* window );
844 void fgCloseWindows ();
845 void fgDestroyWindow( SFG_Window* window );
847 /* Menu creation and destruction. Defined in freeglut_structure.c */
848 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
849 void fgDestroyMenu( SFG_Menu* menu );
851 /* Joystick device management functions, defined in freeglut_joystick.c */
852 int fgJoystickDetect( void );
853 void fgInitialiseJoysticks( void );
854 void fgJoystickClose( void );
855 void fgJoystickPollWindow( SFG_Window* window );
857 /* InputDevice Initialisation and Closure */
858 int fgInputDeviceDetect( void );
859 void fgInitialiseInputDevices( void );
860 void fgInputDeviceClose( void );
862 /* spaceball device functions, defined in freeglut_spaceball.c */
863 void fgInitialiseSpaceball( void );
864 void fgSpaceballClose( void );
865 void fgSpaceballSetWindow( SFG_Window *window );
867 int fgHasSpaceball( void );
868 int fgSpaceballNumButtons( void );
870 #if TARGET_HOST_POSIX_X11
871 int fgIsSpaceballXEvent( const XEvent *ev );
872 void fgSpaceballHandleXEvent( const XEvent *ev );
875 /* Setting the cursor for a given window */
876 void fgSetCursor ( SFG_Window *window, int cursorID );
879 * Helper function to enumerate through all registered windows
880 * and one to enumerate all of a window's subwindows...
882 * The GFunc callback for those functions will be defined as:
884 * void enumCallback( gpointer window, gpointer enumerator );
886 * where window is the enumerated (sub)window pointer (SFG_Window *),
887 * and userData is the a custom user-supplied pointer. Functions
888 * are defined and exported from freeglut_structure.c file.
890 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
891 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
892 SFG_Enumerator* enumerator );
895 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
896 * first window in the queue matching the specified window handle.
897 * The function is defined in freeglut_structure.c file.
899 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
902 * This function is similiar to the previous one, except it is
903 * looking for a specified (sub)window identifier. The function
904 * is defined in freeglut_structure.c file.
906 SFG_Window* fgWindowByID( int windowID );
909 * Looks up a menu given its ID. This is easier than fgWindowByXXX
910 * as all menus are placed in a single doubly linked list...
912 SFG_Menu* fgMenuByID( int menuID );
915 * The menu activation and deactivation the code. This is the meat
916 * of the menu user interface handling code...
918 void fgUpdateMenuHighlight ( SFG_Menu *menu );
919 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
920 int mouse_x, int mouse_y );
921 void fgDeactivateMenu( SFG_Window *window );
924 * This function gets called just before the buffers swap, so that
925 * freeglut can display the pull-down menus via OpenGL. The function
926 * is defined in freeglut_menu.c file.
928 void fgDisplayMenu( void );
930 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
931 long fgElapsedTime( void );
933 /* System time in milliseconds */
934 long unsigned fgSystemTime(void);
937 void fgListInit(SFG_List *list);
938 void fgListAppend(SFG_List *list, SFG_Node *node);
939 void fgListRemove(SFG_List *list, SFG_Node *node);
940 int fgListLength(SFG_List *list);
941 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
943 /* Error Message functions */
944 void fgError( const char *fmt, ... );
945 void fgWarning( const char *fmt, ... );
948 * Check if "hint" is present in "property" for "window". See freeglut_init.c
950 #if TARGET_HOST_POSIX_X11
951 int fgHintPresent(Window window, Atom property, Atom hint);
954 SFG_Proc fghGetProcAddress( const char *procName );
956 #if TARGET_HOST_MS_WINDOWS
957 extern void (__cdecl *__glutExitFunc)( int return_value );
960 #endif /* FREEGLUT_INTERNAL_H */
962 /*** END OF FILE ***/