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 * Be sure to update these for every release!
34 #define VERSION_MAJOR 1
35 #define VERSION_MINOR 3
36 #define VERSION_PATCH 0
39 * Freeglut is meant to be available under all Unix/X11 and Win32 platforms.
42 # define TARGET_HOST_UNIX_X11 1
43 # define TARGET_HOST_WIN32 0
45 # define TARGET_HOST_UNIX_X11 0
46 # define TARGET_HOST_WIN32 1
49 #define FREEGLUT_MAX_MENUS 3
50 #define FREEGLUT_DEBUG 1
53 #undef G_DISABLE_ASSERT
54 #undef G_DISABLE_CHECKS
56 #define G_DISABLE_ASSERT
57 #define G_DISABLE_CHECKS
61 * Somehow all Win32 include headers depend on this one:
67 #define strdup _strdup
71 * Those files should be available on every platform.
81 #if TARGET_HOST_UNIX_X11
86 * The system-dependant include files should go here:
88 #if TARGET_HOST_UNIX_X11
91 #include <X11/Xatom.h>
92 #include <X11/keysym.h>
95 #include <X11/extensions/xf86vmode.h>
100 * Microsoft VisualC++ 5.0's <math.h> does not define the PI
103 # define M_PI 3.14159265358979323846
114 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
117 * Freeglut callbacks type definitions
119 typedef void (* FGCBdisplay )( void );
120 typedef void (* FGCBreshape )( int, int );
121 typedef void (* FGCBvisibility )( int );
122 typedef void (* FGCBkeyboard )( unsigned char, int, int );
123 typedef void (* FGCBspecial )( int, int, int );
124 typedef void (* FGCBmouse )( int, int, int, int );
125 typedef void (* FGCBmotion )( int, int );
126 typedef void (* FGCBpassive )( int, int );
127 typedef void (* FGCBentry )( int );
128 typedef void (* FGCBwindowStatus )( int );
129 typedef void (* FGCBmenuState )( int );
130 typedef void (* FGCBmenuStatus )( int, int, int );
131 typedef void (* FGCBselect )( int, int, int );
132 typedef void (* FGCBjoystick )( unsigned int, int, int, int );
133 typedef void (* FGCBkeyboardUp )( unsigned char, int, int );
134 typedef void (* FGCBspecialUp )( int, int, int );
135 typedef void (* FGCBoverlayDisplay)( void );
136 typedef void (* FGCBspaceMotion )( int, int, int );
137 typedef void (* FGCBspaceRotate )( int, int, int );
138 typedef void (* FGCBspaceButton )( int, int );
139 typedef void (* FGCBdials )( int, int );
140 typedef void (* FGCBbuttonBox )( int, int );
141 typedef void (* FGCBtabletMotion )( int, int );
142 typedef void (* FGCBtabletButton )( int, int, int, int );
143 typedef void (* FGCBdestroy )( void );
146 * The global callbacks type definitions
148 typedef void (* FGCBidle )( void );
149 typedef void (* FGCBtimer )( int );
152 * The callback used when creating/using menus
154 typedef void (* FGCBmenu )( int );
160 typedef struct tagSFG_List SFG_List;
168 * A list node structure
170 typedef struct tagSFG_Node SFG_Node;
178 * A helper structure holding two ints and a boolean
180 typedef struct tagSFG_XYUse SFG_XYUse;
183 GLint X, Y; /* The two integers... */
184 GLboolean Use; /* ...and a single boolean. */
188 * A helper structure holding a timeval and a boolean
190 typedef struct tagSFG_Time SFG_Time;
196 struct timeval Value;
202 * An enumeration containing the state of the GLUT execution: initializing, running, or stopping
205 GLUT_EXEC_STATE_INIT,
206 GLUT_EXEC_STATE_RUNNING,
211 * This structure holds different freeglut settings
213 typedef struct tagSFG_State SFG_State;
216 SFG_XYUse Position; /* The default windows' position */
217 SFG_XYUse Size; /* The default windows' size */
218 unsigned int DisplayMode; /* The display mode for new windows */
220 GLboolean ForceDirectContext; /* Should we force direct contexts? */
221 GLboolean TryDirectContext; /* What about giving a try to? */
223 GLboolean ForceIconic; /* All new top windows are iconified */
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; /* The time that glutInit was called */
235 SFG_List Timers; /* The freeglut timer hooks */
237 FGCBidle IdleCallback; /* The global idle callback */
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
265 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
266 int DisplayModeClock; /* The display mode's refresh rate */
269 #elif TARGET_HOST_WIN32
270 HINSTANCE Instance; /* The application's instance */
271 DEVMODE DisplayMode; /* Desktop's display settings */
275 int ScreenWidth; /* The screen's width in pixels */
276 int ScreenHeight; /* The screen's height in pixels */
277 int ScreenWidthMM; /* The screen's width in milimeters */
278 int ScreenHeightMM; /* The screen's height in milimeters */
283 * The user can create any number of timer hooks
285 typedef struct tagSFG_Timer SFG_Timer;
289 int ID; /* The timer ID integer */
290 FGCBtimer Callback; /* The timer callback */
291 long TriggerTime; /* The timer trigger time */
295 * A window and its OpenGL context. The contents of this structure
296 * are highly dependant on the target operating system we aim at...
298 typedef struct tagSFG_Context SFG_Context;
299 struct tagSFG_Context
301 #if TARGET_HOST_UNIX_X11
302 Window Handle; /* The window's handle */
303 GLXContext Context; /* The OpenGL context */
304 XVisualInfo* VisualInfo; /* The window's visual information */
306 #elif TARGET_HOST_WIN32
307 HWND Handle; /* The window's handle */
308 HDC Device; /* The window's device context */
309 HGLRC Context; /* The window's WGL context */
313 int DoubleBuffered; /* Treat the window as double-buffered */
317 * Window's state description. This structure should be kept portable.
319 typedef struct tagSFG_WindowState SFG_WindowState;
320 struct tagSFG_WindowState
322 int Width; /* Window's width in pixels */
323 int Height; /* The same about the height */
325 GLboolean Redisplay; /* Do we have to redisplay? */
326 GLboolean Visible; /* Is the window visible now */
328 int Cursor; /* The currently selected cursor */
329 int Modifiers; /* The current ALT/SHIFT/CTRL state */
331 long JoystickPollRate; /* The joystick polling rate */
332 long JoystickLastPoll; /* When the last poll has happened */
334 int MouseX, MouseY; /* The most recent mouse position */
336 GLboolean IsGameMode; /* Is this the game mode window? */
338 #if TARGET_HOST_WIN32
339 GLboolean NeedToResize; /* Do we need to explicitly resize? */
344 * The window callbacks the user can supply us with. Should be kept portable.
346 typedef struct tagSFG_WindowCallbacks SFG_WindowCallbacks;
347 struct tagSFG_WindowCallbacks
350 * Following callbacks are fully supported right now
351 * and are ready to be tested for GLUT conformance:
355 FGCBkeyboard Keyboard;
356 FGCBkeyboardUp KeyboardUp;
358 FGCBspecialUp SpecialUp;
363 FGCBvisibility Visibility;
364 FGCBwindowStatus WindowStatus;
365 FGCBjoystick Joystick;
369 * Those callbacks are being ignored for the moment
372 FGCBoverlayDisplay OverlayDisplay;
373 FGCBspaceMotion SpaceMotion;
374 FGCBspaceRotate SpaceRotation;
375 FGCBspaceButton SpaceButton;
377 FGCBbuttonBox ButtonBox;
378 FGCBtabletMotion TabletMotion;
379 FGCBtabletButton TabletButton;
383 * This structure describes a menu
385 typedef struct tagSFG_Menu SFG_Menu;
389 int ID; /* The global menu ID */
390 SFG_List Entries; /* The menu entries list */
391 FGCBmenu Callback; /* The menu callback */
392 GLboolean IsActive; /* Is the menu selected? */
393 int Width; /* Menu box width in pixels */
394 int Height; /* Menu box height in pixels */
395 int X, Y; /* Menu box raster position */
399 * This is a menu entry
401 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
402 struct tagSFG_MenuEntry
405 int ID; /* The menu entry ID (local) */
406 int Ordinal; /* The menu's ordinal number */
407 char* Text; /* The text to be displayed */
408 SFG_Menu* SubMenu; /* Optional sub-menu tree */
409 GLboolean IsActive; /* Is the entry highlighted? */
410 int Width; /* Label's width in pixels */
414 * A window, making part of FreeGLUT windows hierarchy. Should be kept portable.
416 typedef struct tagSFG_Window SFG_Window;
420 int ID; /* Window's ID number */
422 SFG_Context Window; /* Window and OpenGL context */
423 SFG_WindowState State; /* The window state */
424 SFG_WindowCallbacks Callbacks; /* The window callbacks */
426 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
427 SFG_Menu* ActiveMenu; /* The window's active menu */
429 SFG_Window* Parent; /* The parent to this window */
430 SFG_List Children; /* The subwindows d.l. list */
434 * A linked list structure of windows
436 typedef struct tagSFG_WindowList SFG_WindowList ;
437 struct tagSFG_WindowList
440 GLboolean needToClose ;
441 SFG_WindowList *next ;
445 * This holds information about all the windows, menus etc.
447 typedef struct tagSFG_Structure SFG_Structure;
448 struct tagSFG_Structure
450 SFG_List Windows; /* The global windows list */
451 SFG_List Menus; /* The global menus list */
453 SFG_Window* Window; /* The currently active win. */
454 SFG_Menu* Menu; /* Same, but menu... */
456 SFG_Window* GameMode; /* The game mode window */
458 int WindowID; /* The new current window ID */
459 int MenuID; /* The new current menu ID */
463 * This structure is used for the enumeration purposes.
464 * You can easily extend its functionalities by declaring
465 * a structure containing enumerator's contents and custom
466 * data, then casting its pointer to (SFG_Enumerator *).
468 typedef struct tagSFG_Enumerator SFG_Enumerator;
469 struct tagSFG_Enumerator
471 GLboolean found; /* Used to terminate search */
472 void* data; /* Custom data pointer */
474 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
477 * The bitmap font structure
479 typedef struct tagSFG_Font SFG_Font;
482 char* Name; /* The source font name */
483 int Quantity; /* Number of chars in font */
484 int Height; /* Height of the characters */
485 const GLubyte** Characters; /* The characters mapping */
487 float xorig, yorig ; /* The origin of the character relative to the draw location */
491 * The stroke font structures
494 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
495 struct tagSFG_StrokeVertex
500 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
501 struct tagSFG_StrokeStrip
504 const SFG_StrokeVertex* Vertices;
507 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
508 struct tagSFG_StrokeChar
512 const SFG_StrokeStrip* Strips;
515 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
516 struct tagSFG_StrokeFont
518 char* Name; /* The source font name */
519 int Quantity; /* Number of chars in font */
520 GLfloat Height; /* Height of the characters */
521 const SFG_StrokeChar** Characters; /* The characters mapping */
524 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
527 * Freeglut display related stuff (initialized once per session)
529 extern SFG_Display fgDisplay;
532 * Freeglut internal structure
534 extern SFG_Structure fgStructure;
537 * The current freeglut settings
539 extern SFG_State fgState;
542 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
545 * A call to this function makes us sure that the Display and Structure
546 * subsystems have been properly initialized and are ready to be used
548 #define freeglut_assert_ready assert( fgState.Time.Set );
551 * Following definitions are somewhat similiar to GLib's,
552 * but do not generate any log messages:
554 #define freeglut_return_if_fail( expr ) if( !(expr) ) return;
555 #define freeglut_return_val_if_fail( expr, val ) if( !(expr) ) return( val );
558 * A call to those macros assures us that there is a current
559 * window and menu set, respectively:
561 #define freeglut_assert_window assert( fgStructure.Window != NULL );
562 #define freeglut_assert_menu assert( fgStructure.Menu != NULL );
565 * The initialize and deinitialize functions get called on glutInit()
566 * and glutMainLoop() end respectively. They should create/clean up
567 * everything inside of the freeglut
569 void fgInitialize( const char* displayName );
570 void fgDeinitialize( void );
573 * Those two functions are used to create/destroy the freeglut internal
574 * structures. This actually happens when calling glutInit() and when
575 * quitting the glutMainLoop() (which actually happens, when all windows
578 void fgCreateStructure( void );
579 void fgDestroyStructure( void );
582 * A helper function to check if a display mode is possible to use
584 #if TARGET_HOST_UNIX_X11
585 XVisualInfo* fgChooseVisual( void );
589 * The window procedure for Win32 events handling
591 #if TARGET_HOST_WIN32
592 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam );
593 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly, unsigned char layer_type );
597 * Window creation, opening, closing and destruction.
598 * Defined in freeglut_structure.c, freeglut_window.c.
600 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title, int x, int y, int w, int h, GLboolean gameMode );
601 void fgSetWindow ( SFG_Window *window ) ;
602 void fgOpenWindow( SFG_Window* window, const char* title, int x, int y, int w, int h, GLboolean gameMode, int isSubWindow );
603 void fgCloseWindow( SFG_Window* window );
604 void fgAddToWindowDestroyList ( SFG_Window* window, GLboolean needToClose ) ;
605 void fgCloseWindows () ;
606 void fgDestroyWindow( SFG_Window* window, GLboolean needToClose );
609 * Menu creation and destruction. Defined in freeglut_structure.c
611 SFG_Menu* fgCreateMenu( FGCBmenu menuCallback );
612 void fgDestroyMenu( SFG_Menu* menu );
615 * Joystick device management functions, defined in freeglut_joystick.c
617 void fgJoystickInit( int ident );
618 void fgJoystickClose( void );
619 void fgJoystickPollWindow( SFG_Window* window );
622 * Helper function to enumerate through all registered windows
623 * and one to enumerate all of a window's subwindows...
625 * The GFunc callback for those functions will be defined as:
627 * void enumCallback( gpointer window, gpointer enumerator );
629 * where window is the enumerated (sub)window pointer (SFG_Window *),
630 * and userData is the a custom user-supplied pointer. Functions
631 * are defined and exported from freeglut_structure.c file.
633 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
634 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
637 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
638 * first window in the queue matching the specified window handle.
639 * The function is defined in freeglut_structure.c file.
641 #if TARGET_HOST_UNIX_X11
642 SFG_Window* fgWindowByHandle( Window hWindow );
643 #elif TARGET_HOST_WIN32
645 SFG_Window* fgWindowByHandle( HWND hWindow );
649 * This function is similiar to the previous one, except it is
650 * looking for a specified (sub)window identifier. The function
651 * is defined in freeglut_structure.c file.
653 SFG_Window* fgWindowByID( int windowID );
656 * Looks up a menu given its ID. This is easier that fgWindowByXXX
657 * as all menus are placed in a single doubly linked list...
659 SFG_Menu* fgMenuByID( int menuID );
662 * The menu activation and deactivation the code. This is the meat
663 * of the menu user interface handling code...
665 void fgActivateMenu( SFG_Window* window, int button );
666 void fgExecuteMenuCallback( SFG_Menu* menu ) ;
667 GLboolean fgCheckActiveMenu ( SFG_Window *window, SFG_Menu *menu ) ;
668 void fgDeactivateMenu( SFG_Window *window );
671 * This function gets called just before the buffers swap, so that
672 * freeglut can display the pull-down menus via OpenGL. The function
673 * is defined in freeglut_menu.c file.
675 void fgDisplayMenu( void );
678 * Display the mouse cursor using OpenGL calls. The function
679 * is defined in freeglut_cursor.c file.
681 void fgDisplayCursor( void );
684 * Elapsed time as per glutGet(GLUT_ELAPSED_TIME).
686 long fgElapsedTime( void );
691 void fgListInit(SFG_List *list);
692 void fgListAppend(SFG_List *list, SFG_Node *node);
693 void fgListRemove(SFG_List *list, SFG_Node *node);
694 int fgListLength(SFG_List *list);
697 * Error Messages functions
699 void fgError( const char *fmt, ... );
700 void fgWarning( const char *fmt, ... );
702 #endif /* FREEGLUT_INTERNAL_H */
704 /*** END OF FILE ***/