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