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
32 * Freeglut is meant to be available under all Unix/X11 and Win32 platforms.
35 # define TARGET_HOST_UNIX_X11 1
36 # define TARGET_HOST_WIN32 0
38 # define TARGET_HOST_UNIX_X11 0
39 # define TARGET_HOST_WIN32 1
42 #define FREEGLUT_MAX_MENUS 3
43 #define FREEGLUT_DEBUG 1
46 #undef G_DISABLE_ASSERT
47 #undef G_DISABLE_CHECKS
49 #define G_DISABLE_ASSERT
50 #define G_DISABLE_CHECKS
54 * Somehow all Win32 include headers depend on this one:
60 #define strdup _strdup
64 * Those files should be available on every platform.
74 #if TARGET_HOST_UNIX_X11
79 * The system-dependant include files should go here:
81 #if TARGET_HOST_UNIX_X11
84 #include <X11/Xatom.h>
85 #include <X11/keysym.h>
88 #include <X11/extensions/xf86vmode.h>
93 * Microsoft VisualC++ 5.0's <math.h> does not define the PI
96 # define M_PI 3.14159265358979323846
107 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
110 * Freeglut callbacks type definitions
112 typedef void (* FGCBdisplay )( void );
113 typedef void (* FGCBreshape )( int, int );
114 typedef void (* FGCBvisibility )( int );
115 typedef void (* FGCBkeyboard )( unsigned char, int, int );
116 typedef void (* FGCBspecial )( int, int, int );
117 typedef void (* FGCBmouse )( int, int, int, int );
118 typedef void (* FGCBmotion )( int, int );
119 typedef void (* FGCBpassive )( int, int );
120 typedef void (* FGCBentry )( int );
121 typedef void (* FGCBwindowStatus )( int );
122 typedef void (* FGCBmenuState )( int );
123 typedef void (* FGCBmenuStatus )( int, int, int );
124 typedef void (* FGCBselect )( int, int, int );
125 typedef void (* FGCBjoystick )( unsigned int, int, int, int );
126 typedef void (* FGCBkeyboardUp )( unsigned char, int, int );
127 typedef void (* FGCBspecialUp )( int, int, int );
128 typedef void (* FGCBoverlayDisplay)( void );
129 typedef void (* FGCBspaceMotion )( int, int, int );
130 typedef void (* FGCBspaceRotate )( int, int, int );
131 typedef void (* FGCBspaceButton )( int, int );
132 typedef void (* FGCBdials )( int, int );
133 typedef void (* FGCBbuttonBox )( int, int );
134 typedef void (* FGCBtabletMotion )( int, int );
135 typedef void (* FGCBtabletButton )( int, int, int, int );
136 typedef void (* FGCBdestroy )( void );
139 * The global callbacks type definitions
141 typedef void (* FGCBidle )( void );
142 typedef void (* FGCBtimer )( int );
145 * The callback used when creating/using menus
147 typedef void (* FGCBmenu )( int );
153 typedef struct tagSFG_List SFG_List;
161 * A list node structure
163 typedef struct tagSFG_Node SFG_Node;
171 * A helper structure holding two ints and a boolean
173 typedef struct tagSFG_XYUse SFG_XYUse;
176 GLint X, Y; /* The two integers... */
177 GLboolean Use; /* ...and a single boolean. */
181 * A helper structure holding a timeval and a boolean
183 typedef struct tagSFG_Time SFG_Time;
189 struct timeval Value;
195 * An enumeration containing the state of the GLUT execution: initializing, running, or stopping
198 GLUT_EXEC_STATE_INIT,
199 GLUT_EXEC_STATE_RUNNING,
204 * This structure holds different freeglut settings
206 typedef struct tagSFG_State SFG_State;
209 SFG_XYUse Position; /* The default windows' position */
210 SFG_XYUse Size; /* The default windows' size */
211 unsigned int DisplayMode; /* The display mode for new windows */
213 GLboolean ForceDirectContext; /* Should we force direct contexts? */
214 GLboolean TryDirectContext; /* What about giving a try to? */
216 GLboolean ForceIconic; /* All new top windows are iconified */
218 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
219 GLboolean XSyncSwitch; /* X11 sync protocol switch */
221 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat... */
223 SFG_Time Time; /* The time that glutInit was called */
224 SFG_List Timers; /* The freeglut timer hooks */
226 FGCBidle IdleCallback; /* The global idle callback */
228 FGCBmenuState MenuStateCallback; /* Menu callbacks are global */
229 FGCBmenuStatus MenuStatusCallback;
231 SFG_XYUse GameModeSize; /* The game mode screen's dimensions */
232 int GameModeDepth; /* The pixel depth for game mode */
233 int GameModeRefresh; /* The refresh rate for game mode */
235 int ActionOnWindowClose ; /* Action when user clicks "x" on window header bar */
237 fgExecutionState ExecState ; /* Current state of the GLUT execution */
241 * The structure used by display initialization in freeglut_init.c
243 typedef struct tagSFG_Display SFG_Display;
244 struct tagSFG_Display
246 #if TARGET_HOST_UNIX_X11
247 Display* Display; /* The display we are being run in. */
248 int Screen; /* The screen we are about to use. */
249 Window RootWindow; /* The screen's root window. */
250 int Connection; /* The display's connection number */
251 Atom DeleteWindow; /* The window deletion atom */
253 #ifdef X_XF86VidModeGetModeLine
254 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
255 int DisplayModeClock; /* The display mode's refresh rate */
258 #elif TARGET_HOST_WIN32
259 HINSTANCE Instance; /* The application's instance */
260 DEVMODE DisplayMode; /* Desktop's display settings */
264 int ScreenWidth; /* The screen's width in pixels */
265 int ScreenHeight; /* The screen's height in pixels */
266 int ScreenWidthMM; /* The screen's width in milimeters */
267 int ScreenHeightMM; /* The screen's height in milimeters */
272 * The user can create any number of timer hooks
274 typedef struct tagSFG_Timer SFG_Timer;
278 int ID; /* The timer ID integer */
279 FGCBtimer Callback; /* The timer callback */
280 long TriggerTime; /* The timer trigger time */
284 * A window and its OpenGL context. The contents of this structure
285 * are highly dependant on the target operating system we aim at...
287 typedef struct tagSFG_Context SFG_Context;
288 struct tagSFG_Context
290 #if TARGET_HOST_UNIX_X11
291 Window Handle; /* The window's handle */
292 GLXContext Context; /* The OpenGL context */
293 XVisualInfo* VisualInfo; /* The window's visual information */
295 #elif TARGET_HOST_WIN32
296 HWND Handle; /* The window's handle */
297 HDC Device; /* The window's device context */
298 HGLRC Context; /* The window's WGL context */
302 int DoubleBuffered; /* Treat the window as double-buffered */
306 * Window's state description. This structure should be kept portable.
308 typedef struct tagSFG_WindowState SFG_WindowState;
309 struct tagSFG_WindowState
311 int Width; /* Window's width in pixels */
312 int Height; /* The same about the height */
314 GLboolean Redisplay; /* Do we have to redisplay? */
315 GLboolean Visible; /* Is the window visible now */
317 int Cursor; /* The currently selected cursor */
318 int Modifiers; /* The current ALT/SHIFT/CTRL state */
320 long JoystickPollRate; /* The joystick polling rate */
321 long JoystickLastPoll; /* When the last poll has happened */
323 int MouseX, MouseY; /* The most recent mouse position */
325 GLboolean IsGameMode; /* Is this the game mode window? */
327 #if TARGET_HOST_WIN32
328 GLboolean NeedToResize; /* Do we need to explicitly resize? */
333 * The window callbacks the user can supply us with. Should be kept portable.
335 typedef struct tagSFG_WindowCallbacks SFG_WindowCallbacks;
336 struct tagSFG_WindowCallbacks
339 * Following callbacks are fully supported right now
340 * and are ready to be tested for GLUT conformance:
344 FGCBkeyboard Keyboard;
345 FGCBkeyboardUp KeyboardUp;
347 FGCBspecialUp SpecialUp;
352 FGCBvisibility Visibility;
353 FGCBwindowStatus WindowStatus;
354 FGCBjoystick Joystick;
358 * Those callbacks are being ignored for the moment
361 FGCBoverlayDisplay OverlayDisplay;
362 FGCBspaceMotion SpaceMotion;
363 FGCBspaceRotate SpaceRotation;
364 FGCBspaceButton SpaceButton;
366 FGCBbuttonBox ButtonBox;
367 FGCBtabletMotion TabletMotion;
368 FGCBtabletButton TabletButton;
372 * This structure describes a menu
374 typedef struct tagSFG_Menu SFG_Menu;
378 int ID; /* The global menu ID */
379 SFG_List Entries; /* The menu entries list */
380 FGCBmenu Callback; /* The menu callback */
381 GLboolean IsActive; /* Is the menu selected? */
382 int Width; /* Menu box width in pixels */
383 int Height; /* Menu box height in pixels */
384 int X, Y; /* Menu box raster position */
388 * This is a menu entry
390 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
391 struct tagSFG_MenuEntry
394 int ID; /* The menu entry ID (local) */
395 int Ordinal; /* The menu's ordinal number */
396 char* Text; /* The text to be displayed */
397 SFG_Menu* SubMenu; /* Optional sub-menu tree */
398 GLboolean IsActive; /* Is the entry highlighted? */
399 int Width; /* Label's width in pixels */
403 * A window, making part of FreeGLUT windows hierarchy. Should be kept portable.
405 typedef struct tagSFG_Window SFG_Window;
409 int ID; /* Window's ID number */
411 SFG_Context Window; /* Window and OpenGL context */
412 SFG_WindowState State; /* The window state */
413 SFG_WindowCallbacks Callbacks; /* The window callbacks */
415 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
416 SFG_Menu* ActiveMenu; /* The window's active menu */
418 SFG_Window* Parent; /* The parent to this window */
419 SFG_List Children; /* The subwindows d.l. list */
423 * A linked list structure of windows
425 typedef struct tagSFG_WindowList SFG_WindowList ;
426 struct tagSFG_WindowList
429 GLboolean needToClose ;
430 SFG_WindowList *next ;
434 * This holds information about all the windows, menus etc.
436 typedef struct tagSFG_Structure SFG_Structure;
437 struct tagSFG_Structure
439 SFG_List Windows; /* The global windows list */
440 SFG_List Menus; /* The global menus list */
442 SFG_Window* Window; /* The currently active win. */
443 SFG_Menu* Menu; /* Same, but menu... */
445 SFG_Window* GameMode; /* The game mode window */
447 int WindowID; /* The new current window ID */
448 int MenuID; /* The new current menu ID */
452 * This structure is used for the enumeration purposes.
453 * You can easily extend its functionalities by declaring
454 * a structure containing enumerator's contents and custom
455 * data, then casting its pointer to (SFG_Enumerator *).
457 typedef struct tagSFG_Enumerator SFG_Enumerator;
458 struct tagSFG_Enumerator
460 GLboolean found; /* Used to terminate search */
461 void* data; /* Custom data pointer */
463 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
466 * The bitmap font structure
468 typedef struct tagSFG_Font SFG_Font;
471 char* Name; /* The source font name */
472 int Quantity; /* Number of chars in font */
473 int Height; /* Height of the characters */
474 const GLubyte** Characters; /* The characters mapping */
476 float xorig, yorig ; /* The origin of the character relative to the draw location */
480 * The stroke font structures
483 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
484 struct tagSFG_StrokeVertex
489 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
490 struct tagSFG_StrokeStrip
493 const SFG_StrokeVertex* Vertices;
496 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
497 struct tagSFG_StrokeChar
501 const SFG_StrokeStrip* Strips;
504 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
505 struct tagSFG_StrokeFont
507 char* Name; /* The source font name */
508 int Quantity; /* Number of chars in font */
509 GLfloat Height; /* Height of the characters */
510 const SFG_StrokeChar** Characters; /* The characters mapping */
513 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
516 * Freeglut display related stuff (initialized once per session)
518 extern SFG_Display fgDisplay;
521 * Freeglut internal structure
523 extern SFG_Structure fgStructure;
526 * The current freeglut settings
528 extern SFG_State fgState;
531 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
534 * A call to this function makes us sure that the Display and Structure
535 * subsystems have been properly initialized and are ready to be used
537 #define freeglut_assert_ready assert( fgState.Time.Set );
540 * Following definitions are somewhat similiar to GLib's,
541 * but do not generate any log messages:
543 #define freeglut_return_if_fail( expr ) if( !(expr) ) return;
544 #define freeglut_return_val_if_fail( expr, val ) if( !(expr) ) return( val );
547 * A call to those macros assures us that there is a current
548 * window and menu set, respectively:
550 #define freeglut_assert_window assert( fgStructure.Window != NULL );
551 #define freeglut_assert_menu assert( fgStructure.Menu != NULL );
554 * The initialize and deinitialize functions get called on glutInit()
555 * and glutMainLoop() end respectively. They should create/clean up
556 * everything inside of the freeglut
558 void fgInitialize( const char* displayName );
559 void fgDeinitialize( void );
562 * Those two functions are used to create/destroy the freeglut internal
563 * structures. This actually happens when calling glutInit() and when
564 * quitting the glutMainLoop() (which actually happens, when all windows
567 void fgCreateStructure( void );
568 void fgDestroyStructure( void );
571 * A helper function to check if a display mode is possible to use
573 #if TARGET_HOST_UNIX_X11
574 XVisualInfo* fgChooseVisual( void );
578 * The window procedure for Win32 events handling
580 #if TARGET_HOST_WIN32
581 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam );
582 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly, unsigned char layer_type );
586 * Window creation, opening, closing and destruction.
587 * Defined in freeglut_structure.c, freeglut_window.c.
589 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title, int x, int y, int w, int h, GLboolean gameMode );
590 void fgSetWindow ( SFG_Window *window ) ;
591 void fgOpenWindow( SFG_Window* window, const char* title, int x, int y, int w, int h, GLboolean gameMode, int isSubWindow );
592 void fgCloseWindow( SFG_Window* window );
593 void fgAddToWindowDestroyList ( SFG_Window* window, GLboolean needToClose ) ;
594 void fgCloseWindows () ;
595 void fgDestroyWindow( SFG_Window* window, GLboolean needToClose );
598 * Menu creation and destruction. Defined in freeglut_structure.c
600 SFG_Menu* fgCreateMenu( FGCBmenu menuCallback );
601 void fgDestroyMenu( SFG_Menu* menu );
604 * Joystick device management functions, defined in freeglut_joystick.c
606 void fgJoystickInit( int ident );
607 void fgJoystickClose( void );
608 void fgJoystickPollWindow( SFG_Window* window );
611 * Helper function to enumerate through all registered windows
612 * and one to enumerate all of a window's subwindows...
614 * The GFunc callback for those functions will be defined as:
616 * void enumCallback( gpointer window, gpointer enumerator );
618 * where window is the enumerated (sub)window pointer (SFG_Window *),
619 * and userData is the a custom user-supplied pointer. Functions
620 * are defined and exported from freeglut_structure.c file.
622 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
623 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
626 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
627 * first window in the queue matching the specified window handle.
628 * The function is defined in freeglut_structure.c file.
630 #if TARGET_HOST_UNIX_X11
631 SFG_Window* fgWindowByHandle( Window hWindow );
632 #elif TARGET_HOST_WIN32
634 SFG_Window* fgWindowByHandle( HWND hWindow );
638 * This function is similiar to the previous one, except it is
639 * looking for a specified (sub)window identifier. The function
640 * is defined in freeglut_structure.c file.
642 SFG_Window* fgWindowByID( int windowID );
645 * Looks up a menu given its ID. This is easier that fgWindowByXXX
646 * as all menus are placed in a single doubly linked list...
648 SFG_Menu* fgMenuByID( int menuID );
651 * The menu activation and deactivation the code. This is the meat
652 * of the menu user interface handling code...
654 void fgActivateMenu( SFG_Window* window, int button );
655 void fgExecuteMenuCallback( SFG_Menu* menu ) ;
656 GLboolean fgCheckActiveMenu ( SFG_Window *window, SFG_Menu *menu ) ;
657 void fgDeactivateMenu( SFG_Window *window );
660 * This function gets called just before the buffers swap, so that
661 * freeglut can display the pull-down menus via OpenGL. The function
662 * is defined in freeglut_menu.c file.
664 void fgDisplayMenu( void );
667 * Display the mouse cursor using OpenGL calls. The function
668 * is defined in freeglut_cursor.c file.
670 void fgDisplayCursor( void );
673 * Elapsed time as per glutGet(GLUT_ELAPSED_TIME).
675 long fgElapsedTime( void );
680 void fgListInit(SFG_List *list);
681 void fgListAppend(SFG_List *list, SFG_Node *node);
682 void fgListRemove(SFG_List *list, SFG_Node *node);
683 int fgListLength(SFG_List *list);
686 * Error Messages functions
688 void fgError( const char *fmt, ... );
689 void fgWarning( const char *fmt, ... );
691 #endif /* FREEGLUT_INTERNAL_H */
693 /*** END OF FILE ***/