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__) || defined(__sun)
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>
113 # ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
114 # include <X11/extensions/xf86vmode.h>
116 # ifdef HAVE_X11_EXTENSIONS_XRANDR_H
117 # include <X11/extensions/Xrandr.h>
119 /* If GLX is too old, we will fail during runtime when multisampling
120 is requested, but at least freeglut compiles. */
121 # ifndef GLX_SAMPLE_BUFFERS
122 # define GLX_SAMPLE_BUFFERS 0x80A8
125 # define GLX_SAMPLES 0x80A9
130 /* These files should be available on every platform. */
137 /* These are included based on autoconf directives. */
138 #ifdef HAVE_SYS_TYPES_H
139 # include <sys/types.h>
144 #ifdef TIME_WITH_SYS_TIME
145 # include <sys/time.h>
147 #elif defined(HAVE_SYS_TIME_H)
148 # include <sys/time.h>
153 /* -- AUTOCONF HACKS --------------------------------------------------------*/
155 /* XXX: Update autoconf to avoid these.
156 * XXX: Are non-POSIX platforms intended not to use autoconf?
157 * If so, perhaps there should be a config_guess.h for them. Alternatively,
158 * config guesses could be placed above, just after the config.h exclusion.
160 #if defined(__FreeBSD__) || defined(__NetBSD__)
161 # define HAVE_USB_JS 1
162 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
163 # define HAVE_USBHID_H 1
167 #if TARGET_HOST_MS_WINDOWS
168 # define HAVE_VFPRINTF 1
171 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */
172 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)
173 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
174 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
176 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
178 # define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
182 #if defined(_MSC_VER) || defined(__WATCOMC__)
183 /* strdup() is non-standard, for all but POSIX-2001 */
184 #define strdup _strdup
187 /* M_PI is non-standard (defined by BSD, not ISO-C) */
189 # define M_PI 3.14159265358979323846
192 #ifdef HAVE_STDBOOL_H
193 # include <stdbool.h>
209 /* General defines */
211 #define INVALID_MODIFIERS 0xffffffff
213 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
215 /* Freeglut callbacks type definitions */
216 typedef void (* FGCBDisplay )( void );
217 typedef void (* FGCBReshape )( int, int );
218 typedef void (* FGCBVisibility )( int );
219 typedef void (* FGCBKeyboard )( unsigned char, int, int );
220 typedef void (* FGCBSpecial )( int, int, int );
221 typedef void (* FGCBMouse )( int, int, int, int );
222 typedef void (* FGCBMouseWheel )( int, int, int, int );
223 typedef void (* FGCBMotion )( int, int );
224 typedef void (* FGCBPassive )( int, int );
225 typedef void (* FGCBEntry )( int );
226 typedef void (* FGCBWindowStatus )( int );
227 typedef void (* FGCBSelect )( int, int, int );
228 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
229 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
230 typedef void (* FGCBSpecialUp )( int, int, int );
231 typedef void (* FGCBOverlayDisplay)( void );
232 typedef void (* FGCBSpaceMotion )( int, int, int );
233 typedef void (* FGCBSpaceRotation )( int, int, int );
234 typedef void (* FGCBSpaceButton )( int, int );
235 typedef void (* FGCBDials )( int, int );
236 typedef void (* FGCBButtonBox )( int, int );
237 typedef void (* FGCBTabletMotion )( int, int );
238 typedef void (* FGCBTabletButton )( int, int, int, int );
239 typedef void (* FGCBDestroy )( void );
241 /* The global callbacks type definitions */
242 typedef void (* FGCBIdle )( void );
243 typedef void (* FGCBTimer )( int );
244 typedef void (* FGCBMenuState )( int );
245 typedef void (* FGCBMenuStatus )( int, int, int );
247 /* The callback used when creating/using menus */
248 typedef void (* FGCBMenu )( int );
250 /* The FreeGLUT error/warning handler type definition */
251 typedef void (* FGError ) ( const char *fmt, va_list ap);
252 typedef void (* FGWarning ) ( const char *fmt, va_list ap);
255 /* A list structure */
256 typedef struct tagSFG_List SFG_List;
263 /* A list node structure */
264 typedef struct tagSFG_Node SFG_Node;
271 /* A helper structure holding two ints and a boolean */
272 typedef struct tagSFG_XYUse SFG_XYUse;
275 GLint X, Y; /* The two integers... */
276 GLboolean Use; /* ...and a single boolean. */
280 * An enumeration containing the state of the GLUT execution:
281 * initializing, running, or stopping
285 GLUT_EXEC_STATE_INIT,
286 GLUT_EXEC_STATE_RUNNING,
290 /* This structure holds different freeglut settings */
291 typedef struct tagSFG_State SFG_State;
294 SFG_XYUse Position; /* The default windows' position */
295 SFG_XYUse Size; /* The default windows' size */
296 unsigned int DisplayMode; /* Display mode for new windows */
298 GLboolean Initialised; /* freeglut has been initialised */
300 int DirectContext; /* Direct rendering state */
302 GLboolean ForceIconic; /* New top windows are iconified */
303 GLboolean UseCurrentContext; /* New windows share with current */
305 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
306 GLboolean XSyncSwitch; /* X11 sync protocol switch */
308 int KeyRepeat; /* Global key repeat mode. */
309 int Modifiers; /* Current ALT/SHIFT/CTRL state */
311 GLuint FPSInterval; /* Interval between FPS printfs */
312 GLuint SwapCount; /* Count of glutSwapBuffer calls */
313 GLuint SwapTime; /* Time of last SwapBuffers */
315 unsigned long Time; /* Time that glutInit was called */
316 SFG_List Timers; /* The freeglut timer hooks */
317 SFG_List FreeTimers; /* The unused timer hooks */
319 FGCBIdle IdleCallback; /* The global idle callback */
321 int ActiveMenus; /* Num. of currently active menus */
322 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
323 FGCBMenuStatus MenuStatusCallback;
325 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
326 int GameModeDepth; /* The pixel depth for game mode */
327 int GameModeRefresh; /* The refresh rate for game mode */
329 int ActionOnWindowClose; /* Action when user closes window */
331 fgExecutionState ExecState; /* Used for GLUT termination */
332 char *ProgramName; /* Name of the invoking program */
333 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
334 int NumActiveJoysticks; /* Number of active joysticks -- if zero, don't poll joysticks */
335 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
337 int AuxiliaryBufferNumber; /* Number of auxiliary buffers */
338 int SampleNumber; /* Number of samples per pixel */
340 int MajorVersion; /* Major OpenGL context version */
341 int MinorVersion; /* Minor OpenGL context version */
342 int ContextFlags; /* OpenGL context flags */
343 int ContextProfile; /* OpenGL context profile */
344 FGError ErrorFunc; /* User defined error handler */
345 FGWarning WarningFunc; /* User defined warning handler */
348 /* The structure used by display initialization in freeglut_init.c */
349 typedef struct tagSFG_Display SFG_Display;
350 struct tagSFG_Display
352 #if TARGET_HOST_POSIX_X11
353 Display* Display; /* The display we are being run in. */
354 int Screen; /* The screen we are about to use. */
355 Window RootWindow; /* The screen's root window. */
356 int Connection; /* The display's connection number */
357 Atom DeleteWindow; /* The window deletion atom */
358 Atom State; /* The state atom */
359 Atom StateFullScreen; /* The full screen atom */
361 #ifdef HAVE_X11_EXTENSIONS_XRANDR_H
362 int prev_xsz, prev_ysz;
364 #endif /* HAVE_X11_EXTENSIONS_XRANDR_H */
366 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
368 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
369 * the validity of the VidMode has to be tracked
371 int DisplayModeValid; /* Flag that indicates runtime status*/
372 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
373 int DisplayModeClock; /* The display mode's refresh rate */
374 int DisplayViewPortX; /* saved X location of the viewport */
375 int DisplayViewPortY; /* saved Y location of the viewport */
376 int DisplayPointerX; /* saved X location of the pointer */
377 int DisplayPointerY; /* saved Y location of the pointer */
379 #endif /* HAVE_X11_EXTENSIONS_XF86VMODE_H */
381 #elif TARGET_HOST_MS_WINDOWS
382 HINSTANCE Instance; /* The application's instance */
383 DEVMODE DisplayMode; /* Desktop's display settings */
384 char *DisplayName; /* Display name for multi display support*/
388 int ScreenWidth; /* The screen's width in pixels */
389 int ScreenHeight; /* The screen's height in pixels */
390 int ScreenWidthMM; /* The screen's width in milimeters */
391 int ScreenHeightMM; /* The screen's height in milimeters */
395 /* The user can create any number of timer hooks */
396 typedef struct tagSFG_Timer SFG_Timer;
400 int ID; /* The timer ID integer */
401 FGCBTimer Callback; /* The timer callback */
402 long TriggerTime; /* The timer trigger time */
406 * Make "freeglut" window handle and context types so that we don't need so
407 * much conditionally-compiled code later in the library.
409 #if TARGET_HOST_POSIX_X11
411 typedef Window SFG_WindowHandleType ;
412 typedef GLXContext SFG_WindowContextType ;
414 #elif TARGET_HOST_MS_WINDOWS
416 typedef HWND SFG_WindowHandleType ;
417 typedef HGLRC SFG_WindowContextType ;
422 * A window and its OpenGL context. The contents of this structure
423 * are highly dependant on the target operating system we aim at...
425 typedef struct tagSFG_Context SFG_Context;
426 struct tagSFG_Context
428 SFG_WindowHandleType Handle; /* The window's handle */
429 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
431 #if TARGET_HOST_POSIX_X11
432 GLXFBConfig* FBConfig; /* The window's FBConfig */
433 #elif TARGET_HOST_MS_WINDOWS
434 HDC Device; /* The window's device context */
437 int DoubleBuffered; /* Treat the window as double-buffered */
440 /* Window's state description. This structure should be kept portable. */
441 typedef struct tagSFG_WindowState SFG_WindowState;
442 struct tagSFG_WindowState
444 int Width; /* Window's width in pixels */
445 int Height; /* The same about the height */
446 int OldWidth; /* Window width from before a resize */
447 int OldHeight; /* " height " " " " */
449 GLboolean Redisplay; /* Do we have to redisplay? */
450 GLboolean Visible; /* Is the window visible now */
452 int Cursor; /* The currently selected cursor */
454 long JoystickPollRate; /* The joystick polling rate */
455 long JoystickLastPoll; /* When the last poll happened */
457 int MouseX, MouseY; /* The most recent mouse position */
459 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
460 GLboolean KeyRepeating; /* Currently in repeat mode */
462 GLboolean NeedToResize; /* Do we need to resize the window? */
464 GLboolean IsFullscreen; /* is the window fullscreen? */
469 * A generic function pointer. We should really use the GLUTproc type
470 * defined in freeglut_ext.h, but if we include that header in this file
471 * a bunch of other stuff (font-related) blows up!
473 typedef void (*SFG_Proc)();
477 * SET_WCB() is used as:
479 * SET_WCB( window, cbname, func );
481 * ...where {window} is the freeglut window to set the callback,
482 * {cbname} is the window-specific callback to set,
483 * {func} is a function-pointer.
485 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
486 * but this can cause warnings because the FETCH_WCB() macro type-
487 * casts its result, and a type-cast value shouldn't be an lvalue.
489 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
490 * and for no other reason. Since it's hidden in the macro, the
491 * ugliness is felt to be rather benign.
493 #define SET_WCB(window,cbname,func) \
496 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
497 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
501 * FETCH_WCB() is used as:
503 * FETCH_WCB( window, cbname );
505 * ...where {window} is the freeglut window to fetch the callback from,
506 * {cbname} is the window-specific callback to fetch.
508 * The result is correctly type-cast to the callback function pointer
511 #define FETCH_WCB(window,cbname) \
512 ((window).CallBacks[CB_ ## cbname])
515 * INVOKE_WCB() is used as:
517 * INVOKE_WCB( window, cbname, ( arg_list ) );
519 * ...where {window} is the freeglut window,
520 * {cbname} is the window-specific callback to be invoked,
521 * {(arg_list)} is the parameter list.
523 * The callback is invoked as:
525 * callback( arg_list );
527 * ...so the parentheses are REQUIRED in the {arg_list}.
529 * NOTE that it does a sanity-check and also sets the
533 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
534 #define INVOKE_WCB(window,cbname,arg_list) \
537 if( FETCH_WCB( window, cbname ) ) \
539 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
540 fgSetWindow( &window ); \
545 #define INVOKE_WCB(window,cbname,arg_list) \
548 if( FETCH_WCB( window, cbname ) ) \
550 fgSetWindow( &window ); \
551 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
557 * The window callbacks the user can supply us with. Should be kept portable.
559 * This enumeration provides the freeglut CallBack numbers.
560 * The symbolic constants are indices into a window's array of
561 * function callbacks. The names are formed by splicing a common
562 * prefix onto the callback's base name. (This was originally
563 * done so that an early stage of development could live side-by-
564 * side with the old callback code. The old callback code used
565 * the bare callback's name as a structure member, so I used a
566 * prefix for the array index name.)
568 * XXX For consistancy, perhaps the prefix should match the
569 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
590 /* Presently ignored */
593 CB_SpaceMotion, /* presently implemented only on UNIX/X11 */
594 CB_SpaceRotation, /* presently implemented only on UNIX/X11 */
595 CB_SpaceButton, /* presently implemented only on UNIX/X11 */
601 /* Always make this the LAST one */
606 /* This structure holds the OpenGL rendering context for all the menu windows */
607 typedef struct tagSFG_MenuContext SFG_MenuContext;
608 struct tagSFG_MenuContext
610 SFG_WindowContextType MContext; /* The menu window's WGL context */
613 /* This structure describes a menu */
614 typedef struct tagSFG_Window SFG_Window;
615 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
616 typedef struct tagSFG_Menu SFG_Menu;
620 void *UserData; /* User data passed back at callback */
621 int ID; /* The global menu ID */
622 SFG_List Entries; /* The menu entries list */
623 FGCBMenu Callback; /* The menu callback */
624 FGCBDestroy Destroy; /* Destruction callback */
625 GLboolean IsActive; /* Is the menu selected? */
626 int Width; /* Menu box width in pixels */
627 int Height; /* Menu box height in pixels */
628 int X, Y; /* Menu box raster position */
630 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
631 SFG_Window *Window; /* Window for menu */
632 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
635 /* This is a menu entry */
636 struct tagSFG_MenuEntry
639 int ID; /* The menu entry ID (local) */
640 int Ordinal; /* The menu's ordinal number */
641 char* Text; /* The text to be displayed */
642 SFG_Menu* SubMenu; /* Optional sub-menu tree */
643 GLboolean IsActive; /* Is the entry highlighted? */
644 int Width; /* Label's width in pixels */
648 * A window, making part of freeglut windows hierarchy.
649 * Should be kept portable.
651 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
656 int ID; /* Window's ID number */
658 SFG_Context Window; /* Window and OpenGL context */
659 SFG_WindowState State; /* The window state */
660 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
661 void *UserData ; /* For use by user */
663 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
664 SFG_Menu* ActiveMenu; /* The window's active menu */
666 SFG_Window* Parent; /* The parent to this window */
667 SFG_List Children; /* The subwindows d.l. list */
669 GLboolean IsMenu; /* Set to 1 if we are a menu */
673 /* A linked list structure of windows */
674 typedef struct tagSFG_WindowList SFG_WindowList ;
675 struct tagSFG_WindowList
681 /* This holds information about all the windows, menus etc. */
682 typedef struct tagSFG_Structure SFG_Structure;
683 struct tagSFG_Structure
685 SFG_List Windows; /* The global windows list */
686 SFG_List Menus; /* The global menus list */
687 SFG_List WindowsToDestroy;
689 SFG_Window* CurrentWindow; /* The currently set window */
690 SFG_Menu* CurrentMenu; /* Same, but menu... */
692 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
694 SFG_Window* GameModeWindow; /* The game mode window */
696 int WindowID; /* The new current window ID */
697 int MenuID; /* The new current menu ID */
701 * This structure is used for the enumeration purposes.
702 * You can easily extend its functionalities by declaring
703 * a structure containing enumerator's contents and custom
704 * data, then casting its pointer to (SFG_Enumerator *).
706 typedef struct tagSFG_Enumerator SFG_Enumerator;
707 struct tagSFG_Enumerator
709 GLboolean found; /* Used to terminate search */
710 void* data; /* Custom data pointer */
712 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
714 /* The bitmap font structure */
715 typedef struct tagSFG_Font SFG_Font;
718 char* Name; /* The source font name */
719 int Quantity; /* Number of chars in font */
720 int Height; /* Height of the characters */
721 const GLubyte** Characters; /* The characters mapping */
723 float xorig, yorig; /* Relative origin of the character */
726 /* The stroke font structures */
728 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
729 struct tagSFG_StrokeVertex
734 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
735 struct tagSFG_StrokeStrip
738 const SFG_StrokeVertex* Vertices;
741 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
742 struct tagSFG_StrokeChar
746 const SFG_StrokeStrip* Strips;
749 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
750 struct tagSFG_StrokeFont
752 char* Name; /* The source font name */
753 int Quantity; /* Number of chars in font */
754 GLfloat Height; /* Height of the characters */
755 const SFG_StrokeChar** Characters; /* The characters mapping */
758 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
760 /* Freeglut display related stuff (initialized once per session) */
761 extern SFG_Display fgDisplay;
763 /* Freeglut internal structure */
764 extern SFG_Structure fgStructure;
766 /* The current freeglut settings */
767 extern SFG_State fgState;
770 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
773 * A call to this function makes us sure that the Display and Structure
774 * subsystems have been properly initialized and are ready to be used
776 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
777 if ( ! fgState.Initialised ) \
779 fgError ( " ERROR: Function <%s> called" \
780 " without first calling 'glutInit'.", (string) ) ; \
783 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
784 if ( ! fgState.Initialised ) \
786 fgError ( " ERROR: Internal <%s> function called" \
787 " without first calling 'glutInit'.", (string) ) ; \
790 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
793 fgError ( " ERROR: Internal error <%s> in function %s", \
794 (string), (function) ) ; \
798 * Following definitions are somewhat similiar to GLib's,
799 * but do not generate any log messages:
801 #define freeglut_return_if_fail( expr ) \
804 #define freeglut_return_val_if_fail( expr, val ) \
809 * A call to those macros assures us that there is a current
810 * window set, respectively:
812 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
813 if ( ! fgStructure.CurrentWindow && \
814 ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) ) \
816 fgError ( " ERROR: Function <%s> called" \
817 " with no current window defined.", (string) ) ; \
821 * The deinitialize function gets called on glutMainLoop() end. It should clean up
822 * everything inside of the freeglut
824 void fgDeinitialize( void );
827 * Those two functions are used to create/destroy the freeglut internal
828 * structures. This actually happens when calling glutInit() and when
829 * quitting the glutMainLoop() (which actually happens, when all windows
832 void fgCreateStructure( void );
833 void fgDestroyStructure( void );
835 /* A helper function to check if a display mode is possible to use */
836 #if TARGET_HOST_POSIX_X11
837 GLXFBConfig* fgChooseFBConfig( int* numcfgs );
840 /* The window procedure for Win32 events handling */
841 #if TARGET_HOST_MS_WINDOWS
842 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
843 WPARAM wParam, LPARAM lParam );
844 void fgNewWGLCreateContext( SFG_Window* window );
845 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
846 unsigned char layer_type );
850 * Window creation, opening, closing and destruction.
851 * Also CallBack clearing/initialization.
852 * Defined in freeglut_structure.c, freeglut_window.c.
854 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
855 GLboolean positionUse, int x, int y,
856 GLboolean sizeUse, int w, int h,
857 GLboolean gameMode, GLboolean isMenu );
858 void fgSetWindow ( SFG_Window *window );
859 void fgOpenWindow( SFG_Window* window, const char* title,
860 GLboolean positionUse, int x, int y,
861 GLboolean sizeUse, int w, int h,
862 GLboolean gameMode, GLboolean isSubWindow );
863 void fgCloseWindow( SFG_Window* window );
864 void fgAddToWindowDestroyList ( SFG_Window* window );
865 void fgCloseWindows ();
866 void fgDestroyWindow( SFG_Window* window );
868 /* Menu creation and destruction. Defined in freeglut_structure.c */
869 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
870 void fgDestroyMenu( SFG_Menu* menu );
872 /* Joystick device management functions, defined in freeglut_joystick.c */
873 int fgJoystickDetect( void );
874 void fgInitialiseJoysticks( void );
875 void fgJoystickClose( void );
876 void fgJoystickPollWindow( SFG_Window* window );
878 /* InputDevice Initialisation and Closure */
879 int fgInputDeviceDetect( void );
880 void fgInitialiseInputDevices( void );
881 void fgInputDeviceClose( void );
883 /* spaceball device functions, defined in freeglut_spaceball.c */
884 void fgInitialiseSpaceball( void );
885 void fgSpaceballClose( void );
886 void fgSpaceballSetWindow( SFG_Window *window );
888 int fgHasSpaceball( void );
889 int fgSpaceballNumButtons( void );
891 #if TARGET_HOST_POSIX_X11
892 int fgIsSpaceballXEvent( const XEvent *ev );
893 void fgSpaceballHandleXEvent( const XEvent *ev );
896 /* Setting the cursor for a given window */
897 void fgSetCursor ( SFG_Window *window, int cursorID );
900 * Helper function to enumerate through all registered windows
901 * and one to enumerate all of a window's subwindows...
903 * The GFunc callback for those functions will be defined as:
905 * void enumCallback( gpointer window, gpointer enumerator );
907 * where window is the enumerated (sub)window pointer (SFG_Window *),
908 * and userData is the a custom user-supplied pointer. Functions
909 * are defined and exported from freeglut_structure.c file.
911 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
912 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
913 SFG_Enumerator* enumerator );
916 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
917 * first window in the queue matching the specified window handle.
918 * The function is defined in freeglut_structure.c file.
920 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
923 * This function is similiar to the previous one, except it is
924 * looking for a specified (sub)window identifier. The function
925 * is defined in freeglut_structure.c file.
927 SFG_Window* fgWindowByID( int windowID );
930 * Looks up a menu given its ID. This is easier than fgWindowByXXX
931 * as all menus are placed in a single doubly linked list...
933 SFG_Menu* fgMenuByID( int menuID );
936 * The menu activation and deactivation the code. This is the meat
937 * of the menu user interface handling code...
939 void fgUpdateMenuHighlight ( SFG_Menu *menu );
940 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
941 int mouse_x, int mouse_y );
942 void fgDeactivateMenu( SFG_Window *window );
945 * This function gets called just before the buffers swap, so that
946 * freeglut can display the pull-down menus via OpenGL. The function
947 * is defined in freeglut_menu.c file.
949 void fgDisplayMenu( void );
951 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
952 long fgElapsedTime( void );
954 /* System time in milliseconds */
955 long unsigned fgSystemTime(void);
958 void fgListInit(SFG_List *list);
959 void fgListAppend(SFG_List *list, SFG_Node *node);
960 void fgListRemove(SFG_List *list, SFG_Node *node);
961 int fgListLength(SFG_List *list);
962 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
964 /* Error Message functions */
965 void fgError( const char *fmt, ... );
966 void fgWarning( const char *fmt, ... );
969 * Check if "hint" is present in "property" for "window". See freeglut_init.c
971 #if TARGET_HOST_POSIX_X11
972 int fgHintPresent(Window window, Atom property, Atom hint);
975 SFG_Proc fghGetProcAddress( const char *procName );
977 #if TARGET_HOST_MS_WINDOWS
978 extern void (__cdecl *__glutExitFunc)( int return_value );
981 #endif /* FREEGLUT_INTERNAL_H */
983 /*** END OF FILE ***/