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 (* FGCBmotion )( int, int );
124 typedef void (* FGCBpassive )( int, int );
125 typedef void (* FGCBentry )( int );
126 typedef void (* FGCBwindowStatus )( int );
127 typedef void (* FGCBselect )( int, int, int );
128 typedef void (* FGCBjoystick )( unsigned int, int, int, int );
129 typedef void (* FGCBkeyboardUp )( unsigned char, int, int );
130 typedef void (* FGCBspecialUp )( int, int, int );
131 typedef void (* FGCBoverlayDisplay)( void );
132 typedef void (* FGCBspaceMotion )( int, int, int );
133 typedef void (* FGCBspaceRotate )( int, int, int );
134 typedef void (* FGCBspaceButton )( int, int );
135 typedef void (* FGCBdials )( int, int );
136 typedef void (* FGCBbuttonBox )( int, int );
137 typedef void (* FGCBtabletMotion )( int, int );
138 typedef void (* FGCBtabletButton )( int, int, int, int );
139 typedef void (* FGCBdestroy )( void );
142 * The global callbacks type definitions
144 typedef void (* FGCBidle )( void );
145 typedef void (* FGCBtimer )( int );
146 typedef void (* FGCBmenuState )( int );
147 typedef void (* FGCBmenuStatus )( int, int, int );
150 * The callback used when creating/using menus
152 typedef void (* FGCBmenu )( int );
158 typedef struct tagSFG_List SFG_List;
166 * A list node structure
168 typedef struct tagSFG_Node SFG_Node;
176 * A helper structure holding two ints and a boolean
178 typedef struct tagSFG_XYUse SFG_XYUse;
181 GLint X, Y; /* The two integers... */
182 GLboolean Use; /* ...and a single boolean. */
186 * A helper structure holding a timeval and a boolean
188 typedef struct tagSFG_Time SFG_Time;
194 struct timeval Value;
200 * An enumeration containing the state of the GLUT execution: initializing, running, or stopping
203 GLUT_EXEC_STATE_INIT,
204 GLUT_EXEC_STATE_RUNNING,
209 * This structure holds different freeglut settings
211 typedef struct tagSFG_State SFG_State;
214 SFG_XYUse Position; /* The default windows' position */
215 SFG_XYUse Size; /* The default windows' size */
216 unsigned int DisplayMode; /* The display mode for new windows */
218 GLboolean ForceDirectContext; /* Should we force direct contexts? */
219 GLboolean TryDirectContext; /* What about giving a try to? */
221 GLboolean ForceIconic; /* All new top windows are iconified */
222 GLboolean UseCurrentContext; /* New windows use current window's rendering context */
224 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
225 GLboolean XSyncSwitch; /* X11 sync protocol switch */
227 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat... */
229 GLuint FPSInterval; /* Interval between FPS printfs */
230 GLuint SwapCount; /* Count of glutSwapBuffer calls */
231 GLuint SwapTime; /* Time of last SwapBuffers */
233 SFG_Time Time; /* The time that glutInit was called */
234 SFG_List Timers; /* The freeglut timer hooks */
236 FGCBidle IdleCallback; /* The global idle callback */
238 GLboolean BuildingAMenu; /* True if we are presently making a menu */
239 FGCBmenuState MenuStateCallback; /* Menu callbacks are global */
240 FGCBmenuStatus MenuStatusCallback;
242 SFG_XYUse GameModeSize; /* The game mode screen's dimensions */
243 int GameModeDepth; /* The pixel depth for game mode */
244 int GameModeRefresh; /* The refresh rate for game mode */
246 int ActionOnWindowClose ; /* Action when user clicks "x" on window header bar */
248 fgExecutionState ExecState ; /* Current state of the GLUT execution */
252 * The structure used by display initialization in freeglut_init.c
254 typedef struct tagSFG_Display SFG_Display;
255 struct tagSFG_Display
257 #if TARGET_HOST_UNIX_X11
258 Display* Display; /* The display we are being run in. */
259 int Screen; /* The screen we are about to use. */
260 Window RootWindow; /* The screen's root window. */
261 int Connection; /* The display's connection number */
262 Atom DeleteWindow; /* The window deletion atom */
264 #ifdef X_XF86VidModeGetModeLine
266 * XF86VidMode may be compilable even if it fails at runtime. Therefore,
267 * the validity of the VidMode has to be tracked
269 int DisplayModeValid; /* Flag that indicates runtime status*/
270 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
271 int DisplayModeClock; /* The display mode's refresh rate */
272 int DisplayViewPortX; /* saved X location of the viewport */
273 int DisplayViewPortY; /* saved Y location of the viewport */
274 int DisplayPointerX; /* saved X location of the pointer */
275 int DisplayPointerY; /* saved Y location of the pointer */
279 #elif TARGET_HOST_WIN32
280 HINSTANCE Instance; /* The application's instance */
281 DEVMODE DisplayMode; /* Desktop's display settings */
285 int ScreenWidth; /* The screen's width in pixels */
286 int ScreenHeight; /* The screen's height in pixels */
287 int ScreenWidthMM; /* The screen's width in milimeters */
288 int ScreenHeightMM; /* The screen's height in milimeters */
293 * The user can create any number of timer hooks
295 typedef struct tagSFG_Timer SFG_Timer;
299 int ID; /* The timer ID integer */
300 FGCBtimer Callback; /* The timer callback */
301 long TriggerTime; /* The timer trigger time */
305 * A window and its OpenGL context. The contents of this structure
306 * are highly dependant on the target operating system we aim at...
308 typedef struct tagSFG_Context SFG_Context;
309 struct tagSFG_Context
311 #if TARGET_HOST_UNIX_X11
312 Window Handle; /* The window's handle */
313 GLXContext Context; /* The OpenGL context */
314 XVisualInfo* VisualInfo; /* The window's visual information */
316 #elif TARGET_HOST_WIN32
317 HWND Handle; /* The window's handle */
318 HDC Device; /* The window's device context */
319 HGLRC Context; /* The window's WGL context */
323 int DoubleBuffered; /* Treat the window as double-buffered */
327 * Window's state description. This structure should be kept portable.
329 typedef struct tagSFG_WindowState SFG_WindowState;
330 struct tagSFG_WindowState
332 int Width; /* Window's width in pixels */
333 int Height; /* The same about the height */
335 GLboolean Redisplay; /* Do we have to redisplay? */
336 GLboolean Visible; /* Is the window visible now */
338 int Cursor; /* The currently selected cursor */
339 int Modifiers; /* The current ALT/SHIFT/CTRL state */
341 long JoystickPollRate; /* The joystick polling rate */
342 long JoystickLastPoll; /* When the last poll has happened */
344 int MouseX, MouseY; /* The most recent mouse position */
346 GLboolean IsGameMode; /* Is this the game mode window? */
348 #if TARGET_HOST_WIN32
349 GLboolean NeedToResize; /* Do we need to explicitly resize? */
354 * The window callbacks the user can supply us with. Should be kept portable.
356 typedef struct tagSFG_WindowCallbacks SFG_WindowCallbacks;
357 struct tagSFG_WindowCallbacks
360 * Following callbacks are fully supported right now
361 * and are ready to be tested for GLUT conformance:
365 FGCBkeyboard Keyboard;
366 FGCBkeyboardUp KeyboardUp;
368 FGCBspecialUp SpecialUp;
373 FGCBvisibility Visibility;
374 FGCBwindowStatus WindowStatus;
375 FGCBjoystick Joystick;
379 * Those callbacks are being ignored for the moment
382 FGCBoverlayDisplay OverlayDisplay;
383 FGCBspaceMotion SpaceMotion;
384 FGCBspaceRotate SpaceRotation;
385 FGCBspaceButton SpaceButton;
387 FGCBbuttonBox ButtonBox;
388 FGCBtabletMotion TabletMotion;
389 FGCBtabletButton TabletButton;
393 * This structure holds the OpenGL rendering context for all the menu windows
395 typedef struct tagSFG_MenuContext SFG_MenuContext;
396 struct tagSFG_MenuContext
398 #if TARGET_HOST_UNIX_X11
399 GLXContext Context; /* The menu OpenGL context */
400 XVisualInfo* VisualInfo; /* The window's visual information */
401 #elif TARGET_HOST_WIN32
402 HGLRC Context; /* The menu window's WGL context */
408 * This structure describes a menu
410 typedef struct tagSFG_Window SFG_Window;
411 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
412 typedef struct tagSFG_Menu SFG_Menu;
416 void *UserData ; /* A. Donev: User data passed back at callback */
417 int ID; /* The global menu ID */
418 SFG_List Entries; /* The menu entries list */
419 FGCBmenu Callback; /* The menu callback */
420 FGCBdestroy Destroy; /* A. Donev: Destruction callback */
421 GLboolean IsActive; /* Is the menu selected? */
422 int Width; /* Menu box width in pixels */
423 int Height; /* Menu box height in pixels */
424 int X, Y; /* Menu box raster position */
426 SFG_MenuEntry *ActiveEntry ; /* Currently active entry in the menu */
427 SFG_Window *Window ; /* OpenGL window for menu */
428 SFG_Window *ParentWindow ; /* OpenGL window in which the menu is defined */
432 * This is a menu entry
434 struct tagSFG_MenuEntry
437 int ID; /* The menu entry ID (local) */
438 int Ordinal; /* The menu's ordinal number */
439 char* Text; /* The text to be displayed */
440 SFG_Menu* SubMenu; /* Optional sub-menu tree */
441 GLboolean IsActive; /* Is the entry highlighted? */
442 int Width; /* Label's width in pixels */
446 * A window, making part of freeglut windows hierarchy. Should be kept portable.
451 int ID; /* Window's ID number */
453 SFG_Context Window; /* Window and OpenGL context */
454 SFG_WindowState State; /* The window state */
455 SFG_WindowCallbacks Callbacks; /* The window callbacks */
456 void *UserData ; /* A. Donev: A pointer to user data used in rendering */
458 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
459 SFG_Menu* ActiveMenu; /* The window's active menu */
461 SFG_Window* Parent; /* The parent to this window */
462 SFG_List Children; /* The subwindows d.l. list */
464 GLboolean IsMenu; /* Set to 1 if we are a menu */
468 * A linked list structure of windows
470 typedef struct tagSFG_WindowList SFG_WindowList ;
471 struct tagSFG_WindowList
474 GLboolean needToClose ;
475 SFG_WindowList *next ;
479 * This holds information about all the windows, menus etc.
481 typedef struct tagSFG_Structure SFG_Structure;
482 struct tagSFG_Structure
484 SFG_List Windows; /* The global windows list */
485 SFG_List Menus; /* The global menus list */
487 SFG_Window* Window; /* The currently active win. */
488 SFG_Menu* Menu; /* Same, but menu... */
490 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
492 SFG_Window* GameMode; /* The game mode window */
494 int WindowID; /* The new current window ID */
495 int MenuID; /* The new current menu ID */
499 * This structure is used for the enumeration purposes.
500 * You can easily extend its functionalities by declaring
501 * a structure containing enumerator's contents and custom
502 * data, then casting its pointer to (SFG_Enumerator *).
504 typedef struct tagSFG_Enumerator SFG_Enumerator;
505 struct tagSFG_Enumerator
507 GLboolean found; /* Used to terminate search */
508 void* data; /* Custom data pointer */
510 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
513 * The bitmap font structure
515 typedef struct tagSFG_Font SFG_Font;
518 char* Name; /* The source font name */
519 int Quantity; /* Number of chars in font */
520 int Height; /* Height of the characters */
521 const GLubyte** Characters; /* The characters mapping */
523 float xorig, yorig ; /* The origin of the character relative to the draw location */
527 * The stroke font structures
530 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
531 struct tagSFG_StrokeVertex
536 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
537 struct tagSFG_StrokeStrip
540 const SFG_StrokeVertex* Vertices;
543 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
544 struct tagSFG_StrokeChar
548 const SFG_StrokeStrip* Strips;
551 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
552 struct tagSFG_StrokeFont
554 char* Name; /* The source font name */
555 int Quantity; /* Number of chars in font */
556 GLfloat Height; /* Height of the characters */
557 const SFG_StrokeChar** Characters; /* The characters mapping */
560 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
563 * Freeglut display related stuff (initialized once per session)
565 extern SFG_Display fgDisplay;
568 * Freeglut internal structure
570 extern SFG_Structure fgStructure;
573 * The current freeglut settings
575 extern SFG_State fgState;
578 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
581 * A call to this function makes us sure that the Display and Structure
582 * subsystems have been properly initialized and are ready to be used
584 #define freeglut_assert_ready assert( fgState.Time.Set );
587 * Following definitions are somewhat similiar to GLib's,
588 * but do not generate any log messages:
590 #define freeglut_return_if_fail( expr ) if( !(expr) ) return;
591 #define freeglut_return_val_if_fail( expr, val ) if( !(expr) ) return( val );
594 * A call to those macros assures us that there is a current
595 * window and menu set, respectively:
597 #define freeglut_assert_window assert( fgStructure.Window != NULL );
598 #define freeglut_assert_menu assert( fgStructure.Menu != NULL );
601 * The initialize and deinitialize functions get called on glutInit()
602 * and glutMainLoop() end respectively. They should create/clean up
603 * everything inside of the freeglut
605 void fgInitialize( const char* displayName );
606 void fgDeinitialize( void );
609 * Those two functions are used to create/destroy the freeglut internal
610 * structures. This actually happens when calling glutInit() and when
611 * quitting the glutMainLoop() (which actually happens, when all windows
614 void fgCreateStructure( void );
615 void fgDestroyStructure( void );
618 * A helper function to check if a display mode is possible to use
620 #if TARGET_HOST_UNIX_X11
621 XVisualInfo* fgChooseVisual( void );
625 * The window procedure for Win32 events handling
627 #if TARGET_HOST_WIN32
628 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam );
629 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly, unsigned char layer_type );
633 * Window creation, opening, closing and destruction.
634 * Defined in freeglut_structure.c, freeglut_window.c.
636 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title, int x, int y, int w, int h, GLboolean gameMode );
637 void fgSetWindow ( SFG_Window *window ) ;
638 void fgOpenWindow( SFG_Window* window, const char* title, int x, int y, int w, int h, GLboolean gameMode, int isSubWindow );
639 void fgCloseWindow( SFG_Window* window );
640 void fgAddToWindowDestroyList ( SFG_Window* window, GLboolean needToClose ) ;
641 void fgCloseWindows () ;
642 void fgDestroyWindow( SFG_Window* window, GLboolean needToClose );
645 * Menu creation and destruction. Defined in freeglut_structure.c
647 SFG_Menu* fgCreateMenu( FGCBmenu menuCallback );
648 void fgDestroyMenu( SFG_Menu* menu );
651 * Joystick device management functions, defined in freeglut_joystick.c
653 void fgJoystickInit( int ident );
654 void fgJoystickClose( void );
655 void fgJoystickPollWindow( SFG_Window* window );
658 * Helper function to enumerate through all registered windows
659 * and one to enumerate all of a window's subwindows...
661 * The GFunc callback for those functions will be defined as:
663 * void enumCallback( gpointer window, gpointer enumerator );
665 * where window is the enumerated (sub)window pointer (SFG_Window *),
666 * and userData is the a custom user-supplied pointer. Functions
667 * are defined and exported from freeglut_structure.c file.
669 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
670 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
673 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
674 * first window in the queue matching the specified window handle.
675 * The function is defined in freeglut_structure.c file.
677 #if TARGET_HOST_UNIX_X11
678 SFG_Window* fgWindowByHandle( Window hWindow );
679 #elif TARGET_HOST_WIN32
681 SFG_Window* fgWindowByHandle( HWND hWindow );
685 * This function is similiar to the previous one, except it is
686 * looking for a specified (sub)window identifier. The function
687 * is defined in freeglut_structure.c file.
689 SFG_Window* fgWindowByID( int windowID );
692 * Looks up a menu given its ID. This is easier that fgWindowByXXX
693 * as all menus are placed in a single doubly linked list...
695 SFG_Menu* fgMenuByID( int menuID );
698 * The menu activation and deactivation the code. This is the meat
699 * of the menu user interface handling code...
701 void fgActivateMenu( SFG_Window* window, int button );
702 void fgExecuteMenuCallback( SFG_Menu* menu ) ;
703 GLboolean fgCheckActiveMenu ( SFG_Window *window, SFG_Menu *menu ) ;
704 void fgDeactivateMenu( SFG_Window *window );
705 void fgDeactivateSubMenu( SFG_MenuEntry *menuEntry );
708 * This function gets called just before the buffers swap, so that
709 * freeglut can display the pull-down menus via OpenGL. The function
710 * is defined in freeglut_menu.c file.
712 void fgDisplayMenu( void );
715 * Display the mouse cursor using OpenGL calls. The function
716 * is defined in freeglut_cursor.c file.
718 void fgDisplayCursor( void );
721 * Elapsed time as per glutGet(GLUT_ELAPSED_TIME).
723 long fgElapsedTime( void );
728 void fgListInit(SFG_List *list);
729 void fgListAppend(SFG_List *list, SFG_Node *node);
730 void fgListRemove(SFG_List *list, SFG_Node *node);
731 int fgListLength(SFG_List *list);
734 * Error Messages functions
736 void fgError( const char *fmt, ... );
737 void fgWarning( const char *fmt, ... );
739 #endif /* FREEGLUT_INTERNAL_H */
741 /*** END OF FILE ***/