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 typedef void (* FGCBMultiEntry )( int, int );
242 typedef void (* FGCBMultiButton )( int, int, int, int, int );
243 typedef void (* FGCBMultiMotion )( int, int, int );
244 typedef void (* FGCBMultiPassive )( int, int, int );
246 /* The global callbacks type definitions */
247 typedef void (* FGCBIdle )( void );
248 typedef void (* FGCBTimer )( int );
249 typedef void (* FGCBMenuState )( int );
250 typedef void (* FGCBMenuStatus )( int, int, int );
252 /* The callback used when creating/using menus */
253 typedef void (* FGCBMenu )( int );
255 /* The FreeGLUT error/warning handler type definition */
256 typedef void (* FGError ) ( const char *fmt, va_list ap);
257 typedef void (* FGWarning ) ( const char *fmt, va_list ap);
260 /* A list structure */
261 typedef struct tagSFG_List SFG_List;
268 /* A list node structure */
269 typedef struct tagSFG_Node SFG_Node;
276 /* A helper structure holding two ints and a boolean */
277 typedef struct tagSFG_XYUse SFG_XYUse;
280 GLint X, Y; /* The two integers... */
281 GLboolean Use; /* ...and a single boolean. */
285 * An enumeration containing the state of the GLUT execution:
286 * initializing, running, or stopping
290 GLUT_EXEC_STATE_INIT,
291 GLUT_EXEC_STATE_RUNNING,
295 /* This structure holds different freeglut settings */
296 typedef struct tagSFG_State SFG_State;
299 SFG_XYUse Position; /* The default windows' position */
300 SFG_XYUse Size; /* The default windows' size */
301 unsigned int DisplayMode; /* Display mode for new windows */
303 GLboolean Initialised; /* freeglut has been initialised */
305 int DirectContext; /* Direct rendering state */
307 GLboolean ForceIconic; /* New top windows are iconified */
308 GLboolean UseCurrentContext; /* New windows share with current */
310 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
311 GLboolean XSyncSwitch; /* X11 sync protocol switch */
313 int KeyRepeat; /* Global key repeat mode. */
314 int Modifiers; /* Current ALT/SHIFT/CTRL state */
316 GLuint FPSInterval; /* Interval between FPS printfs */
317 GLuint SwapCount; /* Count of glutSwapBuffer calls */
318 GLuint SwapTime; /* Time of last SwapBuffers */
320 unsigned long Time; /* Time that glutInit was called */
321 SFG_List Timers; /* The freeglut timer hooks */
322 SFG_List FreeTimers; /* The unused timer hooks */
324 FGCBIdle IdleCallback; /* The global idle callback */
326 int ActiveMenus; /* Num. of currently active menus */
327 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
328 FGCBMenuStatus MenuStatusCallback;
330 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
331 int GameModeDepth; /* The pixel depth for game mode */
332 int GameModeRefresh; /* The refresh rate for game mode */
334 int ActionOnWindowClose; /* Action when user closes window */
336 fgExecutionState ExecState; /* Used for GLUT termination */
337 char *ProgramName; /* Name of the invoking program */
338 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
339 int NumActiveJoysticks; /* Number of active joysticks -- if zero, don't poll joysticks */
340 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
342 int AuxiliaryBufferNumber; /* Number of auxiliary buffers */
343 int SampleNumber; /* Number of samples per pixel */
345 int MajorVersion; /* Major OpenGL context version */
346 int MinorVersion; /* Minor OpenGL context version */
347 int ContextFlags; /* OpenGL context flags */
348 int ContextProfile; /* OpenGL context profile */
349 FGError ErrorFunc; /* User defined error handler */
350 FGWarning WarningFunc; /* User defined warning handler */
353 /* The structure used by display initialization in freeglut_init.c */
354 typedef struct tagSFG_Display SFG_Display;
355 struct tagSFG_Display
357 #if TARGET_HOST_POSIX_X11
358 Display* Display; /* The display we are being run in. */
359 int Screen; /* The screen we are about to use. */
360 Window RootWindow; /* The screen's root window. */
361 int Connection; /* The display's connection number */
362 Atom DeleteWindow; /* The window deletion atom */
363 Atom State; /* The state atom */
364 Atom StateFullScreen; /* The full screen atom */
366 #ifdef HAVE_X11_EXTENSIONS_XRANDR_H
367 int prev_xsz, prev_ysz;
370 #endif /* HAVE_X11_EXTENSIONS_XRANDR_H */
372 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
374 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
375 * the validity of the VidMode has to be tracked
377 int DisplayModeValid; /* Flag that indicates runtime status*/
378 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
379 int DisplayModeClock; /* The display mode's refresh rate */
380 int DisplayViewPortX; /* saved X location of the viewport */
381 int DisplayViewPortY; /* saved Y location of the viewport */
382 int DisplayPointerX; /* saved X location of the pointer */
383 int DisplayPointerY; /* saved Y location of the pointer */
385 #endif /* HAVE_X11_EXTENSIONS_XF86VMODE_H */
387 #elif TARGET_HOST_MS_WINDOWS
388 HINSTANCE Instance; /* The application's instance */
389 DEVMODE DisplayMode; /* Desktop's display settings */
390 char *DisplayName; /* Display name for multi display support*/
394 int ScreenWidth; /* The screen's width in pixels */
395 int ScreenHeight; /* The screen's height in pixels */
396 int ScreenWidthMM; /* The screen's width in milimeters */
397 int ScreenHeightMM; /* The screen's height in milimeters */
401 /* The user can create any number of timer hooks */
402 typedef struct tagSFG_Timer SFG_Timer;
406 int ID; /* The timer ID integer */
407 FGCBTimer Callback; /* The timer callback */
408 long TriggerTime; /* The timer trigger time */
412 * Make "freeglut" window handle and context types so that we don't need so
413 * much conditionally-compiled code later in the library.
415 #if TARGET_HOST_POSIX_X11
417 typedef Window SFG_WindowHandleType ;
418 typedef GLXContext SFG_WindowContextType ;
420 #elif TARGET_HOST_MS_WINDOWS
422 typedef HWND SFG_WindowHandleType ;
423 typedef HGLRC SFG_WindowContextType ;
428 * A window and its OpenGL context. The contents of this structure
429 * are highly dependant on the target operating system we aim at...
431 typedef struct tagSFG_Context SFG_Context;
432 struct tagSFG_Context
434 SFG_WindowHandleType Handle; /* The window's handle */
435 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
437 #if TARGET_HOST_POSIX_X11
438 GLXFBConfig* FBConfig; /* The window's FBConfig */
439 #elif TARGET_HOST_MS_WINDOWS
440 HDC Device; /* The window's device context */
443 int DoubleBuffered; /* Treat the window as double-buffered */
446 /* Window's state description. This structure should be kept portable. */
447 typedef struct tagSFG_WindowState SFG_WindowState;
448 struct tagSFG_WindowState
450 int Width; /* Window's width in pixels */
451 int Height; /* The same about the height */
452 int OldWidth; /* Window width from before a resize */
453 int OldHeight; /* " height " " " " */
455 GLboolean Redisplay; /* Do we have to redisplay? */
456 GLboolean Visible; /* Is the window visible now */
458 int Cursor; /* The currently selected cursor */
460 long JoystickPollRate; /* The joystick polling rate */
461 long JoystickLastPoll; /* When the last poll happened */
463 int MouseX, MouseY; /* The most recent mouse position */
465 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
466 GLboolean KeyRepeating; /* Currently in repeat mode */
468 GLboolean NeedToResize; /* Do we need to resize the window? */
470 GLboolean IsFullscreen; /* is the window fullscreen? */
475 * A generic function pointer. We should really use the GLUTproc type
476 * defined in freeglut_ext.h, but if we include that header in this file
477 * a bunch of other stuff (font-related) blows up!
479 typedef void (*SFG_Proc)();
483 * SET_WCB() is used as:
485 * SET_WCB( window, cbname, func );
487 * ...where {window} is the freeglut window to set the callback,
488 * {cbname} is the window-specific callback to set,
489 * {func} is a function-pointer.
491 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
492 * but this can cause warnings because the FETCH_WCB() macro type-
493 * casts its result, and a type-cast value shouldn't be an lvalue.
495 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
496 * and for no other reason. Since it's hidden in the macro, the
497 * ugliness is felt to be rather benign.
499 #define SET_WCB(window,cbname,func) \
502 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
503 (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
507 * FETCH_WCB() is used as:
509 * FETCH_WCB( window, cbname );
511 * ...where {window} is the freeglut window to fetch the callback from,
512 * {cbname} is the window-specific callback to fetch.
514 * The result is correctly type-cast to the callback function pointer
517 #define FETCH_WCB(window,cbname) \
518 ((window).CallBacks[CB_ ## cbname])
521 * INVOKE_WCB() is used as:
523 * INVOKE_WCB( window, cbname, ( arg_list ) );
525 * ...where {window} is the freeglut window,
526 * {cbname} is the window-specific callback to be invoked,
527 * {(arg_list)} is the parameter list.
529 * The callback is invoked as:
531 * callback( arg_list );
533 * ...so the parentheses are REQUIRED in the {arg_list}.
535 * NOTE that it does a sanity-check and also sets the
539 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
540 #define INVOKE_WCB(window,cbname,arg_list) \
543 if( FETCH_WCB( window, cbname ) ) \
545 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
546 fgSetWindow( &window ); \
551 #define INVOKE_WCB(window,cbname,arg_list) \
554 if( FETCH_WCB( window, cbname ) ) \
556 fgSetWindow( &window ); \
557 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
563 * The window callbacks the user can supply us with. Should be kept portable.
565 * This enumeration provides the freeglut CallBack numbers.
566 * The symbolic constants are indices into a window's array of
567 * function callbacks. The names are formed by splicing a common
568 * prefix onto the callback's base name. (This was originally
569 * done so that an early stage of development could live side-by-
570 * side with the old callback code. The old callback code used
571 * the bare callback's name as a structure member, so I used a
572 * prefix for the array index name.)
574 * XXX For consistancy, perhaps the prefix should match the
575 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
602 /* Presently ignored */
605 CB_SpaceMotion, /* presently implemented only on UNIX/X11 */
606 CB_SpaceRotation, /* presently implemented only on UNIX/X11 */
607 CB_SpaceButton, /* presently implemented only on UNIX/X11 */
613 /* Always make this the LAST one */
618 /* This structure holds the OpenGL rendering context for all the menu windows */
619 typedef struct tagSFG_MenuContext SFG_MenuContext;
620 struct tagSFG_MenuContext
622 SFG_WindowContextType MContext; /* The menu window's WGL context */
625 /* This structure describes a menu */
626 typedef struct tagSFG_Window SFG_Window;
627 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
628 typedef struct tagSFG_Menu SFG_Menu;
632 void *UserData; /* User data passed back at callback */
633 int ID; /* The global menu ID */
634 SFG_List Entries; /* The menu entries list */
635 FGCBMenu Callback; /* The menu callback */
636 FGCBDestroy Destroy; /* Destruction callback */
637 GLboolean IsActive; /* Is the menu selected? */
638 int Width; /* Menu box width in pixels */
639 int Height; /* Menu box height in pixels */
640 int X, Y; /* Menu box raster position */
642 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
643 SFG_Window *Window; /* Window for menu */
644 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
647 /* This is a menu entry */
648 struct tagSFG_MenuEntry
651 int ID; /* The menu entry ID (local) */
652 int Ordinal; /* The menu's ordinal number */
653 char* Text; /* The text to be displayed */
654 SFG_Menu* SubMenu; /* Optional sub-menu tree */
655 GLboolean IsActive; /* Is the entry highlighted? */
656 int Width; /* Label's width in pixels */
660 * A window, making part of freeglut windows hierarchy.
661 * Should be kept portable.
663 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
668 int ID; /* Window's ID number */
670 SFG_Context Window; /* Window and OpenGL context */
671 SFG_WindowState State; /* The window state */
672 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
673 void *UserData ; /* For use by user */
675 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
676 SFG_Menu* ActiveMenu; /* The window's active menu */
678 SFG_Window* Parent; /* The parent to this window */
679 SFG_List Children; /* The subwindows d.l. list */
681 GLboolean IsMenu; /* Set to 1 if we are a menu */
685 /* A linked list structure of windows */
686 typedef struct tagSFG_WindowList SFG_WindowList ;
687 struct tagSFG_WindowList
693 /* This holds information about all the windows, menus etc. */
694 typedef struct tagSFG_Structure SFG_Structure;
695 struct tagSFG_Structure
697 SFG_List Windows; /* The global windows list */
698 SFG_List Menus; /* The global menus list */
699 SFG_List WindowsToDestroy;
701 SFG_Window* CurrentWindow; /* The currently set window */
702 SFG_Menu* CurrentMenu; /* Same, but menu... */
704 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
706 SFG_Window* GameModeWindow; /* The game mode window */
708 int WindowID; /* The new current window ID */
709 int MenuID; /* The new current menu ID */
713 * This structure is used for the enumeration purposes.
714 * You can easily extend its functionalities by declaring
715 * a structure containing enumerator's contents and custom
716 * data, then casting its pointer to (SFG_Enumerator *).
718 typedef struct tagSFG_Enumerator SFG_Enumerator;
719 struct tagSFG_Enumerator
721 GLboolean found; /* Used to terminate search */
722 void* data; /* Custom data pointer */
724 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
726 /* The bitmap font structure */
727 typedef struct tagSFG_Font SFG_Font;
730 char* Name; /* The source font name */
731 int Quantity; /* Number of chars in font */
732 int Height; /* Height of the characters */
733 const GLubyte** Characters; /* The characters mapping */
735 float xorig, yorig; /* Relative origin of the character */
738 /* The stroke font structures */
740 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
741 struct tagSFG_StrokeVertex
746 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
747 struct tagSFG_StrokeStrip
750 const SFG_StrokeVertex* Vertices;
753 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
754 struct tagSFG_StrokeChar
758 const SFG_StrokeStrip* Strips;
761 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
762 struct tagSFG_StrokeFont
764 char* Name; /* The source font name */
765 int Quantity; /* Number of chars in font */
766 GLfloat Height; /* Height of the characters */
767 const SFG_StrokeChar** Characters; /* The characters mapping */
770 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
772 /* Freeglut display related stuff (initialized once per session) */
773 extern SFG_Display fgDisplay;
775 /* Freeglut internal structure */
776 extern SFG_Structure fgStructure;
778 /* The current freeglut settings */
779 extern SFG_State fgState;
782 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
785 * A call to this function makes us sure that the Display and Structure
786 * subsystems have been properly initialized and are ready to be used
788 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
789 if ( ! fgState.Initialised ) \
791 fgError ( " ERROR: Function <%s> called" \
792 " without first calling 'glutInit'.", (string) ) ; \
795 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
796 if ( ! fgState.Initialised ) \
798 fgError ( " ERROR: Internal <%s> function called" \
799 " without first calling 'glutInit'.", (string) ) ; \
802 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
805 fgError ( " ERROR: Internal error <%s> in function %s", \
806 (string), (function) ) ; \
810 * Following definitions are somewhat similiar to GLib's,
811 * but do not generate any log messages:
813 #define freeglut_return_if_fail( expr ) \
816 #define freeglut_return_val_if_fail( expr, val ) \
821 * A call to those macros assures us that there is a current
822 * window set, respectively:
824 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
825 if ( ! fgStructure.CurrentWindow && \
826 ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) ) \
828 fgError ( " ERROR: Function <%s> called" \
829 " with no current window defined.", (string) ) ; \
833 * The deinitialize function gets called on glutMainLoop() end. It should clean up
834 * everything inside of the freeglut
836 void fgDeinitialize( void );
839 * Those two functions are used to create/destroy the freeglut internal
840 * structures. This actually happens when calling glutInit() and when
841 * quitting the glutMainLoop() (which actually happens, when all windows
844 void fgCreateStructure( void );
845 void fgDestroyStructure( void );
847 /* A helper function to check if a display mode is possible to use */
848 #if TARGET_HOST_POSIX_X11
849 GLXFBConfig* fgChooseFBConfig( int* numcfgs );
852 /* The window procedure for Win32 events handling */
853 #if TARGET_HOST_MS_WINDOWS
854 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
855 WPARAM wParam, LPARAM lParam );
856 void fgNewWGLCreateContext( SFG_Window* window );
857 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
858 unsigned char layer_type );
862 * Window creation, opening, closing and destruction.
863 * Also CallBack clearing/initialization.
864 * Defined in freeglut_structure.c, freeglut_window.c.
866 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
867 GLboolean positionUse, int x, int y,
868 GLboolean sizeUse, int w, int h,
869 GLboolean gameMode, GLboolean isMenu );
870 void fgSetWindow ( SFG_Window *window );
871 void fgOpenWindow( SFG_Window* window, const char* title,
872 GLboolean positionUse, int x, int y,
873 GLboolean sizeUse, int w, int h,
874 GLboolean gameMode, GLboolean isSubWindow );
875 void fgCloseWindow( SFG_Window* window );
876 void fgAddToWindowDestroyList ( SFG_Window* window );
877 void fgCloseWindows ();
878 void fgDestroyWindow( SFG_Window* window );
880 /* Menu creation and destruction. Defined in freeglut_structure.c */
881 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
882 void fgDestroyMenu( SFG_Menu* menu );
884 /* Joystick device management functions, defined in freeglut_joystick.c */
885 int fgJoystickDetect( void );
886 void fgInitialiseJoysticks( void );
887 void fgJoystickClose( void );
888 void fgJoystickPollWindow( SFG_Window* window );
890 /* InputDevice Initialisation and Closure */
891 int fgInputDeviceDetect( void );
892 void fgInitialiseInputDevices( void );
893 void fgInputDeviceClose( void );
895 /* spaceball device functions, defined in freeglut_spaceball.c */
896 void fgInitialiseSpaceball( void );
897 void fgSpaceballClose( void );
898 void fgSpaceballSetWindow( SFG_Window *window );
900 int fgHasSpaceball( void );
901 int fgSpaceballNumButtons( void );
903 #if TARGET_HOST_POSIX_X11
904 int fgIsSpaceballXEvent( const XEvent *ev );
905 void fgSpaceballHandleXEvent( const XEvent *ev );
908 /* Setting the cursor for a given window */
909 void fgSetCursor ( SFG_Window *window, int cursorID );
912 * Helper function to enumerate through all registered windows
913 * and one to enumerate all of a window's subwindows...
915 * The GFunc callback for those functions will be defined as:
917 * void enumCallback( gpointer window, gpointer enumerator );
919 * where window is the enumerated (sub)window pointer (SFG_Window *),
920 * and userData is the a custom user-supplied pointer. Functions
921 * are defined and exported from freeglut_structure.c file.
923 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
924 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
925 SFG_Enumerator* enumerator );
928 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
929 * first window in the queue matching the specified window handle.
930 * The function is defined in freeglut_structure.c file.
932 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
935 * This function is similiar to the previous one, except it is
936 * looking for a specified (sub)window identifier. The function
937 * is defined in freeglut_structure.c file.
939 SFG_Window* fgWindowByID( int windowID );
942 * Looks up a menu given its ID. This is easier than fgWindowByXXX
943 * as all menus are placed in a single doubly linked list...
945 SFG_Menu* fgMenuByID( int menuID );
948 * The menu activation and deactivation the code. This is the meat
949 * of the menu user interface handling code...
951 void fgUpdateMenuHighlight ( SFG_Menu *menu );
952 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
953 int mouse_x, int mouse_y );
954 void fgDeactivateMenu( SFG_Window *window );
957 * This function gets called just before the buffers swap, so that
958 * freeglut can display the pull-down menus via OpenGL. The function
959 * is defined in freeglut_menu.c file.
961 void fgDisplayMenu( void );
963 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
964 long fgElapsedTime( void );
966 /* System time in milliseconds */
967 long unsigned fgSystemTime(void);
970 void fgListInit(SFG_List *list);
971 void fgListAppend(SFG_List *list, SFG_Node *node);
972 void fgListRemove(SFG_List *list, SFG_Node *node);
973 int fgListLength(SFG_List *list);
974 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
976 /* Error Message functions */
977 void fgError( const char *fmt, ... );
978 void fgWarning( const char *fmt, ... );
981 * Check if "hint" is present in "property" for "window". See freeglut_init.c
983 #if TARGET_HOST_POSIX_X11
984 int fgHintPresent(Window window, Atom property, Atom hint);
986 /* Handler for X extension Events */
987 #ifdef HAVE_X11_EXTENSIONS_XINPUT2_H
988 void fgHandleExtensionEvents( XEvent * ev );
989 void fgRegisterDevices( Display* dpy, Window* win );
994 SFG_Proc fghGetProcAddress( const char *procName );
996 #if TARGET_HOST_MS_WINDOWS
997 extern void (__cdecl *__glutExitFunc)( int return_value );
1000 #endif /* FREEGLUT_INTERNAL_H */
1002 /*** END OF FILE ***/