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 #include "fg_version.h"
37 /* Freeglut is intended to function under all Unix/X11 and Win32 platforms. */
38 /* XXX: Don't all MS-Windows compilers (except Cygwin) have _WIN32 defined?
39 * XXX: If so, remove the first set of defined()'s below.
41 #if !defined(TARGET_HOST_POSIX_X11) && !defined(TARGET_HOST_MS_WINDOWS) && !defined(TARGET_HOST_MAC_OSX) && !defined(TARGET_HOST_SOLARIS)
42 #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__MINGW32__) \
43 || defined(_WIN32) || defined(_WIN32_WCE) \
44 || ( defined(__CYGWIN__) && defined(X_DISPLAY_MISSING) )
45 # define TARGET_HOST_MS_WINDOWS 1
47 #elif defined (__ANDROID__)
48 # define TARGET_HOST_ANDROID 1
50 #elif defined (__QNXNTO__) || defined (__PLAYBOOK__)
51 # define TARGET_HOST_BLACKBERRY 1
53 #elif defined(__posix__) || defined(__unix__) || defined(__linux__) || defined(__sun)
54 # if defined(FREEGLUT_WAYLAND)
55 # define TARGET_HOST_POSIX_WAYLAND 1
57 # define TARGET_HOST_POSIX_X11 1
60 #elif defined(__APPLE__)
61 /* This is a placeholder until we get native OSX support ironed out -- JFF 11/18/09 */
62 # define TARGET_HOST_POSIX_X11 1
63 /* # define TARGET_HOST_MAC_OSX 1 */
66 # error "Unrecognized target host!"
71 /* Detect both SunPro and gcc compilers on Sun Solaris */
72 #if defined (__SVR4) && defined (__sun)
73 # define TARGET_HOST_SOLARIS 1
76 #ifndef TARGET_HOST_MS_WINDOWS
77 # define TARGET_HOST_MS_WINDOWS 0
80 #ifndef TARGET_HOST_ANDROID
81 # define TARGET_HOST_ANDROID 0
84 #ifndef TARGET_HOST_BLACKBERRY
85 # define TARGET_HOST_BLACKBERRY 0
88 #ifndef TARGET_HOST_POSIX_WAYLAND
89 # define TARGET_HOST_POSIX_WAYLAND 0
92 #ifndef TARGET_HOST_POSIX_X11
93 # define TARGET_HOST_POSIX_X11 0
96 #ifndef TARGET_HOST_MAC_OSX
97 # define TARGET_HOST_MAC_OSX 0
100 #ifndef TARGET_HOST_SOLARIS
101 # define TARGET_HOST_SOLARIS 0
104 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
106 #define FREEGLUT_MAX_MENUS 3
108 /* These files should be available on every platform. */
115 /* These are included based on autoconf directives. */
116 #ifdef HAVE_SYS_TYPES_H
117 # include <sys/types.h>
122 #ifdef TIME_WITH_SYS_TIME
123 # include <sys/time.h>
125 #elif defined(HAVE_SYS_TIME_H)
126 # include <sys/time.h>
131 /* -- AUTOCONF HACKS --------------------------------------------------------*/
133 /* XXX: Update autoconf to avoid these.
134 * XXX: Are non-POSIX platforms intended not to use autoconf?
135 * If so, perhaps there should be a config_guess.h for them. Alternatively,
136 * config guesses could be placed above, just after the config.h exclusion.
138 #if defined(__FreeBSD__) || defined(__NetBSD__)
139 # define HAVE_USB_JS 1
140 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
141 # define HAVE_USBHID_H 1
145 #if defined(_MSC_VER) || defined(__WATCOMC__)
146 /* strdup() is non-standard, for all but POSIX-2001 */
147 #define strdup _strdup
150 /* M_PI is non-standard (defined by BSD, not ISO-C) */
152 # define M_PI 3.14159265358979323846
155 #ifdef HAVE_STDBOOL_H
156 # include <stdbool.h>
172 /* General defines */
173 #define INVALID_MODIFIERS 0xffffffff
175 /* FreeGLUT internal time type */
176 #if defined(HAVE_STDINT_H)
178 typedef uint64_t fg_time_t;
179 #elif defined(HAVE_INTTYPES_H)
180 # include <inttypes.h>
181 typedef uint64_t fg_time_t;
182 #elif defined(HAVE_U__INT64)
183 typedef unsigned __int64 fg_time_t;
184 #elif defined(HAVE_ULONG_LONG)
185 typedef unsigned long long fg_time_t;
187 typedef unsigned long fg_time_t;
192 # define __fg_unused __attribute__((unused))
198 /* Platform-specific includes */
199 #if TARGET_HOST_POSIX_WAYLAND
200 #include "wayland/fg_internal_wl.h"
202 #if TARGET_HOST_POSIX_X11
203 #include "x11/fg_internal_x11.h"
205 #if TARGET_HOST_MS_WINDOWS
206 #include "mswin/fg_internal_mswin.h"
208 #if TARGET_HOST_ANDROID
209 #include "android/fg_internal_android.h"
211 #if TARGET_HOST_BLACKBERRY
212 #include "blackberry/fg_internal_blackberry.h"
216 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
218 /* Freeglut callbacks type definitions */
219 typedef void* FGCBUserData;
221 typedef void (* FGCBDisplay )( void );
222 typedef void (* FGCBReshape )( int, int );
223 typedef void (* FGCBPosition )( int, int );
224 typedef void (* FGCBVisibility )( int );
225 typedef void (* FGCBKeyboard )( unsigned char, int, int );
226 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
227 typedef void (* FGCBSpecial )( int, int, int );
228 typedef void (* FGCBSpecialUp )( int, int, int );
229 typedef void (* FGCBMouse )( int, int, int, int );
230 typedef void (* FGCBMouseWheel )( int, int, int, int );
231 typedef void (* FGCBMotion )( int, int );
232 typedef void (* FGCBPassive )( int, int );
233 typedef void (* FGCBEntry )( int );
234 typedef void (* FGCBWindowStatus )( int );
235 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
236 typedef void (* FGCBOverlayDisplay)( void );
237 typedef void (* FGCBSpaceMotion )( int, int, int );
238 typedef void (* FGCBSpaceRotation )( int, int, int );
239 typedef void (* FGCBSpaceButton )( int, int );
240 typedef void (* FGCBDials )( int, int );
241 typedef void (* FGCBButtonBox )( int, int );
242 typedef void (* FGCBTabletMotion )( int, int );
243 typedef void (* FGCBTabletButton )( int, int, int, int );
244 typedef void (* FGCBDestroy )( void ); /* Used for both window and menu destroy callbacks */
246 typedef void (* FGCBMultiEntry )( int, int );
247 typedef void (* FGCBMultiButton )( int, int, int, int, int );
248 typedef void (* FGCBMultiMotion )( int, int, int );
249 typedef void (* FGCBMultiPassive )( int, int, int );
251 typedef void (* FGCBInitContext)();
252 typedef void (* FGCBAppStatus)(int);
254 /* The global callbacks type definitions */
255 typedef void (* FGCBIdle )( void );
256 typedef void (* FGCBIdleUC )( FGCBUserData );
257 typedef void (* FGCBTimer )( int );
258 typedef void (* FGCBTimerUC )( int, FGCBUserData );
259 typedef void (* FGCBMenuState )( int );
260 typedef void (* FGCBMenuStatus )( int, int, int );
262 /* The callback used when creating/using menus */
263 typedef void (* FGCBMenu )( int );
264 typedef void (* FGCBMenuUC )( int, FGCBUserData );
266 /* The FreeGLUT error/warning handler type definition */
267 typedef void (* FGError ) ( const char *fmt, va_list ap);
268 typedef void (* FGWarning ) ( const char *fmt, va_list ap);
271 /* A list structure */
272 typedef struct tagSFG_List SFG_List;
279 /* A list node structure */
280 typedef struct tagSFG_Node SFG_Node;
287 /* A helper structure holding two ints and a boolean */
288 typedef struct tagSFG_XYUse SFG_XYUse;
291 GLint X, Y; /* The two integers... */
292 GLboolean Use; /* ...and a single boolean. */
296 * An enumeration containing the state of the GLUT execution:
297 * initializing, running, or stopping
301 GLUT_EXEC_STATE_INIT,
302 GLUT_EXEC_STATE_RUNNING,
306 /* This structure holds different freeglut settings */
307 typedef struct tagSFG_State SFG_State;
310 SFG_XYUse Position; /* The default windows' position */
311 SFG_XYUse Size; /* The default windows' size */
312 unsigned int DisplayMode; /* Display mode for new windows */
314 GLboolean Initialised; /* freeglut has been initialised */
316 int DirectContext; /* Direct rendering state */
318 GLboolean ForceIconic; /* New top windows are iconified */
319 GLboolean UseCurrentContext; /* New windows share with current */
321 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
322 GLboolean XSyncSwitch; /* X11 sync protocol switch */
324 int KeyRepeat; /* Global key repeat mode. */
325 int Modifiers; /* Current ALT/SHIFT/CTRL state */
327 GLuint FPSInterval; /* Interval between FPS printfs */
328 GLuint SwapCount; /* Count of glutSwapBuffer calls */
329 GLuint SwapTime; /* Time of last SwapBuffers */
331 fg_time_t Time; /* Time that glutInit was called */
332 SFG_List Timers; /* The freeglut timer hooks */
333 SFG_List FreeTimers; /* The unused timer hooks */
335 FGCBIdleUC IdleCallback; /* The global idle callback */
336 FGCBUserData IdleCallbackData; /* The global idle callback data */
338 int ActiveMenus; /* Num. of currently active menus */
339 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
340 FGCBMenuStatus MenuStatusCallback;
341 void* MenuFont; /* Font to be used for newly created menus */
343 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
344 int GameModeDepth; /* The pixel depth for game mode */
345 int GameModeRefresh; /* The refresh rate for game mode */
347 int ActionOnWindowClose; /* Action when user closes window */
349 fgExecutionState ExecState; /* Used for GLUT termination */
350 char *ProgramName; /* Name of the invoking program */
351 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
352 int NumActiveJoysticks; /* Number of active joysticks (callback defined and positive pollrate) -- if zero, don't poll joysticks */
353 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
355 int MouseWheelTicks; /* Number of ticks the mouse wheel has turned */
357 int AuxiliaryBufferNumber; /* Number of auxiliary buffers */
358 int SampleNumber; /* Number of samples per pixel */
360 GLboolean SkipStaleMotion; /* skip stale motion events */
362 GLboolean StrokeFontDrawJoinDots;/* Draw dots between line segments of stroke fonts? */
363 GLboolean AllowNegativeWindowPosition; /* GLUT, by default, doesn't allow negative window positions. Enable it? */
365 int MajorVersion; /* Major OpenGL context version */
366 int MinorVersion; /* Minor OpenGL context version */
367 int ContextFlags; /* OpenGL context flags */
368 int ContextProfile; /* OpenGL context profile */
369 int HasOpenGL20; /* fgInitGL2 could find all OpenGL 2.0 functions */
370 FGError ErrorFunc; /* User defined error handler */
371 FGWarning WarningFunc; /* User defined warning handler */
374 /* The structure used by display initialization in fg_init.c */
375 typedef struct tagSFG_Display SFG_Display;
376 struct tagSFG_Display
378 SFG_PlatformDisplay pDisplay;
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 FGCBTimerUC Callback; /* The timer callback */
394 FGCBUserData CallbackData; /* The timer callback user data */
395 fg_time_t TriggerTime; /* The timer trigger time */
399 * A window and its OpenGL context. The contents of this structure
400 * are highly dependent on the target operating system we aim at...
402 typedef struct tagSFG_Context SFG_Context;
403 struct tagSFG_Context
405 SFG_WindowHandleType Handle; /* The window's handle */
406 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
408 SFG_PlatformContext pContext; /* The window's FBConfig (X11) or device context (Windows) */
410 int DoubleBuffered; /* Treat the window as double-buffered */
412 /* When drawing geometry to vertex attribute buffers, user specifies
413 * the attribute indices for vertices, normals and/or texture coords
414 * to freeglut. Those are stored here
416 GLint attribute_v_coord;
417 GLint attribute_v_normal;
418 GLint attribute_v_texture;
423 * Bitmasks indicating the different kinds of
424 * actions that can be scheduled for a window.
426 #define GLUT_INIT_WORK (1<<0)
427 #define GLUT_VISIBILITY_WORK (1<<1)
428 #define GLUT_POSITION_WORK (1<<2)
429 #define GLUT_SIZE_WORK (1<<3)
430 #define GLUT_ZORDER_WORK (1<<4)
431 #define GLUT_FULL_SCREEN_WORK (1<<5)
432 #define GLUT_DISPLAY_WORK (1<<6)
435 * An enumeration containing the desired mapping state of a window
442 } fgDesiredVisibility ;
445 * There is considerable confusion about the "right thing to
446 * do" concerning window size and position. GLUT itself is
447 * not consistent between Windows and UNIX/X11; since
448 * platform independence is a virtue for "freeglut", we
449 * decided to break with GLUT's behaviour.
451 * Under UNIX/X11, it is apparently not possible to get the
452 * window border sizes in order to subtract them off the
453 * window's initial position until some time after the window
454 * has been created. Therefore we decided on the following
455 * behaviour, both under Windows and under UNIX/X11:
456 * - When you create a window with position (x,y) and size
457 * (w,h), the upper left hand corner of the outside of the
458 * window is at (x,y) and the size of the drawable area is
460 * - When you query the size and position of the window--as
461 * is happening here for Windows--"freeglut" will return
462 * the size of the drawable area--the (w,h) that you
463 * specified when you created the window--and the coordinates
464 * of the upper left hand corner of the drawable area, i.e.
465 * of the client rect--which is NOT the (x,y) you specified.
467 typedef struct tagSFG_WindowState SFG_WindowState;
468 struct tagSFG_WindowState /* as per notes above, sizes always refer to the client area (thus without the window decorations) */
470 /* window state - size, position, look */
471 int Xpos; /* Window's top-left of client area, X-coordinate */
472 int Ypos; /* Window's top-left of client area, Y-coordinate */
473 int Width; /* Window's width in pixels */
474 int Height; /* The same about the height */
475 GLboolean Visible; /* Is the window visible now? Not using fgVisibilityState as we only care if visible or not */
476 int Cursor; /* The currently selected cursor style */
477 GLboolean IsFullscreen; /* is the window fullscreen? */
479 /* FreeGLUT operations are deferred, that is, window moving, resizing,
480 * Z-order changing, making full screen or not do not happen immediately
481 * upon the user's request, but only in the next iteration of the main
482 * loop, before the display callback is called. This allows multiple
483 * reshape, position, etc requests to be combined into one and is
484 * compatible with the way GLUT does things. Callbacks get triggered
485 * based on the feedback/messages/notifications from the window manager.
486 * Below here we define what work should be done, as well as the relevant
487 * parameters for this work.
489 unsigned int WorkMask; /* work (resize, etc) to be done on the window */
490 int DesiredXpos; /* desired X location */
491 int DesiredYpos; /* desired Y location */
492 int DesiredWidth; /* desired window width */
493 int DesiredHeight; /* desired window height */
494 int DesiredZOrder; /* desired window Z Order position */
495 fgDesiredVisibility DesiredVisibility;/* desired visibility (hidden, iconic, shown/normal) */
497 SFG_PlatformWindowState pWState; /* Window width/height (X11) or rectangle/style (Windows) from before a resize, and other stuff only needed on specific platforms */
499 long JoystickPollRate; /* The joystick polling rate */
500 fg_time_t JoystickLastPoll; /* When the last poll happened */
502 int MouseX, MouseY; /* The most recent mouse position */
504 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
506 GLboolean VisualizeNormals; /* When drawing objects, draw vectors representing the normals as well? */
511 * A generic function pointer. We should really use the GLUTproc type
512 * defined in freeglut_ext.h, but if we include that header in this file
513 * a bunch of other stuff (font-related) blows up!
515 typedef void (*SFG_Proc)();
519 * SET_WCB() is used as:
521 * SET_WCB( window, cbname, func );
523 * ...where {window} is the freeglut window to set the callback,
524 * {cbname} is the window-specific callback to set,
525 * {func} is a function-pointer.
527 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
528 * but this can cause warnings because the FETCH_WCB() macro type-
529 * casts its result, and a type-cast value shouldn't be an lvalue.
531 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
532 * and for no other reason. Since it's hidden in the macro, the
533 * ugliness is felt to be rather benign.
535 #define SET_WCB(window,cbname,func) \
538 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
539 (((window).CallBacks[WCB_ ## cbname]) = (SFG_Proc)(func)); \
543 * FETCH_WCB() is used as:
545 * FETCH_WCB( window, cbname );
547 * ...where {window} is the freeglut window to fetch the callback from,
548 * {cbname} is the window-specific callback to fetch.
550 * The result is correctly type-cast to the callback function pointer
553 #define FETCH_WCB(window,cbname) \
554 ((window).CallBacks[WCB_ ## cbname])
557 * INVOKE_WCB() is used as:
559 * INVOKE_WCB( window, cbname, ( arg_list ) );
561 * ...where {window} is the freeglut window,
562 * {cbname} is the window-specific callback to be invoked,
563 * {(arg_list)} is the parameter list.
565 * The callback is invoked as:
567 * callback( arg_list );
569 * ...so the parentheses are REQUIRED in the {arg_list}.
571 * NOTE that it does a sanity-check and also sets the
575 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
576 #define INVOKE_WCB(window,cbname,arg_list) \
579 if( FETCH_WCB( window, cbname ) ) \
581 FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
582 fgSetWindow( &window ); \
587 #define INVOKE_WCB(window,cbname,arg_list) \
590 if( FETCH_WCB( window, cbname ) ) \
592 fgSetWindow( &window ); \
593 ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
599 * The window callbacks the user can supply us with. Should be kept portable.
601 * This enumeration provides the freeglut CallBack numbers.
602 * The symbolic constants are indices into a window's array of
603 * function callbacks. The names are formed by splicing a common
604 * prefix onto the callback's base name. (This was originally
605 * done so that an early stage of development could live side-by-
606 * side with the old callback code. The old callback code used
607 * the bare callback's name as a structure member, so I used a
608 * prefix for the array index name.)
629 /* Multi-Pointer X and touch related */
635 /* Mobile platforms LifeCycle */
639 /* Presently ignored */
642 WCB_SpaceMotion, /* presently implemented only on UNIX/X11 and Windows */
643 WCB_SpaceRotation, /* presently implemented only on UNIX/X11 and Windows */
644 WCB_SpaceButton, /* presently implemented only on UNIX/X11 and Windows */
650 /* Always make this the LAST one */
655 /* This structure holds the OpenGL rendering context for all the menu windows */
656 typedef struct tagSFG_MenuContext SFG_MenuContext;
657 struct tagSFG_MenuContext
659 SFG_WindowContextType MContext; /* The menu window's WGL context */
662 /* This structure describes a menu */
663 typedef struct tagSFG_Window SFG_Window;
664 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
665 typedef struct tagSFG_Menu SFG_Menu;
669 void *UserData; /* User data passed back at callback */
670 int ID; /* The global menu ID */
671 SFG_List Entries; /* The menu entries list */
672 FGCBMenuUC Callback; /* The menu callback */
673 FGCBUserData CallbackData; /* The menu callback user data */
674 FGCBDestroy Destroy; /* Destruction callback */
675 GLboolean IsActive; /* Is the menu selected? */
676 void* Font; /* Font to be used for displaying this menu */
677 int Width; /* Menu box width in pixels */
678 int Height; /* Menu box height in pixels */
679 int X, Y; /* Menu box raster position */
681 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
682 SFG_Window *Window; /* Window for menu */
683 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
686 /* This is a menu entry */
687 struct tagSFG_MenuEntry
690 int ID; /* The menu entry ID (local) */
691 int Ordinal; /* The menu's ordinal number */
692 char* Text; /* The text to be displayed */
693 SFG_Menu* SubMenu; /* Optional sub-menu tree */
694 GLboolean IsActive; /* Is the entry highlighted? */
695 int Width; /* Label's width in pixels */
699 * A window, making part of freeglut windows hierarchy.
700 * Should be kept portable.
702 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
707 int ID; /* Window's ID number */
709 SFG_Context Window; /* Window and OpenGL context */
710 SFG_WindowState State; /* The window state */
711 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
712 void *UserData ; /* For use by user */
714 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
715 SFG_Menu* ActiveMenu; /* The window's active menu */
717 SFG_Window* Parent; /* The parent to this window */
718 SFG_List Children; /* The subwindows d.l. list */
720 GLboolean IsMenu; /* Set to 1 if we are a menu */
724 /* A linked list structure of windows */
725 typedef struct tagSFG_WindowList SFG_WindowList ;
726 struct tagSFG_WindowList
732 /* This holds information about all the windows, menus etc. */
733 typedef struct tagSFG_Structure SFG_Structure;
734 struct tagSFG_Structure
736 SFG_List Windows; /* The global windows list */
737 SFG_List Menus; /* The global menus list */
738 SFG_List WindowsToDestroy;
740 SFG_Window* CurrentWindow; /* The currently set window */
741 SFG_Menu* CurrentMenu; /* Same, but menu... */
743 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
745 SFG_Window* GameModeWindow; /* The game mode window */
747 int WindowID; /* The window ID for the next window to be created */
748 int MenuID; /* The menu ID for the next menu to be created */
752 * This structure is used for the enumeration purposes.
753 * You can easily extend its functionalities by declaring
754 * a structure containing enumerator's contents and custom
755 * data, then casting its pointer to (SFG_Enumerator *).
757 typedef struct tagSFG_Enumerator SFG_Enumerator;
758 struct tagSFG_Enumerator
760 GLboolean found; /* Used to terminate search */
761 void* data; /* Custom data pointer */
763 typedef void (* FGCBWindowEnumerator )( SFG_Window *, SFG_Enumerator * );
764 typedef void (* FGCBMenuEnumerator )( SFG_Menu *, SFG_Enumerator * );
766 /* The bitmap font structure */
767 typedef struct tagSFG_Font SFG_Font;
770 char* Name; /* The source font name */
771 int Quantity; /* Number of chars in font */
772 int Height; /* Height of the characters */
773 const GLubyte** Characters; /* The characters mapping */
775 float xorig, yorig; /* Relative origin of the character */
778 /* The stroke font structures */
780 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
781 struct tagSFG_StrokeVertex
786 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
787 struct tagSFG_StrokeStrip
790 const SFG_StrokeVertex* Vertices;
793 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
794 struct tagSFG_StrokeChar
798 const SFG_StrokeStrip* Strips;
801 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
802 struct tagSFG_StrokeFont
804 char* Name; /* The source font name */
805 int Quantity; /* Number of chars in font */
806 GLfloat Height; /* Height of the characters */
807 const SFG_StrokeChar** Characters; /* The characters mapping */
811 /* -- JOYSTICK-SPECIFIC STRUCTURES AND TYPES ------------------------------- */
813 * Initial defines from "js.h" starting around line 33 with the existing "fg_joystick.c"
817 #if TARGET_HOST_MACINTOSH
818 # include <InputSprocket.h>
821 #if TARGET_HOST_MAC_OSX
822 # include <mach/mach.h>
823 # include <IOKit/IOkitLib.h>
824 # include <IOKit/hid/IOHIDLib.h>
827 /* XXX It might be better to poll the operating system for the numbers of buttons and
828 * XXX axes and then dynamically allocate the arrays.
830 #define _JS_MAX_BUTTONS 32
832 #if TARGET_HOST_MACINTOSH
833 # define _JS_MAX_AXES 9
834 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
835 struct tagSFG_PlatformJoystick
837 #define ISP_NUM_AXIS 9
838 #define ISP_NUM_NEEDS 41
839 ISpElementReference isp_elem [ ISP_NUM_NEEDS ];
840 ISpNeed isp_needs [ ISP_NUM_NEEDS ];
844 #if TARGET_HOST_MAC_OSX
845 # define _JS_MAX_AXES 16
846 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
847 struct tagSFG_PlatformJoystick
849 IOHIDDeviceInterface ** hidDev;
850 IOHIDElementCookie buttonCookies[41];
851 IOHIDElementCookie axisCookies[_JS_MAX_AXES];
852 /* The next two variables are not used anywhere */
853 /* long minReport[_JS_MAX_AXES],
854 * maxReport[_JS_MAX_AXES];
861 * Definition of "SFG_Joystick" structure -- based on JS's "jsJoystick" object class.
862 * See "js.h" lines 80-178.
864 typedef struct tagSFG_Joystick SFG_Joystick;
865 struct tagSFG_Joystick
867 SFG_PlatformJoystick pJoystick;
875 float dead_band[ _JS_MAX_AXES ];
876 float saturate [ _JS_MAX_AXES ];
877 float center [ _JS_MAX_AXES ];
878 float max [ _JS_MAX_AXES ];
879 float min [ _JS_MAX_AXES ];
884 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
886 /* Freeglut display related stuff (initialized once per session) */
887 extern SFG_Display fgDisplay;
889 /* Freeglut internal structure */
890 extern SFG_Structure fgStructure;
892 /* The current freeglut settings */
893 extern SFG_State fgState;
896 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
899 * A call to this function makes us sure that the Display and Structure
900 * subsystems have been properly initialized and are ready to be used
902 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
903 if ( ! fgState.Initialised ) \
905 fgError ( " ERROR: Function <%s> called" \
906 " without first calling 'glutInit'.", (string) ) ; \
909 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
910 if ( ! fgState.Initialised ) \
912 fgError ( " ERROR: Internal <%s> function called" \
913 " without first calling 'glutInit'.", (string) ) ; \
916 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
919 fgError ( " ERROR: Internal error <%s> in function %s", \
920 (string), (function) ) ; \
924 * Following definitions are somewhat similar to GLib's,
925 * but do not generate any log messages:
927 #define freeglut_return_if_fail( expr ) \
930 #define freeglut_return_val_if_fail( expr, val ) \
935 * A call to those macros assures us that there is a current
936 * window set, respectively:
938 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
939 if ( ! fgStructure.CurrentWindow && \
940 ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) ) \
942 fgError ( " ERROR: Function <%s> called" \
943 " with no current window defined.", (string) ) ; \
947 * The deinitialize function gets called on glutMainLoop() end. It should clean up
948 * everything inside of the freeglut
950 void fgDeinitialize( void );
953 * Those two functions are used to create/destroy the freeglut internal
954 * structures. This actually happens when calling glutInit() and when
955 * quitting the glutMainLoop() (which actually happens, when all windows
958 void fgCreateStructure( void );
959 void fgDestroyStructure( void );
962 * Window creation, opening, closing and destruction.
963 * Also CallBack clearing/initialization.
964 * Defined in fg_structure.c, fg_window.c.
966 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
967 GLboolean positionUse, int x, int y,
968 GLboolean sizeUse, int w, int h,
969 GLboolean gameMode, GLboolean isMenu );
970 void fgSetWindow ( SFG_Window *window );
971 void fgOpenWindow( SFG_Window* window, const char* title,
972 GLboolean positionUse, int x, int y,
973 GLboolean sizeUse, int w, int h,
974 GLboolean gameMode, GLboolean isSubWindow );
975 void fgCloseWindow( SFG_Window* window );
976 void fgAddToWindowDestroyList ( SFG_Window* window );
977 void fgCloseWindows ();
978 void fgDestroyWindow( SFG_Window* window );
980 /* Menu creation and destruction. Defined in fg_structure.c */
981 SFG_Menu* fgCreateMenu( FGCBMenuUC menuCallback, FGCBUserData userData );
982 void fgDestroyMenu( SFG_Menu* menu );
984 /* Joystick device management functions, defined in fg_joystick.c */
985 int fgJoystickDetect( void );
986 void fgInitialiseJoysticks( void );
987 void fgJoystickClose( void );
988 void fgJoystickPollWindow( SFG_Window* window );
990 /* InputDevice Initialisation and Closure */
991 int fgInputDeviceDetect( void );
992 void fgInitialiseInputDevices( void );
993 void fgInputDeviceClose( void );
995 /* spaceball device functions, defined in fg_spaceball.c */
996 void fgInitialiseSpaceball( void );
997 void fgSpaceballClose( void );
998 void fgSpaceballSetWindow( SFG_Window *window );
1000 int fgHasSpaceball( void );
1001 int fgSpaceballNumButtons( void );
1003 /* Setting the cursor for a given window */
1004 void fgSetCursor ( SFG_Window *window, int cursorID );
1007 * Helper function to enumerate through all registered windows
1008 * and one to enumerate all of a window's subwindows...
1010 * The GFunc callback for those functions will be defined as:
1012 * void enumCallback( gpointer window, gpointer enumerator );
1014 * where window is the enumerated (sub)window pointer (SFG_Window *),
1015 * and userData is the a custom user-supplied pointer. Functions
1016 * are defined and exported from fg_structure.c file.
1018 void fgEnumWindows( FGCBWindowEnumerator enumCallback, SFG_Enumerator* enumerator );
1019 void fgEnumSubWindows( SFG_Window* window, FGCBWindowEnumerator enumCallback,
1020 SFG_Enumerator* enumerator );
1023 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
1024 * first window in the queue matching the specified window handle.
1025 * The function is defined in fg_structure.c file.
1027 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
1030 * This function is similar to the previous one, except it is
1031 * looking for a specified (sub)window identifier. The function
1032 * is defined in fg_structure.c file.
1034 SFG_Window* fgWindowByID( int windowID );
1037 * Looks up a menu given its ID. This is easier than fgWindowByXXX
1038 * as all menus are placed in a single doubly linked list...
1040 SFG_Menu* fgMenuByID( int menuID );
1043 * Returns active menu, if any. Assumption: only one menu active throughout application at any one time.
1044 * This is easier than fgWindowByXXX as all menus are placed in one doubly linked list...
1046 SFG_Menu* fgGetActiveMenu( );
1049 * The menu activation and deactivation the code. This is the meat
1050 * of the menu user interface handling code...
1052 void fgUpdateMenuHighlight ( SFG_Menu *menu );
1053 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
1054 int mouse_x, int mouse_y );
1055 void fgDeactivateMenu( SFG_Window *window );
1058 * This function gets called just before the buffers swap, so that
1059 * freeglut can display the pull-down menus via OpenGL. The function
1060 * is defined in fg_menu.c file.
1062 void fgDisplayMenu( void );
1064 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
1065 fg_time_t fgElapsedTime( void );
1067 /* System time in milliseconds */
1068 fg_time_t fgSystemTime(void);
1070 /* List functions */
1071 void fgListInit(SFG_List *list);
1072 void fgListAppend(SFG_List *list, SFG_Node *node);
1073 void fgListRemove(SFG_List *list, SFG_Node *node);
1074 int fgListLength(SFG_List *list);
1075 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
1077 /* Error Message functions */
1078 void fgError( const char *fmt, ... );
1079 void fgWarning( const char *fmt, ... );
1081 SFG_Proc fgPlatformGetProcAddress( const char *procName );
1083 /* pushing attribute/value pairs into an array */
1084 #define ATTRIB(a) attributes[where++]=(a)
1085 #define ATTRIB_VAL(a,v) {ATTRIB(a); ATTRIB(v);}
1087 int fghMapBit( int mask, int from, int to );
1088 int fghIsLegacyContextRequested( void );
1089 void fghContextCreationError( void );
1090 int fghNumberOfAuxBuffersRequested( void );
1092 #endif /* FREEGLUT_INTERNAL_H */
1094 /*** END OF FILE ***/