git.mutantstargoat.com Git - freeglut/blob - freeglut-1.3/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 /*
  32  * Freeglut is meant to be available under all Unix/X11 and Win32 platforms.
  33  */
  34 #if !defined(_WIN32)
  35 #   define  TARGET_HOST_UNIX_X11    1
  36 #   define  TARGET_HOST_WIN32       0
  37 #else
  38 #   define  TARGET_HOST_UNIX_X11    0
  39 #   define  TARGET_HOST_WIN32       1
  40 #endif
  41
  42 #define  FREEGLUT_MAX_MENUS         3
  43 #define  FREEGLUT_DEBUG             1
  44
  45 #if FREEGLUT_DEBUG
  46     #undef   G_DISABLE_ASSERT
  47     #undef   G_DISABLE_CHECKS
  48 #else
  49     #define  G_DISABLE_ASSERT
  50     #define  G_DISABLE_CHECKS
  51 #endif
  52
  53 /*
  54  * Somehow all Win32 include headers depend on this one:
  55  */
  56 #if TARGET_HOST_WIN32
  57 #include <windows.h>
  58 #include <windowsx.h>
  59
  60 #define strdup   _strdup
  61 #endif
  62
  63 /*
  64  * Those files should be available on every platform.
  65  */
  66 #include <GL/gl.h>
  67 #include <GL/glu.h>
  68 #include <stdio.h>
  69 #include <string.h>
  70 #include <math.h>
  71 #include <stdlib.h>
  72 #include <assert.h>
  73 #include <stdarg.h>
  74 #if TARGET_HOST_UNIX_X11
  75 #include <sys/time.h>
  76 #endif
  77
  78 /*
  79  * The system-dependant include files should go here:
  80  */
  81 #if TARGET_HOST_UNIX_X11
  82     #include <GL/glx.h>
  83     #include <X11/Xlib.h>
  84     #include <X11/Xatom.h>
  85     #include <X11/keysym.h>
  86
  87     #ifndef __sgi
  88     #include <X11/extensions/xf86vmode.h>
  89     #endif
  90 #endif
  91
  92 /*
  93  * Microsoft VisualC++ 5.0's <math.h> does not define the PI
  94  */
  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 /*
 110  * Freeglut callbacks type definitions
 111  */
 112 typedef void (* FGCBdisplay       )( void );
 113 typedef void (* FGCBreshape       )( int, int );
 114 typedef void (* FGCBvisibility    )( int );
 115 typedef void (* FGCBkeyboard      )( unsigned char, int, int );
 116 typedef void (* FGCBspecial       )( int, int, int );
 117 typedef void (* FGCBmouse         )( int, int, int, int );
 118 typedef void (* FGCBmotion        )( int, int );
 119 typedef void (* FGCBpassive       )( int, int );
 120 typedef void (* FGCBentry         )( int );
 121 typedef void (* FGCBwindowStatus  )( int );
 122 typedef void (* FGCBmenuState     )( int );
 123 typedef void (* FGCBmenuStatus    )( int, int, int );
 124 typedef void (* FGCBselect        )( int, int, int );
 125 typedef void (* FGCBjoystick      )( unsigned int, int, int, int );
 126 typedef void (* FGCBkeyboardUp    )( unsigned char, int, int );
 127 typedef void (* FGCBspecialUp     )( int, int, int );
 128 typedef void (* FGCBoverlayDisplay)( void );
 129 typedef void (* FGCBspaceMotion   )( int, int, int );
 130 typedef void (* FGCBspaceRotate   )( int, int, int );
 131 typedef void (* FGCBspaceButton   )( int, int );
 132 typedef void (* FGCBdials         )( int, int );
 133 typedef void (* FGCBbuttonBox     )( int, int );
 134 typedef void (* FGCBtabletMotion  )( int, int );
 135 typedef void (* FGCBtabletButton  )( int, int, int, int );
 136 typedef void (* FGCBdestroy       )( void );
 137
 138 /*
 139  * The global callbacks type definitions
 140  */
 141 typedef void (* FGCBidle          )( void );
 142 typedef void (* FGCBtimer         )( int );
 143
 144 /*
 145  * The callback used when creating/using menus
 146  */
 147 typedef void (* FGCBmenu          )( int );
 148
 149
 150 /*
 151  * A list structure
 152  */
 153 typedef struct tagSFG_List SFG_List;
 154 struct tagSFG_List
 155 {
 156     void *First;
 157     void *Last;
 158 };
 159
 160 /*
 161  * A list node structure
 162  */
 163 typedef struct tagSFG_Node SFG_Node;
 164 struct tagSFG_Node
 165 {
 166     void *Next;
 167     void *Prev;
 168 };
 169
 170 /*
 171  * A helper structure holding two ints and a boolean
 172  */
 173 typedef struct tagSFG_XYUse SFG_XYUse;
 174 struct tagSFG_XYUse
 175 {
 176     GLint           X, Y;               /* The two integers...               */
 177     GLboolean       Use;                /* ...and a single boolean.          */
 178 };
 179
 180 /*
 181  * A helper structure holding a timeval and a boolean
 182  */
 183 typedef struct tagSFG_Time SFG_Time;
 184 struct tagSFG_Time
 185 {
 186 #ifdef WIN32
 187     DWORD Value;
 188 #else
 189     struct timeval  Value;
 190 #endif
 191     GLboolean       Set;
 192 };
 193
 194 /*
 195  * An enumeration containing the state of the GLUT execution:  initializing, running, or stopping
 196  */
 197 typedef enum {
 198   GLUT_EXEC_STATE_INIT,
 199   GLUT_EXEC_STATE_RUNNING,
 200   GLUT_EXEC_STATE_STOP
 201 } fgExecutionState ;
 202
 203 /*
 204  * This structure holds different freeglut settings
 205  */
 206 typedef struct tagSFG_State SFG_State;
 207 struct tagSFG_State
 208 {
 209     SFG_XYUse        Position;             /* The default windows' position     */
 210     SFG_XYUse        Size;                 /* The default windows' size         */
 211     unsigned int     DisplayMode;          /* The display mode for new windows  */
 212
 213     GLboolean        ForceDirectContext;   /* Should we force direct contexts?  */
 214     GLboolean        TryDirectContext;     /* What about giving a try to?       */
 215
 216     GLboolean        ForceIconic;          /* All new top windows are iconified */
 217
 218     GLboolean        GLDebugSwitch;        /* OpenGL state debugging switch     */
 219     GLboolean        XSyncSwitch;          /* X11 sync protocol switch          */
 220
 221     GLboolean        IgnoreKeyRepeat;      /* Whether to ignore key repeat...   */
 222
 223     GLuint           FPSInterval;          /* Interval between FPS printfs      */
 224     GLuint           SwapCount;            /* Count of glutSwapBuffer calls     */
 225     GLuint           SwapTime;             /* Time of last SwapBuffers          */
 226
 227     SFG_Time         Time;                 /* The time that glutInit was called */
 228     SFG_List         Timers;               /* The freeglut timer hooks          */
 229
 230     FGCBidle         IdleCallback;         /* The global idle callback          */
 231
 232     FGCBmenuState    MenuStateCallback;    /* Menu callbacks are global         */
 233     FGCBmenuStatus   MenuStatusCallback;
 234
 235     SFG_XYUse        GameModeSize;         /* The game mode screen's dimensions */
 236     int              GameModeDepth;        /* The pixel depth for game mode     */
 237     int              GameModeRefresh;      /* The refresh rate for game mode    */
 238
 239     int              ActionOnWindowClose ; /* Action when user clicks "x" on window header bar */
 240
 241     fgExecutionState ExecState ;           /* Current state of the GLUT execution */
 242 };
 243
 244 /*
 245  * The structure used by display initialization in freeglut_init.c
 246  */
 247 typedef struct tagSFG_Display SFG_Display;
 248 struct tagSFG_Display
 249 {
 250 #if TARGET_HOST_UNIX_X11
 251     Display*        Display;            /* The display we are being run in.  */
 252     int             Screen;             /* The screen we are about to use.   */
 253     Window          RootWindow;         /* The screen's root window.         */
 254     int             Connection;         /* The display's connection number   */
 255     Atom            DeleteWindow;       /* The window deletion atom          */
 256
 257 #ifdef X_XF86VidModeGetModeLine
 258     XF86VidModeModeLine DisplayMode;    /* Current screen's display settings */
 259     int             DisplayModeClock;   /* The display mode's refresh rate   */
 260 #endif
 261
 262 #elif TARGET_HOST_WIN32
 263     HINSTANCE        Instance;          /* The application's instance        */
 264     DEVMODE         DisplayMode;        /* Desktop's display settings        */
 265
 266 #endif
 267
 268     int             ScreenWidth;        /* The screen's width in pixels      */
 269     int             ScreenHeight;       /* The screen's height in pixels     */
 270     int             ScreenWidthMM;      /* The screen's width in milimeters  */
 271     int             ScreenHeightMM;     /* The screen's height in milimeters */
 272 };
 273
 274
 275 /*
 276  * The user can create any number of timer hooks
 277  */
 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  * A window and its OpenGL context. The contents of this structure
 289  * are highly dependant on the target operating system we aim at...
 290  */
 291 typedef struct tagSFG_Context SFG_Context;
 292 struct tagSFG_Context
 293 {
 294 #if TARGET_HOST_UNIX_X11
 295     Window          Handle;             /* The window's handle                 */
 296     GLXContext      Context;            /* The OpenGL context                  */
 297     XVisualInfo*    VisualInfo;         /* The window's visual information     */
 298
 299 #elif TARGET_HOST_WIN32
 300     HWND            Handle;             /* The window's handle                 */
 301     HDC             Device;             /* The window's device context         */
 302     HGLRC           Context;            /* The window's WGL context            */
 303
 304 #endif
 305
 306     int             DoubleBuffered;     /* Treat the window as double-buffered */
 307 };
 308
 309 /*
 310  * Window's state description. This structure should be kept portable.
 311  */
 312 typedef struct tagSFG_WindowState SFG_WindowState;
 313 struct tagSFG_WindowState
 314 {
 315     int             Width;              /* Window's width in pixels          */
 316     int             Height;             /* The same about the height         */
 317
 318     GLboolean       Redisplay;          /* Do we have to redisplay?          */
 319     GLboolean       Visible;            /* Is the window visible now         */
 320
 321     int             Cursor;             /* The currently selected cursor     */
 322     int             Modifiers;          /* The current ALT/SHIFT/CTRL state  */
 323
 324     long            JoystickPollRate;   /* The joystick polling rate         */
 325     long            JoystickLastPoll;   /* When the last poll has happened   */
 326
 327     int             MouseX, MouseY;     /* The most recent mouse position    */
 328
 329     GLboolean       IsGameMode;         /* Is this the game mode window?     */
 330
 331 #if TARGET_HOST_WIN32
 332     GLboolean       NeedToResize;       /* Do we need to explicitly resize?  */
 333 #endif
 334 };
 335
 336 /*
 337  * The window callbacks the user can supply us with. Should be kept portable.
 338  */
 339 typedef struct tagSFG_WindowCallbacks SFG_WindowCallbacks;
 340 struct tagSFG_WindowCallbacks
 341 {
 342     /*
 343      * Following callbacks are fully supported right now
 344      * and are ready to be tested for GLUT conformance:
 345      */
 346     FGCBdisplay         Display;
 347     FGCBreshape         Reshape;
 348     FGCBkeyboard        Keyboard;
 349     FGCBkeyboardUp      KeyboardUp;
 350     FGCBspecial         Special;
 351     FGCBspecialUp       SpecialUp;
 352     FGCBmouse           Mouse;
 353     FGCBmotion          Motion;
 354     FGCBpassive         Passive;
 355     FGCBentry           Entry;
 356     FGCBvisibility      Visibility;
 357     FGCBwindowStatus    WindowStatus;
 358     FGCBjoystick        Joystick;
 359     FGCBdestroy         Destroy;
 360
 361     /*
 362      * Those callbacks are being ignored for the moment
 363      */
 364     FGCBselect          Select;
 365     FGCBoverlayDisplay  OverlayDisplay;
 366     FGCBspaceMotion     SpaceMotion;
 367     FGCBspaceRotate     SpaceRotation;
 368     FGCBspaceButton     SpaceButton;
 369     FGCBdials           Dials;
 370     FGCBbuttonBox       ButtonBox;
 371     FGCBtabletMotion    TabletMotion;
 372     FGCBtabletButton    TabletButton;
 373 };
 374
 375 /*
 376  * This structure describes a menu
 377  */
 378 typedef struct tagSFG_Menu SFG_Menu;
 379 struct tagSFG_Menu
 380 {
 381     SFG_Node            Node;
 382     int                 ID;                     /* The global menu ID        */
 383     SFG_List            Entries;                /* The menu entries list     */
 384     FGCBmenu            Callback;               /* The menu callback         */
 385     GLboolean           IsActive;               /* Is the menu selected?     */
 386     int                 Width;                  /* Menu box width in pixels  */
 387     int                 Height;                 /* Menu box height in pixels */
 388     int                 X, Y;                   /* Menu box raster position  */
 389 };
 390
 391 /*
 392  * This is a menu entry
 393  */
 394 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
 395 struct tagSFG_MenuEntry
 396 {
 397     SFG_Node            Node;
 398     int                 ID;                     /* The menu entry ID (local) */
 399     int                 Ordinal;                /* The menu's ordinal number */
 400     char*               Text;                   /* The text to be displayed  */
 401     SFG_Menu*           SubMenu;                /* Optional sub-menu tree    */
 402     GLboolean           IsActive;               /* Is the entry highlighted? */
 403     int                 Width;                  /* Label's width in pixels   */
 404 };
 405
 406 /*
 407  * A window, making part of FreeGLUT windows hierarchy. Should be kept portable.
 408  */
 409 typedef struct tagSFG_Window SFG_Window;
 410 struct tagSFG_Window
 411 {
 412     SFG_Node            Node;
 413     int                 ID;                     /* Window's ID number        */
 414
 415     SFG_Context         Window;                 /* Window and OpenGL context */
 416     SFG_WindowState     State;                  /* The window state          */
 417     SFG_WindowCallbacks Callbacks;              /* The window callbacks      */
 418
 419     SFG_Menu*       Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window  */
 420     SFG_Menu*       ActiveMenu;                 /* The window's active menu  */
 421
 422     SFG_Window*         Parent;                 /* The parent to this window */
 423     SFG_List            Children;               /* The subwindows d.l. list  */
 424 };
 425
 426 /*
 427  * A linked list structure of windows
 428  */
 429 typedef struct tagSFG_WindowList SFG_WindowList ;
 430 struct tagSFG_WindowList
 431 {
 432   SFG_Window *window ;
 433   GLboolean needToClose ;
 434   SFG_WindowList *next ;
 435 } ;
 436
 437 /*
 438  * This holds information about all the windows, menus etc.
 439  */
 440 typedef struct tagSFG_Structure SFG_Structure;
 441 struct tagSFG_Structure
 442 {
 443     SFG_List            Windows;                /* The global windows list   */
 444     SFG_List            Menus;                  /* The global menus list     */
 445
 446     SFG_Window*         Window;                 /* The currently active win. */
 447     SFG_Menu*           Menu;                   /* Same, but menu...         */
 448
 449     SFG_Window*         GameMode;               /* The game mode window      */
 450
 451     int                 WindowID;               /* The new current window ID */
 452     int                 MenuID;                 /* The new current menu ID   */
 453 };
 454
 455 /*
 456  * This structure is used for the enumeration purposes.
 457  * You can easily extend its functionalities by declaring
 458  * a structure containing enumerator's contents and custom
 459  * data, then casting its pointer to (SFG_Enumerator *).
 460  */
 461 typedef struct tagSFG_Enumerator SFG_Enumerator;
 462 struct tagSFG_Enumerator
 463 {
 464     GLboolean   found;                          /* Used to terminate search  */
 465     void*       data;                           /* Custom data pointer       */
 466 };
 467 typedef void (* FGCBenumerator  )( SFG_Window *, SFG_Enumerator * );
 468
 469 /*
 470  * The bitmap font structure
 471  */
 472 typedef struct tagSFG_Font SFG_Font;
 473 struct tagSFG_Font
 474 {
 475     char*           Name;                       /* The source font name      */
 476     int             Quantity;                   /* Number of chars in font   */
 477     int             Height;                     /* Height of the characters  */
 478     const GLubyte** Characters;                 /* The characters mapping    */
 479
 480     float           xorig, yorig ;              /* The origin of the character relative to the draw location */
 481 };
 482
 483 /*
 484  * The stroke font structures
 485  */
 486
 487 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
 488 struct tagSFG_StrokeVertex
 489 {
 490     GLfloat         X, Y;
 491 };
 492
 493 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
 494 struct tagSFG_StrokeStrip
 495 {
 496     int             Number;
 497     const SFG_StrokeVertex* Vertices;
 498 };
 499
 500 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
 501 struct tagSFG_StrokeChar
 502 {
 503     GLfloat         Right;
 504     int             Number;
 505     const SFG_StrokeStrip* Strips;
 506 };
 507
 508 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
 509 struct tagSFG_StrokeFont
 510 {
 511     char*           Name;                       /* The source font name      */
 512     int             Quantity;                   /* Number of chars in font   */
 513     GLfloat         Height;                     /* Height of the characters  */
 514     const SFG_StrokeChar** Characters;          /* The characters mapping    */
 515 };
 516
 517 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
 518
 519 /*
 520  * Freeglut display related stuff (initialized once per session)
 521  */
 522 extern SFG_Display fgDisplay;
 523
 524 /*
 525  * Freeglut internal structure
 526  */
 527 extern SFG_Structure fgStructure;
 528
 529 /*
 530  * The current freeglut settings
 531  */
 532 extern SFG_State fgState;
 533
 534
 535 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
 536
 537 /*
 538  * A call to this function makes us sure that the Display and Structure
 539  * subsystems have been properly initialized and are ready to be used
 540  */
 541 #define  freeglut_assert_ready                      assert( fgState.Time.Set );
 542
 543 /*
 544  * Following definitions are somewhat similiar to GLib's,
 545  * but do not generate any log messages:
 546  */
 547 #define  freeglut_return_if_fail( expr )            if( !(expr) ) return;
 548 #define  freeglut_return_val_if_fail( expr, val )   if( !(expr) ) return( val );
 549
 550 /*
 551  * A call to those macros assures us that there is a current
 552  * window and menu set, respectively:
 553  */
 554 #define  freeglut_assert_window                     assert( fgStructure.Window != NULL );
 555 #define  freeglut_assert_menu                       assert( fgStructure.Menu != NULL );
 556
 557 /*
 558  * The initialize and deinitialize functions get called on glutInit()
 559  * and glutMainLoop() end respectively. They should create/clean up
 560  * everything inside of the freeglut
 561  */
 562 void fgInitialize( const char* displayName );
 563 void fgDeinitialize( void );
 564
 565 /*
 566  * Those two functions are used to create/destroy the freeglut internal
 567  * structures. This actually happens when calling glutInit() and when
 568  * quitting the glutMainLoop() (which actually happens, when all windows
 569  * have been closed).
 570  */
 571 void fgCreateStructure( void );
 572 void fgDestroyStructure( void );
 573
 574 /*
 575  * A helper function to check if a display mode is possible to use
 576  */
 577 #if TARGET_HOST_UNIX_X11
 578 XVisualInfo* fgChooseVisual( void );
 579 #endif
 580
 581 /*
 582  * The window procedure for Win32 events handling
 583  */
 584 #if TARGET_HOST_WIN32
 585 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam );
 586 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly, unsigned char layer_type );
 587 #endif
 588
 589 /*
 590  * Window creation, opening, closing and destruction.
 591  * Defined in freeglut_structure.c, freeglut_window.c.
 592  */
 593 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title, int x, int y, int w, int h, GLboolean gameMode );
 594 void        fgSetWindow ( SFG_Window *window ) ;
 595 void        fgOpenWindow( SFG_Window* window, const char* title, int x, int y, int w, int h, GLboolean gameMode, int isSubWindow );
 596 void        fgCloseWindow( SFG_Window* window );
 597 void        fgAddToWindowDestroyList ( SFG_Window* window, GLboolean needToClose ) ;
 598 void        fgCloseWindows () ;
 599 void        fgDestroyWindow( SFG_Window* window, GLboolean needToClose );
 600
 601 /*
 602  * Menu creation and destruction. Defined in freeglut_structure.c
 603  */
 604 SFG_Menu*   fgCreateMenu( FGCBmenu menuCallback );
 605 void        fgDestroyMenu( SFG_Menu* menu );
 606
 607 /*
 608  * Joystick device management functions, defined in freeglut_joystick.c
 609  */
 610 void        fgJoystickInit( int ident );
 611 void        fgJoystickClose( void );
 612 void        fgJoystickPollWindow( SFG_Window* window );
 613
 614 /*
 615  * Helper function to enumerate through all registered windows
 616  * and one to enumerate all of a window's subwindows...
 617  *
 618  * The GFunc callback for those functions will be defined as:
 619  *
 620  *      void enumCallback( gpointer window, gpointer enumerator );
 621  *
 622  * where window is the enumerated (sub)window pointer (SFG_Window *),
 623  * and userData is the a custom user-supplied pointer. Functions
 624  * are defined and exported from freeglut_structure.c file.
 625  */
 626 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
 627 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
 628
 629 /*
 630  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
 631  * first window in the queue matching the specified window handle.
 632  * The function is defined in freeglut_structure.c file.
 633  */
 634 #if TARGET_HOST_UNIX_X11
 635     SFG_Window* fgWindowByHandle( Window hWindow );
 636 #elif TARGET_HOST_WIN32
 637
 638     SFG_Window* fgWindowByHandle( HWND hWindow );
 639 #endif
 640
 641 /*
 642  * This function is similiar to the previous one, except it is
 643  * looking for a specified (sub)window identifier. The function
 644  * is defined in freeglut_structure.c file.
 645  */
 646 SFG_Window* fgWindowByID( int windowID );
 647
 648 /*
 649  * Looks up a menu given its ID. This is easier that fgWindowByXXX
 650  * as all menus are placed in a single doubly linked list...
 651  */
 652 SFG_Menu* fgMenuByID( int menuID );
 653
 654 /*
 655  * The menu activation and deactivation the code. This is the meat
 656  * of the menu user interface handling code...
 657  */
 658 void fgActivateMenu( SFG_Window* window, int button );
 659 void fgExecuteMenuCallback( SFG_Menu* menu ) ;
 660 GLboolean fgCheckActiveMenu ( SFG_Window *window, SFG_Menu *menu ) ;
 661 void fgDeactivateMenu( SFG_Window *window );
 662
 663 /*
 664  * This function gets called just before the buffers swap, so that
 665  * freeglut can display the pull-down menus via OpenGL. The function
 666  * is defined in freeglut_menu.c file.
 667  */
 668 void fgDisplayMenu( void );
 669
 670 /*
 671  * Display the mouse cursor using OpenGL calls. The function
 672  * is defined in freeglut_cursor.c file.
 673  */
 674 void fgDisplayCursor( void );
 675
 676 /*
 677  * Elapsed time as per glutGet(GLUT_ELAPSED_TIME).
 678  */
 679 long fgElapsedTime( void );
 680
 681 /*
 682  * List functions
 683  */
 684 void fgListInit(SFG_List *list);
 685 void fgListAppend(SFG_List *list, SFG_Node *node);
 686 void fgListRemove(SFG_List *list, SFG_Node *node);
 687 int fgListLength(SFG_List *list);
 688
 689 /*
 690  * Error Messages functions
 691  */
 692 void fgError( const char *fmt, ... );
 693 void fgWarning( const char *fmt, ... );
 694
 695 #endif /* FREEGLUT_INTERNAL_H */
 696
 697 /*** END OF FILE ***/