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