git.mutantstargoat.com Git - freeglut/blob - src/Common/freeglut_internal.h

   1 /*\r
   2  * freeglut_internal.h\r
   3  *\r
   4  * The freeglut library private include file.\r
   5  *\r
   6  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.\r
   7  * Written by Pawel W. Olszta, <olszta@sourceforge.net>\r
   8  * Creation date: Thu Dec 2 1999\r
   9  *\r
  10  * Permission is hereby granted, free of charge, to any person obtaining a\r
  11  * copy of this software and associated documentation files (the "Software"),\r
  12  * to deal in the Software without restriction, including without limitation\r
  13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,\r
  14  * and/or sell copies of the Software, and to permit persons to whom the\r
  15  * Software is furnished to do so, subject to the following conditions:\r
  16  *\r
  17  * The above copyright notice and this permission notice shall be included\r
  18  * in all copies or substantial portions of the Software.\r
  19  *\r
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS\r
  21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL\r
  23  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  24  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  25  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  26  */\r
  27 \r
  28 #ifndef  FREEGLUT_INTERNAL_H\r
  29 #define  FREEGLUT_INTERNAL_H\r
  30 \r
  31 #ifdef HAVE_CONFIG_H\r
  32 #    include "config.h"\r
  33 #endif\r
  34 \r
  35 /* XXX Update these for each release! */\r
  36 #define  VERSION_MAJOR 2\r
  37 #define  VERSION_MINOR 7\r
  38 #define  VERSION_PATCH 0\r
  39 \r
  40 /* Freeglut is intended to function under all Unix/X11 and Win32 platforms. */\r
  41 /* XXX: Don't all MS-Windows compilers (except Cygwin) have _WIN32 defined?\r
  42  * XXX: If so, remove the first set of defined()'s below.\r
  43  */\r
  44 #if !defined(TARGET_HOST_POSIX_X11) && !defined(TARGET_HOST_MS_WINDOWS) && !defined(TARGET_HOST_MAC_OSX) && !defined(TARGET_HOST_SOLARIS)\r
  45 #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__MINGW32__) \\r
  46     || defined(_WIN32) || defined(_WIN32_WCE) \\r
  47     || ( defined(__CYGWIN__) && defined(X_DISPLAY_MISSING) )\r
  48 #   define  TARGET_HOST_MS_WINDOWS 1\r
  49 \r
  50 #elif defined(__posix__) || defined(__unix__) || defined(__linux__) || defined(__sun)\r
  51 #   define  TARGET_HOST_POSIX_X11  1\r
  52 \r
  53 #elif defined(__APPLE__)\r
  54 /* This is a placeholder until we get native OSX support ironed out -- JFF 11/18/09 */\r
  55 #   define  TARGET_HOST_POSIX_X11  1\r
  56 /* #   define  TARGET_HOST_MAC_OSX    1 */\r
  57 \r
  58 #else\r
  59 #   error "Unrecognized target host!"\r
  60 \r
  61 #endif\r
  62 #endif\r
  63 \r
  64 /* Detect both SunPro and gcc compilers on Sun Solaris */\r
  65 #if defined (__SVR4) && defined (__sun)\r
  66 #   define TARGET_HOST_SOLARIS 1\r
  67 #endif\r
  68 \r
  69 #ifndef TARGET_HOST_MS_WINDOWS\r
  70 #   define  TARGET_HOST_MS_WINDOWS 0\r
  71 #endif\r
  72 \r
  73 #ifndef  TARGET_HOST_POSIX_X11\r
  74 #   define  TARGET_HOST_POSIX_X11  0\r
  75 #endif\r
  76 \r
  77 #ifndef  TARGET_HOST_MAC_OSX\r
  78 #   define  TARGET_HOST_MAC_OSX    0\r
  79 #endif\r
  80 \r
  81 #ifndef  TARGET_HOST_SOLARIS\r
  82 #   define  TARGET_HOST_SOLARIS    0\r
  83 #endif\r
  84 \r
  85 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */\r
  86 \r
  87 #define  FREEGLUT_MAX_MENUS         3\r
  88 \r
  89 /* -- PLATFORM-SPECIFIC INCLUDES ------------------------------------------- */\r
  90 \r
  91 /* All Win32 headers depend on the huge windows.h recursive include.\r
  92  * Note: Lower-case header names are used, for best cross-platform\r
  93  * compatibility.\r
  94  */\r
  95 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE)\r
  96 #    include <windows.h>\r
  97 #    include <windowsx.h>\r
  98 #    include <mmsystem.h>\r
  99 /* CYGWIN does not have tchar.h, but has TEXT(x), defined in winnt.h. */\r
 100 #    ifndef __CYGWIN__\r
 101 #      include <tchar.h>\r
 102 #    else\r
 103 #      define _TEXT(x) TEXT(x)\r
 104 #      define _T(x)    TEXT(x)\r
 105 #    endif\r
 106 \r
 107 #elif TARGET_HOST_POSIX_X11\r
 108 #    include <GL/glx.h>\r
 109 #    include <X11/Xlib.h>\r
 110 #    include <X11/Xatom.h>\r
 111 #    include <X11/keysym.h>\r
 112 #    include <X11/extensions/XInput.h>\r
 113 #    ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H\r
 114 #        include <X11/extensions/xf86vmode.h>\r
 115 #    endif\r
 116 #    ifdef HAVE_X11_EXTENSIONS_XRANDR_H\r
 117 #        include <X11/extensions/Xrandr.h>\r
 118 #    endif\r
 119 /* If GLX is too old, we will fail during runtime when multisampling\r
 120    is requested, but at least freeglut compiles. */\r
 121 #    ifndef GLX_SAMPLE_BUFFERS\r
 122 #        define GLX_SAMPLE_BUFFERS 0x80A8\r
 123 #    endif\r
 124 #    ifndef GLX_SAMPLES\r
 125 #        define GLX_SAMPLES 0x80A9\r
 126 #    endif\r
 127 \r
 128 #endif\r
 129 \r
 130 /* These files should be available on every platform. */\r
 131 #include <stdio.h>\r
 132 #include <string.h>\r
 133 #include <math.h>\r
 134 #include <stdlib.h>\r
 135 #include <stdarg.h>\r
 136 \r
 137 /* These are included based on autoconf directives. */\r
 138 #ifdef HAVE_SYS_TYPES_H\r
 139 #    include <sys/types.h>\r
 140 #endif\r
 141 #ifdef HAVE_UNISTD_H\r
 142 #    include <unistd.h>\r
 143 #endif\r
 144 #ifdef TIME_WITH_SYS_TIME\r
 145 #    include <sys/time.h>\r
 146 #    include <time.h>\r
 147 #elif defined(HAVE_SYS_TIME_H)\r
 148 #    include <sys/time.h>\r
 149 #else\r
 150 #    include <time.h>\r
 151 #endif\r
 152 \r
 153 /* -- AUTOCONF HACKS --------------------------------------------------------*/\r
 154 \r
 155 /* XXX: Update autoconf to avoid these.\r
 156  * XXX: Are non-POSIX platforms intended not to use autoconf?\r
 157  * If so, perhaps there should be a config_guess.h for them. Alternatively,\r
 158  * config guesses could be placed above, just after the config.h exclusion.\r
 159  */\r
 160 #if defined(__FreeBSD__) || defined(__NetBSD__)\r
 161 #    define HAVE_USB_JS 1\r
 162 #    if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)\r
 163 #        define HAVE_USBHID_H 1\r
 164 #    endif\r
 165 #endif\r
 166 \r
 167 #if TARGET_HOST_MS_WINDOWS\r
 168 #    define  HAVE_VFPRINTF 1\r
 169 #endif\r
 170 \r
 171 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */\r
 172 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)\r
 173 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);\r
 174 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);\r
 175 #    ifdef UNICODE\r
 176 #        define ChangeDisplaySettingsEx ChangeDisplaySettingsExW\r
 177 #    else\r
 178 #        define ChangeDisplaySettingsEx ChangeDisplaySettingsExA\r
 179 #    endif\r
 180 #endif\r
 181 \r
 182 #if defined(_MSC_VER) || defined(__WATCOMC__)\r
 183 /* strdup() is non-standard, for all but POSIX-2001 */\r
 184 #define strdup   _strdup\r
 185 #endif\r
 186 \r
 187 /* M_PI is non-standard (defined by BSD, not ISO-C) */\r
 188 #ifndef M_PI\r
 189 #    define  M_PI  3.14159265358979323846\r
 190 #endif\r
 191 \r
 192 #ifdef HAVE_STDBOOL_H\r
 193 #    include <stdbool.h>\r
 194 #    ifndef TRUE\r
 195 #        define TRUE true\r
 196 #    endif\r
 197 #    ifndef FALSE\r
 198 #        define FALSE false\r
 199 #    endif\r
 200 #else\r
 201 #    ifndef TRUE\r
 202 #        define  TRUE  1\r
 203 #    endif\r
 204 #    ifndef FALSE\r
 205 #        define  FALSE  0\r
 206 #    endif\r
 207 #endif\r
 208 \r
 209 /* General defines */\r
 210 \r
 211 #define INVALID_MODIFIERS 0xffffffff\r
 212 \r
 213 \r
 214 \r
 215 /* Platform-specific includes */\r
 216 #if TARGET_HOST_POSIX_X11\r
 217 \r
 218 typedef struct tagSFG_PlatformDisplay SFG_PlatformDisplay;\r
 219 struct tagSFG_PlatformDisplay\r
 220 {\r
 221     Display*        Display;            /* The display we are being run in.  */\r
 222     int             Screen;             /* The screen we are about to use.   */\r
 223     Window          RootWindow;         /* The screen's root window.         */\r
 224     int             Connection;         /* The display's connection number   */\r
 225     Atom            DeleteWindow;       /* The window deletion atom          */\r
 226     Atom            State;              /* The state atom                    */\r
 227     Atom            StateFullScreen;    /* The full screen atom              */\r
 228 \r
 229 #ifdef HAVE_X11_EXTENSIONS_XRANDR_H\r
 230     int prev_xsz, prev_ysz;\r
 231     int prev_refresh;\r
 232     int prev_size_valid;\r
 233 #endif  /* HAVE_X11_EXTENSIONS_XRANDR_H */\r
 234 \r
 235 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H\r
 236     /*\r
 237      * XF86VidMode may be compilable even if it fails at runtime.  Therefore,\r
 238      * the validity of the VidMode has to be tracked\r
 239      */\r
 240     int             DisplayModeValid;   /* Flag that indicates runtime status*/\r
 241     XF86VidModeModeLine DisplayMode;    /* Current screen's display settings */\r
 242     int             DisplayModeClock;   /* The display mode's refresh rate   */\r
 243     int             DisplayViewPortX;   /* saved X location of the viewport  */\r
 244     int             DisplayViewPortY;   /* saved Y location of the viewport  */\r
 245 #endif /* HAVE_X11_EXTENSIONS_XF86VMODE_H */\r
 246 \r
 247     int             DisplayPointerX;    /* saved X location of the pointer   */\r
 248     int             DisplayPointerY;    /* saved Y location of the pointer   */\r
 249 };\r
 250 \r
 251 \r
 252 /*\r
 253  * Make "freeglut" window handle and context types so that we don't need so\r
 254  * much conditionally-compiled code later in the library.\r
 255  */\r
 256 typedef Window     SFG_WindowHandleType ;\r
 257 typedef GLXContext SFG_WindowContextType ;\r
 258 typedef struct tagSFG_PlatformContext SFG_PlatformContext;\r
 259 struct tagSFG_PlatformContext\r
 260 {\r
 261     GLXFBConfig*    FBConfig;        /* The window's FBConfig               */\r
 262 };\r
 263 \r
 264 \r
 265 \r
 266 #endif\r
 267 #if TARGET_HOST_MS_WINDOWS\r
 268 #include "../mswin/freeglut_internal_mswin.h"\r
 269 #endif\r
 270 \r
 271 \r
 272 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */\r
 273 \r
 274 /* Freeglut callbacks type definitions */\r
 275 typedef void (* FGCBDisplay       )( void );\r
 276 typedef void (* FGCBReshape       )( int, int );\r
 277 typedef void (* FGCBVisibility    )( int );\r
 278 typedef void (* FGCBKeyboard      )( unsigned char, int, int );\r
 279 typedef void (* FGCBSpecial       )( int, int, int );\r
 280 typedef void (* FGCBMouse         )( int, int, int, int );\r
 281 typedef void (* FGCBMouseWheel    )( int, int, int, int );\r
 282 typedef void (* FGCBMotion        )( int, int );\r
 283 typedef void (* FGCBPassive       )( int, int );\r
 284 typedef void (* FGCBEntry         )( int );\r
 285 typedef void (* FGCBWindowStatus  )( int );\r
 286 typedef void (* FGCBSelect        )( int, int, int );\r
 287 typedef void (* FGCBJoystick      )( unsigned int, int, int, int );\r
 288 typedef void (* FGCBKeyboardUp    )( unsigned char, int, int );\r
 289 typedef void (* FGCBSpecialUp     )( int, int, int );\r
 290 typedef void (* FGCBOverlayDisplay)( void );\r
 291 typedef void (* FGCBSpaceMotion   )( int, int, int );\r
 292 typedef void (* FGCBSpaceRotation )( int, int, int );\r
 293 typedef void (* FGCBSpaceButton   )( int, int );\r
 294 typedef void (* FGCBDials         )( int, int );\r
 295 typedef void (* FGCBButtonBox     )( int, int );\r
 296 typedef void (* FGCBTabletMotion  )( int, int );\r
 297 typedef void (* FGCBTabletButton  )( int, int, int, int );\r
 298 typedef void (* FGCBDestroy       )( void );\r
 299 \r
 300 typedef void (* FGCBMultiEntry   )( int, int );\r
 301 typedef void (* FGCBMultiButton  )( int, int, int, int, int );\r
 302 typedef void (* FGCBMultiMotion  )( int, int, int );\r
 303 typedef void (* FGCBMultiPassive )( int, int, int );\r
 304 \r
 305 /* The global callbacks type definitions */\r
 306 typedef void (* FGCBIdle          )( void );\r
 307 typedef void (* FGCBTimer         )( int );\r
 308 typedef void (* FGCBMenuState     )( int );\r
 309 typedef void (* FGCBMenuStatus    )( int, int, int );\r
 310 \r
 311 /* The callback used when creating/using menus */\r
 312 typedef void (* FGCBMenu          )( int );\r
 313 \r
 314 /* The FreeGLUT error/warning handler type definition */\r
 315 typedef void (* FGError           ) ( const char *fmt, va_list ap);\r
 316 typedef void (* FGWarning         ) ( const char *fmt, va_list ap);\r
 317 \r
 318 \r
 319 /* A list structure */\r
 320 typedef struct tagSFG_List SFG_List;\r
 321 struct tagSFG_List\r
 322 {\r
 323     void *First;\r
 324     void *Last;\r
 325 };\r
 326 \r
 327 /* A list node structure */\r
 328 typedef struct tagSFG_Node SFG_Node;\r
 329 struct tagSFG_Node\r
 330 {\r
 331     void *Next;\r
 332     void *Prev;\r
 333 };\r
 334 \r
 335 /* A helper structure holding two ints and a boolean */\r
 336 typedef struct tagSFG_XYUse SFG_XYUse;\r
 337 struct tagSFG_XYUse\r
 338 {\r
 339     GLint           X, Y;               /* The two integers...               */\r
 340     GLboolean       Use;                /* ...and a single boolean.          */\r
 341 };\r
 342 \r
 343 /*\r
 344  * An enumeration containing the state of the GLUT execution:\r
 345  * initializing, running, or stopping\r
 346  */\r
 347 typedef enum\r
 348 {\r
 349   GLUT_EXEC_STATE_INIT,\r
 350   GLUT_EXEC_STATE_RUNNING,\r
 351   GLUT_EXEC_STATE_STOP\r
 352 } fgExecutionState ;\r
 353 \r
 354 /* This structure holds different freeglut settings */\r
 355 typedef struct tagSFG_State SFG_State;\r
 356 struct tagSFG_State\r
 357 {\r
 358     SFG_XYUse        Position;             /* The default windows' position  */\r
 359     SFG_XYUse        Size;                 /* The default windows' size      */\r
 360     unsigned int     DisplayMode;          /* Display mode for new windows   */\r
 361 \r
 362     GLboolean        Initialised;          /* freeglut has been initialised  */\r
 363 \r
 364     int              DirectContext;        /* Direct rendering state         */\r
 365 \r
 366     GLboolean        ForceIconic;          /* New top windows are iconified  */\r
 367     GLboolean        UseCurrentContext;    /* New windows share with current */\r
 368 \r
 369     GLboolean        GLDebugSwitch;        /* OpenGL state debugging switch  */\r
 370     GLboolean        XSyncSwitch;          /* X11 sync protocol switch       */\r
 371 \r
 372     int              KeyRepeat;            /* Global key repeat mode.        */\r
 373     int              Modifiers;            /* Current ALT/SHIFT/CTRL state   */\r
 374 \r
 375     GLuint           FPSInterval;          /* Interval between FPS printfs   */\r
 376     GLuint           SwapCount;            /* Count of glutSwapBuffer calls  */\r
 377     GLuint           SwapTime;             /* Time of last SwapBuffers       */\r
 378 \r
 379     unsigned long    Time;                 /* Time that glutInit was called  */\r
 380     SFG_List         Timers;               /* The freeglut timer hooks       */\r
 381     SFG_List         FreeTimers;           /* The unused timer hooks         */\r
 382 \r
 383     FGCBIdle         IdleCallback;         /* The global idle callback       */\r
 384 \r
 385     int              ActiveMenus;          /* Num. of currently active menus */\r
 386     FGCBMenuState    MenuStateCallback;    /* Menu callbacks are global      */\r
 387     FGCBMenuStatus   MenuStatusCallback;\r
 388 \r
 389     SFG_XYUse        GameModeSize;         /* Game mode screen's dimensions  */\r
 390     int              GameModeDepth;        /* The pixel depth for game mode  */\r
 391     int              GameModeRefresh;      /* The refresh rate for game mode */\r
 392 \r
 393     int              ActionOnWindowClose; /* Action when user closes window  */\r
 394 \r
 395     fgExecutionState ExecState;           /* Used for GLUT termination       */\r
 396     char            *ProgramName;         /* Name of the invoking program    */\r
 397     GLboolean        JoysticksInitialised;  /* Only initialize if application calls for them */\r
 398     int              NumActiveJoysticks;    /* Number of active joysticks -- if zero, don't poll joysticks */\r
 399     GLboolean        InputDevsInitialised;  /* Only initialize if application calls for them */\r
 400 \r
 401         int              MouseWheelTicks;      /* Number of ticks the mouse wheel has turned */\r
 402 \r
 403     int              AuxiliaryBufferNumber;  /* Number of auxiliary buffers */\r
 404     int              SampleNumber;         /*  Number of samples per pixel  */\r
 405 \r
 406     int              MajorVersion;         /* Major OpenGL context version  */\r
 407     int              MinorVersion;         /* Minor OpenGL context version  */\r
 408     int              ContextFlags;         /* OpenGL context flags          */\r
 409     int              ContextProfile;       /* OpenGL context profile        */\r
 410     FGError          ErrorFunc;            /* User defined error handler    */\r
 411     FGWarning        WarningFunc;          /* User defined warning handler  */\r
 412 };\r
 413 \r
 414 /* The structure used by display initialization in freeglut_init.c */\r
 415 typedef struct tagSFG_Display SFG_Display;\r
 416 struct tagSFG_Display\r
 417 {\r
 418         SFG_PlatformDisplay pDisplay;\r
 419 \r
 420     int             ScreenWidth;        /* The screen's width in pixels      */\r
 421     int             ScreenHeight;       /* The screen's height in pixels     */\r
 422     int             ScreenWidthMM;      /* The screen's width in milimeters  */\r
 423     int             ScreenHeightMM;     /* The screen's height in milimeters */\r
 424 };\r
 425 \r
 426 \r
 427 /* The user can create any number of timer hooks */\r
 428 typedef struct tagSFG_Timer SFG_Timer;\r
 429 struct tagSFG_Timer\r
 430 {\r
 431     SFG_Node        Node;\r
 432     int             ID;                 /* The timer ID integer              */\r
 433     FGCBTimer       Callback;           /* The timer callback                */\r
 434     long            TriggerTime;        /* The timer trigger time            */\r
 435 };\r
 436 \r
 437 /*\r
 438  * A window and its OpenGL context. The contents of this structure\r
 439  * are highly dependant on the target operating system we aim at...\r
 440  */\r
 441 typedef struct tagSFG_Context SFG_Context;\r
 442 struct tagSFG_Context\r
 443 {\r
 444     SFG_WindowHandleType  Handle;    /* The window's handle                 */\r
 445     SFG_WindowContextType Context;   /* The window's OpenGL/WGL context     */\r
 446 \r
 447         SFG_PlatformContext pContext;    /* The window's FBConfig (X11) or device context (Windows) */\r
 448 \r
 449     int             DoubleBuffered;  /* Treat the window as double-buffered */\r
 450 };\r
 451 \r
 452 /* Window's state description. This structure should be kept portable. */\r
 453 typedef struct tagSFG_WindowState SFG_WindowState;\r
 454 struct tagSFG_WindowState\r
 455 {\r
 456     /* Note that on Windows, sizes always refer to the client area, thus without the window decorations */\r
 457     int             Width;              /* Window's width in pixels          */\r
 458     int             Height;             /* The same about the height         */\r
 459 #if TARGET_HOST_POSIX_X11\r
 460     int             OldWidth;           /* Window width from before a resize */\r
 461     int             OldHeight;          /*   "    height  "    "    "   "    */\r
 462 #elif TARGET_HOST_MS_WINDOWS\r
 463     RECT            OldRect;            /* window rect - stored before the window is made fullscreen */\r
 464     DWORD           OldStyle;           /* window style - stored before the window is made fullscreen */\r
 465 #endif\r
 466 \r
 467     GLboolean       Redisplay;          /* Do we have to redisplay?          */\r
 468     GLboolean       Visible;            /* Is the window visible now         */\r
 469 \r
 470     int             Cursor;             /* The currently selected cursor     */\r
 471 \r
 472     long            JoystickPollRate;   /* The joystick polling rate         */\r
 473     long            JoystickLastPoll;   /* When the last poll happened       */\r
 474 \r
 475     int             MouseX, MouseY;     /* The most recent mouse position    */\r
 476 \r
 477     GLboolean       IgnoreKeyRepeat;    /* Whether to ignore key repeat.     */\r
 478     GLboolean       KeyRepeating;       /* Currently in repeat mode          */\r
 479 \r
 480     GLboolean       NeedToResize;       /* Do we need to resize the window?  */\r
 481 \r
 482     GLboolean       IsFullscreen;       /* is the window fullscreen? */\r
 483 };\r
 484 \r
 485 \r
 486 /*\r
 487  * A generic function pointer.  We should really use the GLUTproc type\r
 488  * defined in freeglut_ext.h, but if we include that header in this file\r
 489  * a bunch of other stuff (font-related) blows up!\r
 490  */\r
 491 typedef void (*SFG_Proc)();\r
 492 \r
 493 \r
 494 /*\r
 495  * SET_WCB() is used as:\r
 496  *\r
 497  *     SET_WCB( window, cbname, func );\r
 498  *\r
 499  * ...where {window} is the freeglut window to set the callback,\r
 500  *          {cbname} is the window-specific callback to set,\r
 501  *          {func} is a function-pointer.\r
 502  *\r
 503  * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,\r
 504  * but this can cause warnings because the FETCH_WCB() macro type-\r
 505  * casts its result, and a type-cast value shouldn't be an lvalue.\r
 506  *\r
 507  * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking\r
 508  * and for no other reason.  Since it's hidden in the macro, the\r
 509  * ugliness is felt to be rather benign.\r
 510  */\r
 511 #define SET_WCB(window,cbname,func)                            \\r
 512 do                                                             \\r
 513 {                                                              \\r
 514     if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) )      \\r
 515         (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \\r
 516 } while( 0 )\r
 517 \r
 518 /*\r
 519  * FETCH_WCB() is used as:\r
 520  *\r
 521  *     FETCH_WCB( window, cbname );\r
 522  *\r
 523  * ...where {window} is the freeglut window to fetch the callback from,\r
 524  *          {cbname} is the window-specific callback to fetch.\r
 525  *\r
 526  * The result is correctly type-cast to the callback function pointer\r
 527  * type.\r
 528  */\r
 529 #define FETCH_WCB(window,cbname) \\r
 530     ((window).CallBacks[CB_ ## cbname])\r
 531 \r
 532 /*\r
 533  * INVOKE_WCB() is used as:\r
 534  *\r
 535  *     INVOKE_WCB( window, cbname, ( arg_list ) );\r
 536  *\r
 537  * ...where {window} is the freeglut window,\r
 538  *          {cbname} is the window-specific callback to be invoked,\r
 539  *          {(arg_list)} is the parameter list.\r
 540  *\r
 541  * The callback is invoked as:\r
 542  *\r
 543  *    callback( arg_list );\r
 544  *\r
 545  * ...so the parentheses are REQUIRED in the {arg_list}.\r
 546  *\r
 547  * NOTE that it does a sanity-check and also sets the\r
 548  * current window.\r
 549  *\r
 550  */\r
 551 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */\r
 552 #define INVOKE_WCB(window,cbname,arg_list)    \\r
 553 do                                            \\r
 554 {                                             \\r
 555     if( FETCH_WCB( window, cbname ) )         \\r
 556     {                                         \\r
 557         FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \\r
 558         fgSetWindow( &window );               \\r
 559         func arg_list;                        \\r
 560     }                                         \\r
 561 } while( 0 )\r
 562 #else\r
 563 #define INVOKE_WCB(window,cbname,arg_list)    \\r
 564 do                                            \\r
 565 {                                             \\r
 566     if( FETCH_WCB( window, cbname ) )         \\r
 567     {                                         \\r
 568         fgSetWindow( &window );               \\r
 569         ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \\r
 570     }                                         \\r
 571 } while( 0 )\r
 572 #endif\r
 573 \r
 574 /*\r
 575  * The window callbacks the user can supply us with. Should be kept portable.\r
 576  *\r
 577  * This enumeration provides the freeglut CallBack numbers.\r
 578  * The symbolic constants are indices into a window's array of\r
 579  * function callbacks.  The names are formed by splicing a common\r
 580  * prefix onto the callback's base name.  (This was originally\r
 581  * done so that an early stage of development could live side-by-\r
 582  * side with the old callback code.  The old callback code used\r
 583  * the bare callback's name as a structure member, so I used a\r
 584  * prefix for the array index name.)\r
 585  *\r
 586  * XXX For consistancy, perhaps the prefix should match the\r
 587  * XXX FETCH* and INVOKE* macro suffices.  I.e., WCB_, rather than\r
 588  * XXX CB_.\r
 589  */\r
 590 enum\r
 591 {\r
 592     CB_Display,\r
 593     CB_Reshape,\r
 594     CB_Keyboard,\r
 595     CB_KeyboardUp,\r
 596     CB_Special,\r
 597     CB_SpecialUp,\r
 598     CB_Mouse,\r
 599     CB_MouseWheel,\r
 600     CB_Motion,\r
 601     CB_Passive,\r
 602     CB_Entry,\r
 603     CB_Visibility,\r
 604     CB_WindowStatus,\r
 605     CB_Joystick,\r
 606     CB_Destroy,\r
 607 \r
 608     /* MPX-related */\r
 609     CB_MultiEntry,\r
 610     CB_MultiButton,\r
 611     CB_MultiMotion,\r
 612     CB_MultiPassive,\r
 613 \r
 614     /* Presently ignored */\r
 615     CB_Select,\r
 616     CB_OverlayDisplay,\r
 617     CB_SpaceMotion,     /* presently implemented only on UNIX/X11 */\r
 618     CB_SpaceRotation,   /* presently implemented only on UNIX/X11 */\r
 619     CB_SpaceButton,     /* presently implemented only on UNIX/X11 */\r
 620     CB_Dials,\r
 621     CB_ButtonBox,\r
 622     CB_TabletMotion,\r
 623     CB_TabletButton,\r
 624 \r
 625     /* Always make this the LAST one */\r
 626     TOTAL_CALLBACKS\r
 627 };\r
 628 \r
 629 \r
 630 /* This structure holds the OpenGL rendering context for all the menu windows */\r
 631 typedef struct tagSFG_MenuContext SFG_MenuContext;\r
 632 struct tagSFG_MenuContext\r
 633 {\r
 634     SFG_WindowContextType MContext;       /* The menu window's WGL context   */\r
 635 };\r
 636 \r
 637 /* This structure describes a menu */\r
 638 typedef struct tagSFG_Window SFG_Window;\r
 639 typedef struct tagSFG_MenuEntry SFG_MenuEntry;\r
 640 typedef struct tagSFG_Menu SFG_Menu;\r
 641 struct tagSFG_Menu\r
 642 {\r
 643     SFG_Node            Node;\r
 644     void               *UserData;     /* User data passed back at callback   */\r
 645     int                 ID;           /* The global menu ID                  */\r
 646     SFG_List            Entries;      /* The menu entries list               */\r
 647     FGCBMenu            Callback;     /* The menu callback                   */\r
 648     FGCBDestroy         Destroy;      /* Destruction callback                */\r
 649     GLboolean           IsActive;     /* Is the menu selected?               */\r
 650     int                 Width;        /* Menu box width in pixels            */\r
 651     int                 Height;       /* Menu box height in pixels           */\r
 652     int                 X, Y;         /* Menu box raster position            */\r
 653 \r
 654     SFG_MenuEntry      *ActiveEntry;  /* Currently active entry in the menu  */\r
 655     SFG_Window         *Window;       /* Window for menu                     */\r
 656     SFG_Window         *ParentWindow; /* Window in which the menu is invoked */\r
 657 };\r
 658 \r
 659 /* This is a menu entry */\r
 660 struct tagSFG_MenuEntry\r
 661 {\r
 662     SFG_Node            Node;\r
 663     int                 ID;                     /* The menu entry ID (local) */\r
 664     int                 Ordinal;                /* The menu's ordinal number */\r
 665     char*               Text;                   /* The text to be displayed  */\r
 666     SFG_Menu*           SubMenu;                /* Optional sub-menu tree    */\r
 667     GLboolean           IsActive;               /* Is the entry highlighted? */\r
 668     int                 Width;                  /* Label's width in pixels   */\r
 669 };\r
 670 \r
 671 /*\r
 672  * A window, making part of freeglut windows hierarchy.\r
 673  * Should be kept portable.\r
 674  *\r
 675  * NOTE that ActiveMenu is set to menu itself if the window is a menu.\r
 676  */\r
 677 struct tagSFG_Window\r
 678 {\r
 679     SFG_Node            Node;\r
 680     int                 ID;                     /* Window's ID number        */\r
 681 \r
 682     SFG_Context         Window;                 /* Window and OpenGL context */\r
 683     SFG_WindowState     State;                  /* The window state          */\r
 684     SFG_Proc            CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */\r
 685     void               *UserData ;              /* For use by user           */\r
 686 \r
 687     SFG_Menu*       Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window  */\r
 688     SFG_Menu*       ActiveMenu;                 /* The window's active menu  */\r
 689 \r
 690     SFG_Window*         Parent;                 /* The parent to this window */\r
 691     SFG_List            Children;               /* The subwindows d.l. list  */\r
 692 \r
 693     GLboolean           IsMenu;                 /* Set to 1 if we are a menu */\r
 694 };\r
 695 \r
 696 \r
 697 /* A linked list structure of windows */\r
 698 typedef struct tagSFG_WindowList SFG_WindowList ;\r
 699 struct tagSFG_WindowList\r
 700 {\r
 701     SFG_Node node;\r
 702     SFG_Window *window ;\r
 703 };\r
 704 \r
 705 /* This holds information about all the windows, menus etc. */\r
 706 typedef struct tagSFG_Structure SFG_Structure;\r
 707 struct tagSFG_Structure\r
 708 {\r
 709     SFG_List        Windows;         /* The global windows list            */\r
 710     SFG_List        Menus;           /* The global menus list              */\r
 711     SFG_List        WindowsToDestroy;\r
 712 \r
 713     SFG_Window*     CurrentWindow;   /* The currently set window          */\r
 714     SFG_Menu*       CurrentMenu;     /* Same, but menu...                 */\r
 715 \r
 716     SFG_MenuContext* MenuContext;    /* OpenGL rendering context for menus */\r
 717 \r
 718     SFG_Window*      GameModeWindow; /* The game mode window               */\r
 719 \r
 720     int              WindowID;       /* The new current window ID          */\r
 721     int              MenuID;         /* The new current menu ID            */\r
 722 };\r
 723 \r
 724 /*\r
 725  * This structure is used for the enumeration purposes.\r
 726  * You can easily extend its functionalities by declaring\r
 727  * a structure containing enumerator's contents and custom\r
 728  * data, then casting its pointer to (SFG_Enumerator *).\r
 729  */\r
 730 typedef struct tagSFG_Enumerator SFG_Enumerator;\r
 731 struct tagSFG_Enumerator\r
 732 {\r
 733     GLboolean   found;                          /* Used to terminate search  */\r
 734     void*       data;                           /* Custom data pointer       */\r
 735 };\r
 736 typedef void (* FGCBenumerator  )( SFG_Window *, SFG_Enumerator * );\r
 737 \r
 738 /* The bitmap font structure */\r
 739 typedef struct tagSFG_Font SFG_Font;\r
 740 struct tagSFG_Font\r
 741 {\r
 742     char*           Name;         /* The source font name             */\r
 743     int             Quantity;     /* Number of chars in font          */\r
 744     int             Height;       /* Height of the characters         */\r
 745     const GLubyte** Characters;   /* The characters mapping           */\r
 746 \r
 747     float           xorig, yorig; /* Relative origin of the character */\r
 748 };\r
 749 \r
 750 /* The stroke font structures */\r
 751 \r
 752 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;\r
 753 struct tagSFG_StrokeVertex\r
 754 {\r
 755     GLfloat         X, Y;\r
 756 };\r
 757 \r
 758 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;\r
 759 struct tagSFG_StrokeStrip\r
 760 {\r
 761     int             Number;\r
 762     const SFG_StrokeVertex* Vertices;\r
 763 };\r
 764 \r
 765 typedef struct tagSFG_StrokeChar SFG_StrokeChar;\r
 766 struct tagSFG_StrokeChar\r
 767 {\r
 768     GLfloat         Right;\r
 769     int             Number;\r
 770     const SFG_StrokeStrip* Strips;\r
 771 };\r
 772 \r
 773 typedef struct tagSFG_StrokeFont SFG_StrokeFont;\r
 774 struct tagSFG_StrokeFont\r
 775 {\r
 776     char*           Name;                       /* The source font name      */\r
 777     int             Quantity;                   /* Number of chars in font   */\r
 778     GLfloat         Height;                     /* Height of the characters  */\r
 779     const SFG_StrokeChar** Characters;          /* The characters mapping    */\r
 780 };\r
 781 \r
 782 \r
 783 /* -- JOYSTICK-SPECIFIC STRUCTURES AND TYPES ------------------------------- */\r
 784 /* XXX It might be better to poll the operating system for the numbers of buttons and\r
 785  * XXX axes and then dynamically allocate the arrays.\r
 786  */\r
 787 #define _JS_MAX_BUTTONS 32\r
 788 \r
 789 #if TARGET_HOST_MACINTOSH\r
 790 #    define _JS_MAX_AXES  9\r
 791 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;\r
 792 struct tagSFG_PlatformJoystick\r
 793 {\r
 794 #define  ISP_NUM_AXIS    9\r
 795 #define  ISP_NUM_NEEDS  41\r
 796     ISpElementReference isp_elem  [ ISP_NUM_NEEDS ];\r
 797     ISpNeed             isp_needs [ ISP_NUM_NEEDS ];\r
 798 };\r
 799 #endif\r
 800 \r
 801 #if TARGET_HOST_MAC_OSX\r
 802 #    define _JS_MAX_AXES 16\r
 803 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;\r
 804 struct tagSFG_PlatformJoystick\r
 805 {\r
 806     IOHIDDeviceInterface ** hidDev;\r
 807     IOHIDElementCookie buttonCookies[41];\r
 808     IOHIDElementCookie axisCookies[_JS_MAX_AXES];\r
 809 /* The next two variables are not used anywhere */\r
 810 /*    long minReport[_JS_MAX_AXES],\r
 811  *         maxReport[_JS_MAX_AXES];\r
 812  */\r
 813 };\r
 814 #endif\r
 815 \r
 816 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE)\r
 817 #    define _JS_MAX_AXES  8\r
 818 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;\r
 819 struct tagSFG_PlatformJoystick\r
 820 {\r
 821     JOYCAPS     jsCaps;\r
 822     JOYINFOEX   js;\r
 823     UINT        js_id;\r
 824 };\r
 825 #endif\r
 826 \r
 827 #if TARGET_HOST_POSIX_X11\r
 828 #    define _JS_MAX_AXES 16\r
 829 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;\r
 830 struct tagSFG_PlatformJoystick\r
 831 {\r
 832 #   if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__)\r
 833        struct os_specific_s *os;\r
 834 #   endif\r
 835 \r
 836 #   ifdef JS_NEW\r
 837        struct js_event     js;\r
 838        int          tmp_buttons;\r
 839        float        tmp_axes [ _JS_MAX_AXES ];\r
 840 #   else\r
 841        struct JS_DATA_TYPE js;\r
 842 #   endif\r
 843 \r
 844     char         fname [ 128 ];\r
 845     int          fd;\r
 846 };\r
 847 #endif\r
 848 \r
 849 /*\r
 850  * Definition of "SFG_Joystick" structure -- based on JS's "jsJoystick" object class.\r
 851  * See "js.h" lines 80-178.\r
 852  */\r
 853 typedef struct tagSFG_Joystick SFG_Joystick;\r
 854 struct tagSFG_Joystick\r
 855 {\r
 856         SFG_PlatformJoystick pJoystick;\r
 857 \r
 858     int          id;\r
 859     GLboolean    error;\r
 860     char         name [ 128 ];\r
 861     int          num_axes;\r
 862     int          num_buttons;\r
 863 \r
 864     float dead_band[ _JS_MAX_AXES ];\r
 865     float saturate [ _JS_MAX_AXES ];\r
 866     float center   [ _JS_MAX_AXES ];\r
 867     float max      [ _JS_MAX_AXES ];\r
 868     float min      [ _JS_MAX_AXES ];\r
 869 };\r
 870 \r
 871 \r
 872 \r
 873 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */\r
 874 \r
 875 /* Freeglut display related stuff (initialized once per session) */\r
 876 extern SFG_Display fgDisplay;\r
 877 \r
 878 /* Freeglut internal structure */\r
 879 extern SFG_Structure fgStructure;\r
 880 \r
 881 /* The current freeglut settings */\r
 882 extern SFG_State fgState;\r
 883 \r
 884 \r
 885 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */\r
 886 \r
 887 /*\r
 888  * A call to this function makes us sure that the Display and Structure\r
 889  * subsystems have been properly initialized and are ready to be used\r
 890  */\r
 891 #define  FREEGLUT_EXIT_IF_NOT_INITIALISED( string )               \\r
 892   if ( ! fgState.Initialised )                                    \\r
 893   {                                                               \\r
 894     fgError ( " ERROR:  Function <%s> called"                     \\r
 895               " without first calling 'glutInit'.", (string) ) ;  \\r
 896   }\r
 897 \r
 898 #define  FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string )  \\r
 899   if ( ! fgState.Initialised )                                      \\r
 900   {                                                                 \\r
 901     fgError ( " ERROR:  Internal <%s> function called"              \\r
 902               " without first calling 'glutInit'.", (string) ) ;    \\r
 903   }\r
 904 \r
 905 #define  FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function )  \\r
 906   if ( ! ( cond ) )                                              \\r
 907   {                                                              \\r
 908     fgError ( " ERROR:  Internal error <%s> in function %s",     \\r
 909               (string), (function) ) ;                           \\r
 910   }\r
 911 \r
 912 /*\r
 913  * Following definitions are somewhat similiar to GLib's,\r
 914  * but do not generate any log messages:\r
 915  */\r
 916 #define  freeglut_return_if_fail( expr ) \\r
 917     if( !(expr) )                        \\r
 918         return;\r
 919 #define  freeglut_return_val_if_fail( expr, val ) \\r
 920     if( !(expr) )                                 \\r
 921         return val ;\r
 922 \r
 923 /*\r
 924  * A call to those macros assures us that there is a current\r
 925  * window set, respectively:\r
 926  */\r
 927 #define  FREEGLUT_EXIT_IF_NO_WINDOW( string )                               \\r
 928   if ( ! fgStructure.CurrentWindow &&                                       \\r
 929        ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) )  \\r
 930   {                                                                         \\r
 931     fgError ( " ERROR:  Function <%s> called"                               \\r
 932               " with no current window defined.", (string) ) ;              \\r
 933   }\r
 934 \r
 935 /*\r
 936  * The deinitialize function gets called on glutMainLoop() end. It should clean up\r
 937  * everything inside of the freeglut\r
 938  */\r
 939 void fgDeinitialize( void );\r
 940 \r
 941 /*\r
 942  * Those two functions are used to create/destroy the freeglut internal\r
 943  * structures. This actually happens when calling glutInit() and when\r
 944  * quitting the glutMainLoop() (which actually happens, when all windows\r
 945  * have been closed).\r
 946  */\r
 947 void fgCreateStructure( void );\r
 948 void fgDestroyStructure( void );\r
 949 \r
 950 /*\r
 951  * Window creation, opening, closing and destruction.\r
 952  * Also CallBack clearing/initialization.\r
 953  * Defined in freeglut_structure.c, freeglut_window.c.\r
 954  */\r
 955 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,\r
 956                             GLboolean positionUse, int x, int y,\r
 957                             GLboolean sizeUse, int w, int h,\r
 958                             GLboolean gameMode, GLboolean isMenu );\r
 959 void        fgSetWindow ( SFG_Window *window );\r
 960 void        fgOpenWindow( SFG_Window* window, const char* title,\r
 961                           GLboolean positionUse, int x, int y,\r
 962                           GLboolean sizeUse, int w, int h,\r
 963                           GLboolean gameMode, GLboolean isSubWindow );\r
 964 void        fgCloseWindow( SFG_Window* window );\r
 965 void        fgAddToWindowDestroyList ( SFG_Window* window );\r
 966 void        fgCloseWindows ();\r
 967 void        fgDestroyWindow( SFG_Window* window );\r
 968 \r
 969 /* Menu creation and destruction. Defined in freeglut_structure.c */\r
 970 SFG_Menu*   fgCreateMenu( FGCBMenu menuCallback );\r
 971 void        fgDestroyMenu( SFG_Menu* menu );\r
 972 \r
 973 /* Joystick device management functions, defined in freeglut_joystick.c */\r
 974 int         fgJoystickDetect( void );\r
 975 void        fgInitialiseJoysticks( void );\r
 976 void        fgJoystickClose( void );\r
 977 void        fgJoystickPollWindow( SFG_Window* window );\r
 978 \r
 979 /* InputDevice Initialisation and Closure */\r
 980 int         fgInputDeviceDetect( void );\r
 981 void        fgInitialiseInputDevices( void );\r
 982 void        fgInputDeviceClose( void );\r
 983 \r
 984 /* spaceball device functions, defined in freeglut_spaceball.c */\r
 985 void        fgInitialiseSpaceball( void );\r
 986 void        fgSpaceballClose( void );\r
 987 void        fgSpaceballSetWindow( SFG_Window *window );\r
 988 \r
 989 int         fgHasSpaceball( void );\r
 990 int         fgSpaceballNumButtons( void );\r
 991 \r
 992 #if TARGET_HOST_POSIX_X11\r
 993 int         fgIsSpaceballXEvent( const XEvent *ev );\r
 994 void        fgSpaceballHandleXEvent( const XEvent *ev );\r
 995 #endif\r
 996 \r
 997 /* Setting the cursor for a given window */\r
 998 void fgSetCursor ( SFG_Window *window, int cursorID );\r
 999 \r
