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

   1 /*
   2  * freeglut_internal.h
   3  *
   4  * The freeglut library private include file.
   5  *
   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
   9  *
  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:
  16  *
  17  * The above copyright notice and this permission notice shall be included
  18  * in all copies or substantial portions of the Software.
  19  *
  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.
  26  */
  27
  28 #ifndef  FREEGLUT_INTERNAL_H
  29 #define  FREEGLUT_INTERNAL_H
  30
  31 #if HAVE_CONFIG_H
  32 #    include "config.h"
  33 #endif
  34
  35 /* XXX Update these for each release! */
  36 #define  VERSION_MAJOR 2
  37 #define  VERSION_MINOR 2
  38 #define  VERSION_PATCH 0
  39
  40 /* Freeglut is meant to be available under all Unix/X11 and Win32 platforms. */
  41 #if defined(_WIN32_WCE)
  42 #   define  TARGET_HOST_UNIX_X11    0
  43 #   define  TARGET_HOST_WIN32       0
  44 #   define  TARGET_HOST_WINCE       1
  45 #elif defined(_MSC_VER) || defined(__CYGWIN__) || defined(__MINGW32__)
  46 #   define  TARGET_HOST_UNIX_X11    0
  47 #   define  TARGET_HOST_WIN32       1
  48 #   define  TARGET_HOST_WINCE       0
  49 #else
  50 #   define  TARGET_HOST_UNIX_X11    1
  51 #   define  TARGET_HOST_WIN32       0
  52 #   define  TARGET_HOST_WINCE       0
  53 #endif
  54
  55 #define  FREEGLUT_MAX_MENUS         3
  56
  57 /* Somehow all Win32 include headers depend on this one: */
  58 #if TARGET_HOST_WIN32
  59 #include <windows.h>
  60 #include <windowsx.h>
  61 #include <mmsystem.h>
  62 #include <TCHAR.H>
  63 #endif
  64
  65 #if defined(_MSC_VER)
  66 #define strdup   _strdup
  67 #endif
  68
  69 /* Those files should be available on every platform. */
  70 #include <GL/gl.h>
  71 #include <GL/glu.h>
  72 #include <stdio.h>
  73 #include <string.h>
  74 #include <math.h>
  75 #include <stdlib.h>
  76 #if HAVE_SYS_TYPES_H
  77 #    include <sys/types.h>
  78 #endif
  79 #if HAVE_UNISTD_H
  80 #    include <unistd.h>
  81 #endif
  82 #if TIME_WITH_SYS_TIME
  83 #    include <sys/time.h>
  84 #    include <time.h>
  85 #else
  86 #    if HAVE_SYS_TIME_H
  87 #        include <sys/time.h>
  88 #    else
  89 #        include <time.h>
  90 #    endif
  91 #endif
  92
  93 /* The system-dependant include files should go here: */
  94 #if TARGET_HOST_UNIX_X11
  95     #include <GL/glx.h>
  96     #include <X11/Xlib.h>
  97     #include <X11/Xatom.h>
  98     #include <X11/keysym.h>
  99
 100     #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
 101     #include <X11/extensions/xf86vmode.h>
 102     #endif
 103 #endif
 104
 105 /* Microsoft VisualC++ 5.0's <math.h> does not define the PI */
 106 #ifndef M_PI
 107 #    define  M_PI  3.14159265358979323846
 108 #endif
 109
 110 #ifndef TRUE
 111 #    define  TRUE  1
 112 #endif
 113
 114 #ifndef FALSE
 115 #    define  FALSE  0
 116 #endif
 117
 118 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
 119
 120 /* Freeglut callbacks type definitions */
 121 typedef void (* FGCBDisplay       )( void );
 122 typedef void (* FGCBReshape       )( int, int );
 123 typedef void (* FGCBVisibility    )( int );
 124 typedef void (* FGCBKeyboard      )( unsigned char, int, int );
 125 typedef void (* FGCBSpecial       )( int, int, int );
 126 typedef void (* FGCBMouse         )( int, int, int, int );
 127 typedef void (* FGCBMouseWheel    )( int, int, int, int );
 128 typedef void (* FGCBMotion        )( int, int );
 129 typedef void (* FGCBPassive       )( int, int );
 130 typedef void (* FGCBEntry         )( int );
 131 typedef void (* FGCBWindowStatus  )( int );
 132 typedef void (* FGCBSelect        )( int, int, int );
 133 typedef void (* FGCBJoystick      )( unsigned int, int, int, int );
 134 typedef void (* FGCBKeyboardUp    )( unsigned char, int, int );
 135 typedef void (* FGCBSpecialUp     )( int, int, int );
 136 typedef void (* FGCBOverlayDisplay)( void );
 137 typedef void (* FGCBSpaceMotion   )( int, int, int );
 138 typedef void (* FGCBSpaceRotation )( int, int, int );
 139 typedef void (* FGCBSpaceButton   )( int, int );
 140 typedef void (* FGCBDials         )( int, int );
 141 typedef void (* FGCBButtonBox     )( int, int );
 142 typedef void (* FGCBTabletMotion  )( int, int );
 143 typedef void (* FGCBTabletButton  )( int, int, int, int );
 144 typedef void (* FGCBDestroy       )( void );
 145
 146 /* The global callbacks type definitions */
 147 typedef void (* FGCBIdle          )( void );
 148 typedef void (* FGCBTimer         )( int );
 149 typedef void (* FGCBMenuState     )( int );
 150 typedef void (* FGCBMenuStatus    )( int, int, int );
 151
 152 /* The callback used when creating/using menus */
 153 typedef void (* FGCBMenu          )( int );
 154
 155
 156 /* A list structure */
 157 typedef struct tagSFG_List SFG_List;
 158 struct tagSFG_List
 159 {
 160     void *First;
 161     void *Last;
 162 };
 163
 164 /* A list node structure */
 165 typedef struct tagSFG_Node SFG_Node;
 166 struct tagSFG_Node
 167 {
 168     void *Next;
 169     void *Prev;
 170 };
 171
 172 /* A helper structure holding two ints and a boolean */
 173 typedef struct tagSFG_XYUse SFG_XYUse;
 174 struct tagSFG_XYUse
 175 {
 176     GLint           X, Y;               /* The two integers...               */
 177     GLboolean       Use;                /* ...and a single boolean.          */
 178 };
 179
 180 /* A helper structure holding a timeval and a boolean */
 181 typedef struct tagSFG_Time SFG_Time;
 182 struct tagSFG_Time
 183 {
 184 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 185     DWORD Value;
 186 #else
 187     struct timeval  Value;
 188 #endif
 189     GLboolean       Set;
 190 };
 191
 192 /*
 193  * An enumeration containing the state of the GLUT execution:
 194  * initializing, running, or stopping
 195  */
 196 typedef enum
 197 {
 198   GLUT_EXEC_STATE_INIT,
 199   GLUT_EXEC_STATE_RUNNING,
 200   GLUT_EXEC_STATE_STOP
 201 } fgExecutionState ;
 202
 203 /* This structure holds different freeglut settings */
 204 typedef struct tagSFG_State SFG_State;
 205 struct tagSFG_State
 206 {
 207     SFG_XYUse        Position;             /* The default windows' position  */
 208     SFG_XYUse        Size;                 /* The default windows' size      */
 209     unsigned int     DisplayMode;          /* Display mode for new windows   */
 210
 211     GLboolean        Initialised;          /* freeglut has been initialised  */
 212
 213     int              DirectContext;        /* Direct rendering state         */
 214
 215     GLboolean        ForceIconic;          /* New top windows are iconified  */
 216     GLboolean        UseCurrentContext;    /* New windows share with current */
 217
 218     GLboolean        GLDebugSwitch;        /* OpenGL state debugging switch  */
 219     GLboolean        XSyncSwitch;          /* X11 sync protocol switch       */
 220
 221     int              KeyRepeat;            /* Global key repeat mode.        */
 222     int              Modifiers;            /* Current ALT/SHIFT/CTRL state   */
 223
 224     GLuint           FPSInterval;          /* Interval between FPS printfs   */
 225     GLuint           SwapCount;            /* Count of glutSwapBuffer calls  */
 226     GLuint           SwapTime;             /* Time of last SwapBuffers       */
 227
 228     SFG_Time         Time;                 /* Time that glutInit was called  */
 229     SFG_List         Timers;               /* The freeglut timer hooks       */
 230     SFG_List         FreeTimers;           /* The unused timer hooks         */
 231
 232     FGCBIdle         IdleCallback;         /* The global idle callback       */
 233
 234     int              ActiveMenus;          /* Num. of currently active menus */
 235     FGCBMenuState    MenuStateCallback;    /* Menu callbacks are global      */
 236     FGCBMenuStatus   MenuStatusCallback;
 237
 238     SFG_XYUse        GameModeSize;         /* Game mode screen's dimensions  */
 239     int              GameModeDepth;        /* The pixel depth for game mode  */
 240     int              GameModeRefresh;      /* The refresh rate for game mode */
 241
 242     int              ActionOnWindowClose; /* Action when user closes window  */
 243
 244     fgExecutionState ExecState;           /* Used for GLUT termination       */
 245     char            *ProgramName;         /* Name of the invoking program    */
 246     GLboolean        JoysticksInitialised;  /* Only initialize if application calls for them */
 247 };
 248
 249 /* The structure used by display initialization in freeglut_init.c */
 250 typedef struct tagSFG_Display SFG_Display;
 251 struct tagSFG_Display
 252 {
 253 #if TARGET_HOST_UNIX_X11
 254     Display*        Display;            /* The display we are being run in.  */
 255     int             Screen;             /* The screen we are about to use.   */
 256     Window          RootWindow;         /* The screen's root window.         */
 257     int             Connection;         /* The display's connection number   */
 258     Atom            DeleteWindow;       /* The window deletion atom          */
 259
 260 #ifdef X_XF86VidModeGetModeLine
 261     /*
 262      * XF86VidMode may be compilable even if it fails at runtime.  Therefore,
 263      * the validity of the VidMode has to be tracked
 264      */
 265     int             DisplayModeValid;   /* Flag that indicates runtime status*/
 266     XF86VidModeModeLine DisplayMode;    /* Current screen's display settings */
 267     int             DisplayModeClock;   /* The display mode's refresh rate   */
 268     int             DisplayViewPortX;   /* saved X location of the viewport  */
 269     int             DisplayViewPortY;   /* saved Y location of the viewport  */
 270     int             DisplayPointerX;    /* saved X location of the pointer   */
 271     int             DisplayPointerY;    /* saved Y location of the pointer   */
 272
 273 #endif
 274
 275 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 276     HINSTANCE        Instance;          /* The application's instance        */
 277     DEVMODE         DisplayMode;        /* Desktop's display settings        */
 278
 279 #endif
 280
 281     int             ScreenWidth;        /* The screen's width in pixels      */
 282     int             ScreenHeight;       /* The screen's height in pixels     */
 283     int             ScreenWidthMM;      /* The screen's width in milimeters  */
 284     int             ScreenHeightMM;     /* The screen's height in milimeters */
 285 };
 286
 287
 288 /* The user can create any number of timer hooks */
 289 typedef struct tagSFG_Timer SFG_Timer;
 290 struct tagSFG_Timer
 291 {
 292     SFG_Node        Node;
 293     int             ID;                 /* The timer ID integer              */
 294     FGCBTimer       Callback;           /* The timer callback                */
 295     long            TriggerTime;        /* The timer trigger time            */
 296 };
 297
 298 /*
 299  * Make "freeglut" window handle and context types so that we don't need so
 300  * much conditionally-compiled code later in the library.
 301  */
 302 #if TARGET_HOST_UNIX_X11
 303
 304 typedef Window     SFG_WindowHandleType ;
 305 typedef GLXContext SFG_WindowContextType ;
 306
 307 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 308
 309 typedef HWND    SFG_WindowHandleType ;
 310 typedef HGLRC   SFG_WindowContextType ;
 311
 312 #endif
 313
 314 /*
 315  * A window and its OpenGL context. The contents of this structure
 316  * are highly dependant on the target operating system we aim at...
 317  */
 318 typedef struct tagSFG_Context SFG_Context;
 319 struct tagSFG_Context
 320 {
 321     SFG_WindowHandleType  Handle;    /* The window's handle                 */
 322     SFG_WindowContextType Context;   /* The window's OpenGL/WGL context     */
 323
 324 #if TARGET_HOST_UNIX_X11
 325     XVisualInfo*    VisualInfo;      /* The window's visual information     */
 326 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 327     HDC             Device;          /* The window's device context         */
 328 #endif
 329
 330     int             DoubleBuffered;  /* Treat the window as double-buffered */
 331 };
 332
 333 /* Window's state description. This structure should be kept portable. */
 334 typedef struct tagSFG_WindowState SFG_WindowState;
 335 struct tagSFG_WindowState
 336 {
 337     int             Width;              /* Window's width in pixels          */
 338     int             Height;             /* The same about the height         */
 339     int             OldWidth;           /* Window width from before a resize */
 340     int             OldHeight;          /*   "    height  "    "    "   "    */
 341
 342     GLboolean       Redisplay;          /* Do we have to redisplay?          */
 343     GLboolean       Visible;            /* Is the window visible now         */
 344
 345     int             Cursor;             /* The currently selected cursor     */
 346
 347     long            JoystickPollRate;   /* The joystick polling rate         */
 348     long            JoystickLastPoll;   /* When the last poll happened       */
 349
 350     int             MouseX, MouseY;     /* The most recent mouse position    */
 351
 352     GLboolean       IgnoreKeyRepeat;    /* Whether to ignore key repeat.     */
 353     GLboolean       KeyRepeating;       /* Currently in repeat mode          */
 354
 355     GLboolean       IsGameMode;         /* Is this the game mode window?     */
 356     GLboolean       NeedToResize;       /* Do we need to resize the window?  */
 357 };
 358
 359
 360 /*
 361  * A generic function pointer.  We should really use the GLUTproc type
 362  * defined in freeglut_ext.h, but if we include that header in this file
 363  * a bunch of other stuff (font-related) blows up!
 364  */
 365 typedef void (*SFG_Proc)();
 366
 367
 368 /*
 369  * SET_WCB() is used as:
 370  *
 371  *     SET_WCB( window, cbname, func );
 372  *
 373  * ...where {window} is the freeglut window to set the callback,
 374  *          {cbname} is the window-specific callback to set,
 375  *          {func} is a function-pointer.
 376  *
 377  * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
 378  * but this can cause warnings because the FETCH_WCB() macro type-
 379  * casts its result, and a type-cast value shouldn't be an lvalue.
 380  *
 381  * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
 382  * and for no other reason.  Since it's hidden in the macro, the
 383  * ugliness is felt to be rather benign.
 384  */
 385 #define SET_WCB(window,cbname,func)                            \
 386 do                                                             \
 387 {                                                              \
 388     if( FETCH_WCB( window, cbname ) != func )                  \
 389         (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc) func); \
 390 } while( 0 )
 391
 392 /*
 393  * FETCH_WCB() is used as:
 394  *
 395  *     FETCH_WCB( window, cbname );
 396  *
 397  * ...where {window} is the freeglut window to fetch the callback from,
 398  *          {cbname} is the window-specific callback to fetch.
 399  *
 400  * The result is correctly type-cast to the callback function pointer
 401  * type.
 402  */
 403 #define FETCH_WCB(window,cbname) \
 404     ((window).CallBacks[CB_ ## cbname])
 405
 406 /*
 407  * INVOKE_WCB() is used as:
 408  *
 409  *     INVOKE_WCB( window, cbname, ( arg_list ) );
 410  *
 411  * ...where {window} is the freeglut window,
 412  *          {cbname} is the window-specific callback to be invoked,
 413  *          {(arg_list)} is the parameter list.
 414  *
 415  * The callback is invoked as:
 416  *
 417  *    callback( arg_list );
 418  *
 419  * ...so the parentheses are REQUIRED in the {arg_list}.
 420  *
 421  * NOTE that it does a sanity-check and also sets the
 422  * current window.
 423  *
 424  */
 425 #if TARGET_HOST_WIN32
 426 #define INVOKE_WCB(window,cbname,arg_list)    \
 427 do                                            \
 428 {                                             \
 429     if( FETCH_WCB( window, cbname ) )         \
 430     {                                         \
 431         FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
 432         fgSetWindow( &window );               \
 433         func arg_list;                        \
 434     }                                         \
 435 } while( 0 )
 436 #else
 437 #define INVOKE_WCB(window,cbname,arg_list)    \
 438 do                                            \
 439 {                                             \
 440     if( FETCH_WCB( window, cbname ) )         \
 441     {                                         \
 442         fgSetWindow( &window );               \
 443         ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
 444     }                                         \
 445 } while( 0 )
 446 #endif
 447
 448 /*
 449  * The window callbacks the user can supply us with. Should be kept portable.
 450  *
 451  * This enumeration provides the freeglut CallBack numbers.
 452  * The symbolic constants are indices into a window's array of
 453  * function callbacks.  The names are formed by splicing a common
 454  * prefix onto the callback's base name.  (This was originally
 455  * done so that an early stage of development could live side-by-
 456  * side with the old callback code.  The old callback code used
 457  * the bare callback's name as a structure member, so I used a
 458  * prefix for the array index name.)
 459  *
 460  * XXX For consistancy, perhaps the prefix should match the
 461  * XXX FETCH* and INVOKE* macro suffices.  I.e., WCB_, rather than
 462  * XXX CB_.
 463  */
 464 enum
 465 {
 466     CB_Display,
 467     CB_Reshape,
 468     CB_Keyboard,
 469     CB_KeyboardUp,
 470     CB_Special,
 471     CB_SpecialUp,
 472     CB_Mouse,
 473     CB_MouseWheel,
 474     CB_Motion,
 475     CB_Passive,
 476     CB_Entry,
 477     CB_Visibility,
 478     CB_WindowStatus,
 479     CB_Joystick,
 480     CB_Destroy,
 481
 482     /* Presently ignored */
 483     CB_Select,
 484     CB_OverlayDisplay,
 485     CB_SpaceMotion,
 486     CB_SpaceRotation,
 487     CB_SpaceButton,
 488     CB_Dials,
 489     CB_ButtonBox,
 490     CB_TabletMotion,
 491     CB_TabletButton,
 492
 493     /* Always make this the LAST one */
 494     TOTAL_CALLBACKS
 495 };
 496
 497
 498 /* This structure holds the OpenGL rendering context for all the menu windows */
 499 typedef struct tagSFG_MenuContext SFG_MenuContext;
 500 struct tagSFG_MenuContext
 501 {
 502 #if TARGET_HOST_UNIX_X11
 503     XVisualInfo*        VisualInfo;       /* The window's visual information */
 504 #endif
 505
 506     SFG_WindowContextType Context;        /* The menu window's WGL context   */
 507 };
 508
 509 /* This structure describes a menu */
 510 typedef struct tagSFG_Window SFG_Window;
 511 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
 512 typedef struct tagSFG_Menu SFG_Menu;
 513 struct tagSFG_Menu
 514 {
 515     SFG_Node            Node;
 516     void               *UserData;     /* User data passed back at callback   */
 517     int                 ID;           /* The global menu ID                  */
 518     SFG_List            Entries;      /* The menu entries list               */
 519     FGCBMenu            Callback;     /* The menu callback                   */
 520     FGCBDestroy         Destroy;      /* Destruction callback                */
 521     GLboolean           IsActive;     /* Is the menu selected?               */
 522     int                 Width;        /* Menu box width in pixels            */
 523     int                 Height;       /* Menu box height in pixels           */
 524     int                 X, Y;         /* Menu box raster position            */
 525
 526     SFG_MenuEntry      *ActiveEntry;  /* Currently active entry in the menu  */
 527     SFG_Window         *Window;       /* Window for menu                     */
 528     SFG_Window         *ParentWindow; /* Window in which the menu is invoked */
 529 };
 530
 531 /* This is a menu entry */
 532 struct tagSFG_MenuEntry
 533 {
 534     SFG_Node            Node;
 535     int                 ID;                     /* The menu entry ID (local) */
 536     int                 Ordinal;                /* The menu's ordinal number */
 537     char*               Text;                   /* The text to be displayed  */
 538     SFG_Menu*           SubMenu;                /* Optional sub-menu tree    */
 539     GLboolean           IsActive;               /* Is the entry highlighted? */
 540     int                 Width;                  /* Label's width in pixels   */
 541 };
 542
 543 /*
 544  * A window, making part of freeglut windows hierarchy.
 545  * Should be kept portable.
 546  */
 547 struct tagSFG_Window
 548 {
 549     SFG_Node            Node;
 550     int                 ID;                     /* Window's ID number        */
 551
 552     SFG_Context         Window;                 /* Window and OpenGL context */
 553     SFG_WindowState     State;                  /* The window state          */
 554     SFG_Proc            CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
 555     void               *UserData ;              /* For use by user           */
 556
 557     SFG_Menu*       Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window  */
 558     SFG_Menu*       ActiveMenu;                 /* The window's active menu  */
 559
 560     SFG_Window*         Parent;                 /* The parent to this window */
 561     SFG_List            Children;               /* The subwindows d.l. list  */
 562
 563     GLboolean           IsMenu;                 /* Set to 1 if we are a menu */
 564 };
 565
 566
 567 /* A linked list structure of windows */
 568 typedef struct tagSFG_WindowList SFG_WindowList ;
 569 struct tagSFG_WindowList
 570 {
 571     SFG_Node node;
 572     SFG_Window *window ;
 573 };
 574
 575 /* This holds information about all the windows, menus etc. */
 576 typedef struct tagSFG_Structure SFG_Structure;
 577 struct tagSFG_Structure
 578 {
 579     SFG_List        Windows;      /* The global windows list            */
 580     SFG_List        Menus;        /* The global menus list              */
 581     SFG_List        WindowsToDestroy;
 582
 583     SFG_Window*     CurrentWindow; /* The currently set window          */
 584     SFG_Menu*       CurrentMenu;   /* Same, but menu...                 */
 585
 586     SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
 587
 588     SFG_Window*      GameMode;    /* The game mode window               */
 589
 590     int              WindowID;    /* The new current window ID          */
 591     int              MenuID;      /* The new current menu ID            */
 592 };
 593
 594 /*
 595  * This structure is used for the enumeration purposes.
 596  * You can easily extend its functionalities by declaring
 597  * a structure containing enumerator's contents and custom
 598  * data, then casting its pointer to (SFG_Enumerator *).
 599  */
 600 typedef struct tagSFG_Enumerator SFG_Enumerator;
 601 struct tagSFG_Enumerator
 602 {
 603     GLboolean   found;                          /* Used to terminate search  */
 604     void*       data;                           /* Custom data pointer       */
 605 };
 606 typedef void (* FGCBenumerator  )( SFG_Window *, SFG_Enumerator * );
 607
 608 /* The bitmap font structure */
 609 typedef struct tagSFG_Font SFG_Font;
 610 struct tagSFG_Font
 611 {
 612     char*           Name;         /* The source font name             */
 613     int             Quantity;     /* Number of chars in font          */
 614     int             Height;       /* Height of the characters         */
 615     const GLubyte** Characters;   /* The characters mapping           */
 616
 617     float           xorig, yorig; /* Relative origin of the character */
 618 };
 619
 620 /* The stroke font structures */
 621
 622 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
 623 struct tagSFG_StrokeVertex
 624 {
 625     GLfloat         X, Y;
 626 };
 627
 628 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
 629 struct tagSFG_StrokeStrip
 630 {
 631     int             Number;
 632     const SFG_StrokeVertex* Vertices;
 633 };
 634
 635 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
 636 struct tagSFG_StrokeChar
 637 {
 638     GLfloat         Right;
 639     int             Number;
 640     const SFG_StrokeStrip* Strips;
 641 };
 642
 643 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
 644 struct tagSFG_StrokeFont
 645 {
 646     char*           Name;                       /* The source font name      */
 647     int             Quantity;                   /* Number of chars in font   */
 648     GLfloat         Height;                     /* Height of the characters  */
 649     const SFG_StrokeChar** Characters;          /* The characters mapping    */
 650 };
 651
 652 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
 653
 654 /* Freeglut display related stuff (initialized once per session) */
 655 extern SFG_Display fgDisplay;
 656
 657 /* Freeglut internal structure */
 658 extern SFG_Structure fgStructure;
 659
 660 /* The current freeglut settings */
 661 extern SFG_State fgState;
 662
 663
 664 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
 665
 666 /*
 667  * A call to this function makes us sure that the Display and Structure
 668  * subsystems have been properly initialized and are ready to be used
 669  */
 670 #define  FREEGLUT_EXIT_IF_NOT_INITIALISED( string )               \
 671   if ( ! fgState.Initialised )                                    \
 672   {                                                               \
 673     fgError ( " ERROR:  Function <%s> called"                     \
 674               " without first calling 'glutInit'.", (string) ) ;  \
 675   }
 676
 677 #define  FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string )  \
 678   if ( ! fgState.Initialised )                                      \
 679   {                                                                 \
 680     fgError ( " ERROR:  Internal <%s> function called"              \
 681               " without first calling 'glutInit'.", (string) ) ;    \
 682   }
 683
 684 #define  FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function )  \
 685   if ( ! ( cond ) )                                              \
 686   {                                                              \
 687     fgError ( " ERROR:  Internal error <%s> in function %s",     \
 688               (string), (function) ) ;                           \
 689   }
 690
 691 /*
 692  * Following definitions are somewhat similiar to GLib's,
 693  * but do not generate any log messages:
 694  */
 695 #define  freeglut_return_if_fail( expr ) \
 696     if( !(expr) )                        \
 697         return;
 698 #define  freeglut_return_val_if_fail( expr, val ) \
 699     if( !(expr) )                                 \
 700         return val ;
 701
 702 /*
 703  * A call to those macros assures us that there is a current
 704  * window set, respectively:
 705  */
 706 #define  FREEGLUT_EXIT_IF_NO_WINDOW( string )                   \
 707   if ( ! fgStructure.CurrentWindow )                            \
 708   {                                                             \
 709     fgError ( " ERROR:  Function <%s> called"                   \
 710               " with no current window defined.", (string) ) ;  \
 711   }
 712
 713 /*
 714  * The deinitialize function gets called on glutMainLoop() end. It should clean up
 715  * everything inside of the freeglut
 716  */
 717 void fgDeinitialize( void );
 718
 719 /*
 720  * Those two functions are used to create/destroy the freeglut internal
 721  * structures. This actually happens when calling glutInit() and when
 722  * quitting the glutMainLoop() (which actually happens, when all windows
 723  * have been closed).
 724  */
 725 void fgCreateStructure( void );
 726 void fgDestroyStructure( void );
 727
 728 /* A helper function to check if a display mode is possible to use */
 729 #if TARGET_HOST_UNIX_X11
 730 XVisualInfo* fgChooseVisual( void );
 731 #endif
 732
 733 /* The window procedure for Win32 events handling */
 734 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 735 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
 736                                WPARAM wParam, LPARAM lParam );
 737 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
 738                               unsigned char layer_type );
 739 #endif
 740
 741 /*
 742  * Window creation, opening, closing and destruction.
 743  * Also CallBack clearing/initialization.
 744  * Defined in freeglut_structure.c, freeglut_window.c.
 745  */
 746 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
 747                             int x, int y, int w, int h,
 748                             GLboolean gameMode, GLboolean isMenu );
 749 void        fgSetWindow ( SFG_Window *window );
 750 void        fgOpenWindow( SFG_Window* window, const char* title,
 751                           int x, int y, int w, int h, GLboolean gameMode,
 752                           GLboolean isSubWindow );
 753 void        fgCloseWindow( SFG_Window* window );
 754 void        fgAddToWindowDestroyList ( SFG_Window* window );
 755 void        fgCloseWindows ();
 756 void        fgDestroyWindow( SFG_Window* window );
 757
 758 /* Menu creation and destruction. Defined in freeglut_structure.c */
 759 SFG_Menu*   fgCreateMenu( FGCBMenu menuCallback );
 760 void        fgDestroyMenu( SFG_Menu* menu );
 761
 762 /* Joystick device management functions, defined in freeglut_joystick.c */
 763 int         fgJoystickDetect( void );
 764 void        fgInitialiseJoysticks( void );
 765 void        fgJoystickClose( void );
 766 void        fgJoystickPollWindow( SFG_Window* window );
 767
 768 /* More joystick functions.  Should these go into the API?  */
 769 int  glutJoystickGetNumAxes( int ident );
 770 int  glutJoystickGetNumButtons( int ident );
 771 int  glutJoystickNotWorking( int ident );
 772
 773 /* Setting the cursor for a given window */
 774 void fgSetCursor ( SFG_Window *window, int cursorID );
 775
 776 /*
 777  * Helper function to enumerate through all registered windows
 778  * and one to enumerate all of a window's subwindows...
 779  *
 780  * The GFunc callback for those functions will be defined as:
 781  *
 782  *      void enumCallback( gpointer window, gpointer enumerator );
 783  *
 784  * where window is the enumerated (sub)window pointer (SFG_Window *),
 785  * and userData is the a custom user-supplied pointer. Functions
 786  * are defined and exported from freeglut_structure.c file.
 787  */
 788 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
 789 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
 790                        SFG_Enumerator* enumerator );
 791
 792 /*
 793  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
 794  * first window in the queue matching the specified window handle.
 795  * The function is defined in freeglut_structure.c file.
 796  */
 797 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
 798
 799 /*
 800  * This function is similiar to the previous one, except it is
 801  * looking for a specified (sub)window identifier. The function
 802  * is defined in freeglut_structure.c file.
 803  */
 804 SFG_Window* fgWindowByID( int windowID );
 805
 806 /*
 807  * Looks up a menu given its ID. This is easier than fgWindowByXXX
 808  * as all menus are placed in a single doubly linked list...
 809  */
 810 SFG_Menu* fgMenuByID( int menuID );
 811
 812 /*
 813  * The menu activation and deactivation the code. This is the meat
 814  * of the menu user interface handling code...
 815  */
 816 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
 817                               int mouse_x, int mouse_y );
 818 void fgDeactivateMenu( SFG_Window *window );
 819
 820 /*
 821  * This function gets called just before the buffers swap, so that
 822  * freeglut can display the pull-down menus via OpenGL. The function
 823  * is defined in freeglut_menu.c file.
 824  */
 825 void fgDisplayMenu( void );
 826
 827 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
 828 long fgElapsedTime( void );
 829
 830 /* List functions */
 831 void fgListInit(SFG_List *list);
 832 void fgListAppend(SFG_List *list, SFG_Node *node);
 833 void fgListRemove(SFG_List *list, SFG_Node *node);
 834 int fgListLength(SFG_List *list);
 835 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
 836
 837 /* Error Message functions */
 838 void fgError( const char *fmt, ... );
 839 void fgWarning( const char *fmt, ... );
 840
 841 #endif /* FREEGLUT_INTERNAL_H */
 842
 843 /*** END OF FILE ***/