freeglut_internal.h
上传用户:gb3593
上传日期:2022-01-07
资源大小:3028k
文件大小:34k
源码类别:

游戏引擎

开发平台:

Visual C++

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