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