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