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