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