4 * The freeglut library private include file.
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
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:
17 * The above copyright notice and this permission notice shall be included
18 * in all copies or substantial portions of the Software.
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.
28 #ifndef FREEGLUT_INTERNAL_H
29 #define FREEGLUT_INTERNAL_H
31 /* XXX Update these for each release! */
32 #define VERSION_MAJOR 2
33 #define VERSION_MINOR 0
34 #define VERSION_PATCH 0
37 * Freeglut is meant to be available under all Unix/X11 and Win32 platforms.
40 # define TARGET_HOST_UNIX_X11 1
41 # define TARGET_HOST_WIN32 0
43 # define TARGET_HOST_UNIX_X11 0
44 # define TARGET_HOST_WIN32 1
47 #define FREEGLUT_MAX_MENUS 3
48 #define FREEGLUT_DEBUG 1
51 #undef G_DISABLE_ASSERT
52 #undef G_DISABLE_CHECKS
54 #define G_DISABLE_ASSERT
55 #define G_DISABLE_CHECKS
59 * Somehow all Win32 include headers depend on this one:
65 #define strdup _strdup
69 * Those files should be available on every platform.
79 #if TARGET_HOST_UNIX_X11
84 * The system-dependant include files should go here:
86 #if TARGET_HOST_UNIX_X11
89 #include <X11/Xatom.h>
90 #include <X11/keysym.h>
92 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
93 #include <X11/extensions/xf86vmode.h>
98 * Microsoft VisualC++ 5.0's <math.h> does not define the PI
101 # define M_PI 3.14159265358979323846
112 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
115 * Freeglut callbacks type definitions
117 typedef void (* FGCBDisplay )( void );
118 typedef void (* FGCBReshape )( int, int );
119 typedef void (* FGCBVisibility )( int );
120 typedef void (* FGCBKeyboard )( unsigned char, int, int );
121 typedef void (* FGCBSpecial )( int, int, int );
122 typedef void (* FGCBMouse )( int, int, int, int );
123 typedef void (* FGCBMouseWheel )( int, int, int, int );
124 typedef void (* FGCBMotion )( int, int );
125 typedef void (* FGCBPassive )( int, int );
126 typedef void (* FGCBEntry )( int );
127 typedef void (* FGCBWindowStatus )( int );
128 typedef void (* FGCBSelect )( int, int, int );
129 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
130 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
131 typedef void (* FGCBSpecialUp )( int, int, int );
132 typedef void (* FGCBOverlayDisplay)( void );
133 typedef void (* FGCBSpaceMotion )( int, int, int );
134 typedef void (* FGCBSpaceRotation )( int, int, int );
135 typedef void (* FGCBSpaceButton )( int, int );
136 typedef void (* FGCBDials )( int, int );
137 typedef void (* FGCBButtonBox )( int, int );
138 typedef void (* FGCBTabletMotion )( int, int );
139 typedef void (* FGCBTabletButton )( int, int, int, int );
140 typedef void (* FGCBDestroy )( void );
143 * The global callbacks type definitions
145 typedef void (* FGCBIdle )( void );
146 typedef void (* FGCBTimer )( int );
147 typedef void (* FGCBMenuState )( int );
148 typedef void (* FGCBMenuStatus )( int, int, int );
151 * The callback used when creating/using menus
153 typedef void (* FGCBMenu )( int );
159 typedef struct tagSFG_List SFG_List;
167 * A list node structure
169 typedef struct tagSFG_Node SFG_Node;
177 * A helper structure holding two ints and a boolean
179 typedef struct tagSFG_XYUse SFG_XYUse;
182 GLint X, Y; /* The two integers... */
183 GLboolean Use; /* ...and a single boolean. */
187 * A helper structure holding a timeval and a boolean
189 typedef struct tagSFG_Time SFG_Time;
195 struct timeval Value;
201 * An enumeration containing the state of the GLUT execution: initializing, running, or stopping
204 GLUT_EXEC_STATE_INIT,
205 GLUT_EXEC_STATE_RUNNING,
210 * This structure holds different freeglut settings
212 typedef struct tagSFG_State SFG_State;
215 SFG_XYUse Position; /* The default windows' position */
216 SFG_XYUse Size; /* The default windows' size */
217 unsigned int DisplayMode; /* Display mode for new windows */
219 GLboolean ForceDirectContext; /* Force direct rendering? */
220 GLboolean TryDirectContext; /* What about giving a try to? */
222 GLboolean ForceIconic; /* New top windows are iconified */
223 GLboolean UseCurrentContext; /* New windows share with current */
225 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
226 GLboolean XSyncSwitch; /* X11 sync protocol switch */
228 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
230 GLuint FPSInterval; /* Interval between FPS printfs */
231 GLuint SwapCount; /* Count of glutSwapBuffer calls */
232 GLuint SwapTime; /* Time of last SwapBuffers */
234 SFG_Time Time; /* Time that glutInit was called */
235 SFG_List Timers; /* The freeglut timer hooks */
237 FGCBIdle IdleCallback; /* The global idle callback */
239 GLboolean BuildingAMenu; /* Are we presently making a menu */
240 int ActiveMenus; /* Num. of currently active menus */
241 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
242 FGCBMenuStatus MenuStatusCallback;
244 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
245 int GameModeDepth; /* The pixel depth for game mode */
246 int GameModeRefresh; /* The refresh rate for game mode */
248 int ActionOnWindowClose; /* Action when user closes window */
250 fgExecutionState ExecState; /* Used for GLUT termination */
251 char *ProgramName; /* Name of the invoking program */
255 * The structure used by display initialization in freeglut_init.c
257 typedef struct tagSFG_Display SFG_Display;
258 struct tagSFG_Display
260 #if TARGET_HOST_UNIX_X11
261 Display* Display; /* The display we are being run in. */
262 int Screen; /* The screen we are about to use. */
263 Window RootWindow; /* The screen's root window. */
264 int Connection; /* The display's connection number */
265 Atom DeleteWindow; /* The window deletion atom */
267 #ifdef X_XF86VidModeGetModeLine
269 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
270 * the validity of the VidMode has to be tracked
272 int DisplayModeValid; /* Flag that indicates runtime status*/
273 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
274 int DisplayModeClock; /* The display mode's refresh rate */
275 int DisplayViewPortX; /* saved X location of the viewport */
276 int DisplayViewPortY; /* saved Y location of the viewport */
277 int DisplayPointerX; /* saved X location of the pointer */
278 int DisplayPointerY; /* saved Y location of the pointer */
282 #elif TARGET_HOST_WIN32
283 HINSTANCE Instance; /* The application's instance */
284 DEVMODE DisplayMode; /* Desktop's display settings */
288 int ScreenWidth; /* The screen's width in pixels */
289 int ScreenHeight; /* The screen's height in pixels */
290 int ScreenWidthMM; /* The screen's width in milimeters */
291 int ScreenHeightMM; /* The screen's height in milimeters */
296 * The user can create any number of timer hooks
298 typedef struct tagSFG_Timer SFG_Timer;
302 int ID; /* The timer ID integer */
303 FGCBTimer Callback; /* The timer callback */
304 long TriggerTime; /* The timer trigger time */
308 * A window and its OpenGL context. The contents of this structure
309 * are highly dependant on the target operating system we aim at...
311 typedef struct tagSFG_Context SFG_Context;
312 struct tagSFG_Context
314 #if TARGET_HOST_UNIX_X11
315 Window Handle; /* The window's handle */
316 GLXContext Context; /* The OpenGL context */
317 XVisualInfo* VisualInfo; /* The window's visual information */
319 #elif TARGET_HOST_WIN32
320 HWND Handle; /* The window's handle */
321 HDC Device; /* The window's device context */
322 HGLRC Context; /* The window's WGL context */
326 int DoubleBuffered; /* Treat the window as double-buffered */
330 * Window's state description. This structure should be kept portable.
332 typedef struct tagSFG_WindowState SFG_WindowState;
333 struct tagSFG_WindowState
335 int Width; /* Window's width in pixels */
336 int Height; /* The same about the height */
338 GLboolean Redisplay; /* Do we have to redisplay? */
339 GLboolean Visible; /* Is the window visible now */
341 int Cursor; /* The currently selected cursor */
342 int Modifiers; /* The current ALT/SHIFT/CTRL state */
344 long JoystickPollRate; /* The joystick polling rate */
345 long JoystickLastPoll; /* When the last poll has happened */
347 int MouseX, MouseY; /* The most recent mouse position */
349 GLboolean IsGameMode; /* Is this the game mode window? */
351 #if TARGET_HOST_WIN32
352 GLboolean NeedToResize; /* Do we need to explicitly resize? */
358 * FETCH_WCB() is used as:
360 * FETCH_WCB( window, Visibility );
362 * ...where {window} is the freeglut window to fetch the callback from,
363 * {Visibility} is the window-specific callback to fetch.
365 * The result is correctly type-cast to the callback function pointer
366 * type. (This is accomlished by abutting the callback name to a
367 * common prefix, using ANSI C token-pasting.)
369 #define FETCH_WCB(window,cbname) \
370 ((FGCB ## cbname)((window).CallBacks[CB_ ## cbname]))
373 * INVOKE_WCB() is used as:
375 * INVOKE_WCB( window, Visibility, ( status ) );
377 * ...where {window} is the freeglut window,
378 * {Visibility} is the window-specific callback,
379 * {(status)} is the parameter list.
381 * The callback is invoked as:
383 * callback( status );
385 * ...so the parentheses are REQUIRED in the {arg_list}.
387 * NOTE that it does a sanity-check and also sets the
391 #define INVOKE_WCB(window,cbname,arg_list) \
393 if( FETCH_WCB( window, cbname ) ) \
395 fgSetWindow( &window ); \
396 FETCH_WCB( window, cbname ) arg_list; \
401 * The window callbacks the user can supply us with. Should be kept portable.
403 * This enumeration provides the freeglut CallBack numbers.
404 * The symbolic constants are indices into a window's array of
405 * function callbacks. The names are formed by splicing a common
406 * prefix onto the callback's base name. (This was originally
407 * done so that an early stage of development could live side-by-
408 * side with the old callback code. The old callback code used
409 * the bare callback's name as a structure member, so I used a
410 * prefix for the array index name.)
412 * XXX For consistancy, perhaps the prefix should match the
413 * XXX FETCH* and INVOKE* macro suffices. I.e., WCB_, rather than
434 /* Presently ignored */
445 /* Always make this the LAST one */
451 * This structure holds the OpenGL rendering context for all the menu windows
453 typedef struct tagSFG_MenuContext SFG_MenuContext;
454 struct tagSFG_MenuContext
456 #if TARGET_HOST_UNIX_X11
457 GLXContext Context; /* The menu OpenGL context */
458 XVisualInfo* VisualInfo; /* The window's visual information */
459 #elif TARGET_HOST_WIN32
460 HGLRC Context; /* The menu window's WGL context */
466 * This structure describes a menu
468 typedef struct tagSFG_Window SFG_Window;
469 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
470 typedef struct tagSFG_Menu SFG_Menu;
474 void *UserData; /* User data passed back at callback */
475 int ID; /* The global menu ID */
476 SFG_List Entries; /* The menu entries list */
477 FGCBMenu Callback; /* The menu callback */
478 FGCBDestroy Destroy; /* Destruction callback */
479 GLboolean IsActive; /* Is the menu selected? */
480 int Width; /* Menu box width in pixels */
481 int Height; /* Menu box height in pixels */
482 int X, Y; /* Menu box raster position */
484 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
485 SFG_Window *Window; /* Window for menu */
486 SFG_Window *ParentWindow; /* Window in which the menu is defined */
490 * This is a menu entry
492 struct tagSFG_MenuEntry
495 int ID; /* The menu entry ID (local) */
496 int Ordinal; /* The menu's ordinal number */
497 char* Text; /* The text to be displayed */
498 SFG_Menu* SubMenu; /* Optional sub-menu tree */
499 GLboolean IsActive; /* Is the entry highlighted? */
500 int Width; /* Label's width in pixels */
504 * A window, making part of freeglut windows hierarchy.
505 * Should be kept portable.
510 int ID; /* Window's ID number */
512 SFG_Context Window; /* Window and OpenGL context */
513 SFG_WindowState State; /* The window state */
514 void *CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
515 void *UserData ; /* For use by user */
517 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
518 SFG_Menu* ActiveMenu; /* The window's active menu */
520 SFG_Window* Parent; /* The parent to this window */
521 SFG_List Children; /* The subwindows d.l. list */
523 GLboolean IsMenu; /* Set to 1 if we are a menu */
528 * A linked list structure of windows
530 typedef struct tagSFG_WindowList SFG_WindowList ;
531 struct tagSFG_WindowList
534 GLboolean needToClose ;
535 SFG_WindowList *next ;
539 * This holds information about all the windows, menus etc.
541 typedef struct tagSFG_Structure SFG_Structure;
542 struct tagSFG_Structure
544 SFG_List Windows; /* The global windows list */
545 SFG_List Menus; /* The global menus list */
547 SFG_Window* Window; /* The currently active win. */
548 SFG_Menu* Menu; /* Same, but menu... */
550 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
552 SFG_Window* GameMode; /* The game mode window */
554 int WindowID; /* The new current window ID */
555 int MenuID; /* The new current menu ID */
559 * This structure is used for the enumeration purposes.
560 * You can easily extend its functionalities by declaring
561 * a structure containing enumerator's contents and custom
562 * data, then casting its pointer to (SFG_Enumerator *).
564 typedef struct tagSFG_Enumerator SFG_Enumerator;
565 struct tagSFG_Enumerator
567 GLboolean found; /* Used to terminate search */
568 void* data; /* Custom data pointer */
570 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
573 * The bitmap font structure
575 typedef struct tagSFG_Font SFG_Font;
578 char* Name; /* The source font name */
579 int Quantity; /* Number of chars in font */
580 int Height; /* Height of the characters */
581 const GLubyte** Characters; /* The characters mapping */
583 float xorig, yorig; /* Relative origin of the character */
587 * The stroke font structures
590 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
591 struct tagSFG_StrokeVertex
596 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
597 struct tagSFG_StrokeStrip
600 const SFG_StrokeVertex* Vertices;
603 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
604 struct tagSFG_StrokeChar
608 const SFG_StrokeStrip* Strips;
611 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
612 struct tagSFG_StrokeFont
614 char* Name; /* The source font name */
615 int Quantity; /* Number of chars in font */
616 GLfloat Height; /* Height of the characters */
617 const SFG_StrokeChar** Characters; /* The characters mapping */
620 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
623 * Freeglut display related stuff (initialized once per session)
625 extern SFG_Display fgDisplay;
628 * Freeglut internal structure
630 extern SFG_Structure fgStructure;
633 * The current freeglut settings
635 extern SFG_State fgState;
638 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
641 * A call to this function makes us sure that the Display and Structure
642 * subsystems have been properly initialized and are ready to be used
644 #define freeglut_assert_ready assert( fgState.Time.Set );
647 * Following definitions are somewhat similiar to GLib's,
648 * but do not generate any log messages:
650 #define freeglut_return_if_fail( expr ) \
653 #define freeglut_return_val_if_fail( expr, val ) \
658 * A call to those macros assures us that there is a current
659 * window and menu set, respectively:
661 #define freeglut_assert_window assert( fgStructure.Window != NULL );
662 #define freeglut_assert_menu assert( fgStructure.Menu != NULL );
665 * The initialize and deinitialize functions get called on glutInit()
666 * and glutMainLoop() end respectively. They should create/clean up
667 * everything inside of the freeglut
669 void fgInitialize( const char* displayName );
670 void fgDeinitialize( void );
673 * Those two functions are used to create/destroy the freeglut internal
674 * structures. This actually happens when calling glutInit() and when
675 * quitting the glutMainLoop() (which actually happens, when all windows
678 void fgCreateStructure( void );
679 void fgDestroyStructure( void );
682 * A helper function to check if a display mode is possible to use
684 #if TARGET_HOST_UNIX_X11
685 XVisualInfo* fgChooseVisual( void );
689 * The window procedure for Win32 events handling
691 #if TARGET_HOST_WIN32
692 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
693 WPARAM wParam, LPARAM lParam );
694 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
695 unsigned char layer_type );
699 * Window creation, opening, closing and destruction.
700 * Defined in freeglut_structure.c, freeglut_window.c.
702 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
703 int x, int y, int w, int h, GLboolean gameMode );
704 void fgSetWindow ( SFG_Window *window ) ;
705 void fgOpenWindow( SFG_Window* window, const char* title,
706 int x, int y, int w, int h, GLboolean gameMode,
708 void fgCloseWindow( SFG_Window* window );
709 void fgAddToWindowDestroyList ( SFG_Window* window,
710 GLboolean needToClose ) ;
711 void fgCloseWindows ();
712 void fgDestroyWindow( SFG_Window* window, GLboolean needToClose );
715 * Menu creation and destruction. Defined in freeglut_structure.c
717 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback );
718 void fgDestroyMenu( SFG_Menu* menu );
721 * Joystick device management functions, defined in freeglut_joystick.c
723 void fgJoystickInit( int ident );
724 void fgJoystickClose( void );
725 void fgJoystickPollWindow( SFG_Window* window );
728 * Helper function to enumerate through all registered windows
729 * and one to enumerate all of a window's subwindows...
731 * The GFunc callback for those functions will be defined as:
733 * void enumCallback( gpointer window, gpointer enumerator );
735 * where window is the enumerated (sub)window pointer (SFG_Window *),
736 * and userData is the a custom user-supplied pointer. Functions
737 * are defined and exported from freeglut_structure.c file.
739 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
740 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
741 SFG_Enumerator* enumerator );
744 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
745 * first window in the queue matching the specified window handle.
746 * The function is defined in freeglut_structure.c file.
748 #if TARGET_HOST_UNIX_X11
749 SFG_Window* fgWindowByHandle( Window hWindow );
750 #elif TARGET_HOST_WIN32
751 SFG_Window* fgWindowByHandle( HWND hWindow );
755 * This function is similiar to the previous one, except it is
756 * looking for a specified (sub)window identifier. The function
757 * is defined in freeglut_structure.c file.
759 SFG_Window* fgWindowByID( int windowID );
762 * Looks up a menu given its ID. This is easier that fgWindowByXXX
763 * as all menus are placed in a single doubly linked list...
765 SFG_Menu* fgMenuByID( int menuID );
768 * The menu activation and deactivation the code. This is the meat
769 * of the menu user interface handling code...
771 void fgActivateMenu( SFG_Window* window, int button );
772 void fgExecuteMenuCallback( SFG_Menu* menu );
773 GLboolean fgCheckActiveMenu ( SFG_Window *window, SFG_Menu *menu );
774 void fgDeactivateMenu( SFG_Window *window );
775 void fgDeactivateSubMenu( SFG_MenuEntry *menuEntry );
778 * This function gets called just before the buffers swap, so that
779 * freeglut can display the pull-down menus via OpenGL. The function
780 * is defined in freeglut_menu.c file.
782 void fgDisplayMenu( void );
785 * Display the mouse cursor using OpenGL calls. The function
786 * is defined in freeglut_cursor.c file.
788 void fgDisplayCursor( void );
791 * Elapsed time as per glutGet(GLUT_ELAPSED_TIME).
793 long fgElapsedTime( void );
798 void fgListInit(SFG_List *list);
799 void fgListAppend(SFG_List *list, SFG_Node *node);
800 void fgListRemove(SFG_List *list, SFG_Node *node);
801 int fgListLength(SFG_List *list);
804 * Error Messages functions
806 void fgError( const char *fmt, ... );
807 void fgWarning( const char *fmt, ... );
809 #endif /* FREEGLUT_INTERNAL_H */
811 /*** END OF FILE ***/