1000 /*\r
1001  * Helper function to enumerate through all registered windows\r
1002  * and one to enumerate all of a window's subwindows...\r
1003  *\r
1004  * The GFunc callback for those functions will be defined as:\r
1005  *\r
1006  *      void enumCallback( gpointer window, gpointer enumerator );\r
1007  *\r
1008  * where window is the enumerated (sub)window pointer (SFG_Window *),\r
1009  * and userData is the a custom user-supplied pointer. Functions\r
1010  * are defined and exported from freeglut_structure.c file.\r
1011  */\r
1012 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );\r
1013 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,\r
1014                        SFG_Enumerator* enumerator );\r
1015 \r
1016 /*\r
1017  * fgWindowByHandle returns a (SFG_Window *) value pointing to the\r
1018  * first window in the queue matching the specified window handle.\r
1019  * The function is defined in freeglut_structure.c file.\r
1020  */\r
1021 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );\r
1022 \r
1023 /*\r
1024  * This function is similiar to the previous one, except it is\r
1025  * looking for a specified (sub)window identifier. The function\r
1026  * is defined in freeglut_structure.c file.\r
1027  */\r
1028 SFG_Window* fgWindowByID( int windowID );\r
1029 \r
1030 /*\r
1031  * Looks up a menu given its ID. This is easier than fgWindowByXXX\r
1032  * as all menus are placed in a single doubly linked list...\r
1033  */\r
1034 SFG_Menu* fgMenuByID( int menuID );\r
1035 \r
1036 /*\r
1037  * The menu activation and deactivation the code. This is the meat\r
1038  * of the menu user interface handling code...\r
1039  */\r
1040 void fgUpdateMenuHighlight ( SFG_Menu *menu );\r
1041 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,\r
1042                               int mouse_x, int mouse_y );\r
1043 void fgDeactivateMenu( SFG_Window *window );\r
1044 \r
1045 /*\r
1046  * This function gets called just before the buffers swap, so that\r
1047  * freeglut can display the pull-down menus via OpenGL. The function\r
1048  * is defined in freeglut_menu.c file.\r
1049  */\r
1050 void fgDisplayMenu( void );\r
1051 \r
1052 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */\r
1053 long fgElapsedTime( void );\r
1054 \r
1055 /* System time in milliseconds */\r
1056 long unsigned fgSystemTime(void);\r
1057 \r
1058 /* List functions */\r
1059 void fgListInit(SFG_List *list);\r
1060 void fgListAppend(SFG_List *list, SFG_Node *node);\r
1061 void fgListRemove(SFG_List *list, SFG_Node *node);\r
1062 int fgListLength(SFG_List *list);\r
1063 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);\r
1064 \r
1065 /* Error Message functions */\r
1066 void fgError( const char *fmt, ... );\r
1067 void fgWarning( const char *fmt, ... );\r
1068 \r
1069 /*\r
1070  * Check if "hint" is present in "property" for "window".  See freeglut_init.c\r
1071  */\r
1072 #if TARGET_HOST_POSIX_X11\r
1073 int fgHintPresent(Window window, Atom property, Atom hint);\r
1074 \r
1075 /* Handler for X extension Events */\r
1076 #ifdef HAVE_X11_EXTENSIONS_XINPUT2_H\r
1077   void fgHandleExtensionEvents( XEvent * ev );\r
1078   void fgRegisterDevices( Display* dpy, Window* win );\r
1079 #endif\r
1080 \r
1081 #endif\r
1082 \r
1083 SFG_Proc fghGetProcAddress( const char *procName );\r
1084 \r
1085 #endif /* FREEGLUT_INTERNAL_H */\r
1086 \r
1087 /*** END OF FILE ***/\r