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