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:
62 * Those files should be available on every platform.
72 #if TARGET_HOST_UNIX_X11
77 * The system-dependant include files should go here:
79 #if TARGET_HOST_UNIX_X11
82 #include <X11/Xatom.h>
83 #include <X11/keysym.h>
86 * This will generate errors, but I don't have any idea how to fix it (will autoconf help?)
88 #include <X11/extensions/xf86vmode.h>
92 * Microsoft VisualC++ 5.0's <math.h> does not define the PI
95 # define M_PI 3.14159265358979323846
106 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
109 * Freeglut callbacks type definitions
111 typedef void (* FGCBdisplay )( void );
112 typedef void (* FGCBreshape )( int, int );
113 typedef void (* FGCBvisibility )( int );
114 typedef void (* FGCBkeyboard )( unsigned char, int, int );
115 typedef void (* FGCBspecial )( int, int, int );
116 typedef void (* FGCBmouse )( int, int, int, int );
117 typedef void (* FGCBmotion )( int, int );
118 typedef void (* FGCBpassive )( int, int );
119 typedef void (* FGCBentry )( int );
120 typedef void (* FGCBwindowStatus )( int );
121 typedef void (* FGCBmenuState )( int );
122 typedef void (* FGCBmenuStatus )( int, int, int );
123 typedef void (* FGCBselect )( int, int, int );
124 typedef void (* FGCBjoystick )( unsigned int, int, int, int );
125 typedef void (* FGCBkeyboardUp )( unsigned char, int, int );
126 typedef void (* FGCBspecialUp )( int, int, int );
127 typedef void (* FGCBoverlayDisplay)( void );
128 typedef void (* FGCBspaceMotion )( int, int, int );
129 typedef void (* FGCBspaceRotate )( int, int, int );
130 typedef void (* FGCBspaceButton )( int, int );
131 typedef void (* FGCBdials )( int, int );
132 typedef void (* FGCBbuttonBox )( int, int );
133 typedef void (* FGCBtabletMotion )( int, int );
134 typedef void (* FGCBtabletButton )( int, int, int, int );
135 typedef void (* FGCBdestroy )( void );
138 * The global callbacks type definitions
140 typedef void (* FGCBidle )( void );
141 typedef void (* FGCBtimer )( int );
144 * The callback used when creating/using menus
146 typedef void (* FGCBmenu )( int );
152 typedef struct tagSFG_List SFG_List;
160 * A list node structure
162 typedef struct tagSFG_Node SFG_Node;
170 * A helper structure holding two ints and a boolean
172 typedef struct tagSFG_XYUse SFG_XYUse;
175 GLint X, Y; /* The two integers... */
176 GLboolean Use; /* ...and a single boolean. */
180 * A helper structure holding a timeval and a boolean
182 typedef struct tagSFG_Time SFG_Time;
188 struct timeval Value;
194 * An enumeration containing the state of the GLUT execution: initializing, running, or stopping
197 GLUT_EXEC_STATE_INIT,
198 GLUT_EXEC_STATE_RUNNING,
203 * This structure holds different freeglut settings
205 typedef struct tagSFG_State SFG_State;
208 SFG_XYUse Position; /* The default windows' position */
209 SFG_XYUse Size; /* The default windows' size */
210 unsigned int DisplayMode; /* The display mode for new windows */
212 GLboolean ForceDirectContext; /* Should we force direct contexts? */
213 GLboolean TryDirectContext; /* What about giving a try to? */
215 GLboolean ForceIconic; /* All new top windows are iconified */
217 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
218 GLboolean XSyncSwitch; /* X11 sync protocol switch */
220 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat... */
222 SFG_Time Time; /* The time that glutInit was called */
223 SFG_List Timers; /* The freeglut timer hooks */
225 FGCBidle IdleCallback; /* The global idle callback */
227 FGCBmenuState MenuStateCallback; /* Menu callbacks are global */
228 FGCBmenuStatus MenuStatusCallback;
230 SFG_XYUse GameModeSize; /* The game mode screen's dimensions */
231 int GameModeDepth; /* The pixel depth for game mode */
232 int GameModeRefresh; /* The refresh rate for game mode */
234 int ActionOnWindowClose ; /* Action when user clicks "x" on window header bar */
236 fgExecutionState ExecState ; /* Current state of the GLUT execution */
240 * The structure used by display initialization in freeglut_init.c
242 typedef struct tagSFG_Display SFG_Display;
243 struct tagSFG_Display
245 #if TARGET_HOST_UNIX_X11
246 Display* Display; /* The display we are being run in. */
247 int Screen; /* The screen we are about to use. */
248 Window RootWindow; /* The screen's root window. */
249 int Connection; /* The display's connection number */
250 Atom DeleteWindow; /* The window deletion atom */
252 #ifdef X_XF86VidModeGetModeLine
253 XF86VidModeModeLine DisplayMode; /* Current screen's display settings */
254 int DisplayModeClock; /* The display mode's refresh rate */
257 #elif TARGET_HOST_WIN32
258 HINSTANCE Instance; /* The application's instance */
259 DEVMODE DisplayMode; /* Desktop's display settings */
263 int ScreenWidth; /* The screen's width in pixels */
264 int ScreenHeight; /* The screen's height in pixels */
265 int ScreenWidthMM; /* The screen's width in milimeters */
266 int ScreenHeightMM; /* The screen's height in milimeters */
271 * The user can create any number of timer hooks
273 typedef struct tagSFG_Timer SFG_Timer;
277 int ID; /* The timer ID integer */
278 FGCBtimer Callback; /* The timer callback */
279 long TriggerTime; /* The timer trigger time */
283 * A window and its OpenGL context. The contents of this structure
284 * are highly dependant on the target operating system we aim at...
286 typedef struct tagSFG_Context SFG_Context;
287 struct tagSFG_Context
289 #if TARGET_HOST_UNIX_X11
290 Window Handle; /* The window's handle */
291 GLXContext Context; /* The OpenGL context */
292 XVisualInfo* VisualInfo; /* The window's visual information */
294 #elif TARGET_HOST_WIN32
295 HWND Handle; /* The window's handle */
296 HDC Device; /* The window's device context */
297 HGLRC Context; /* The window's WGL context */
303 * Window's state description. This structure should be kept portable.
305 typedef struct tagSFG_WindowState SFG_WindowState;
306 struct tagSFG_WindowState
308 int Width; /* Window's width in pixels */
309 int Height; /* The same about the height */
311 GLboolean Redisplay; /* Do we have to redisplay? */
312 GLboolean Visible; /* Is the window visible now */
314 int Cursor; /* The currently selected cursor */
315 int Modifiers; /* The current ALT/SHIFT/CTRL state */
317 long JoystickPollRate; /* The joystick polling rate */
318 long JoystickLastPoll; /* When the last poll has happened */
320 int MouseX, MouseY; /* The most recent mouse position */
322 GLboolean IsGameMode; /* Is this the game mode window? */
324 #if TARGET_HOST_WIN32
325 GLboolean NeedToResize; /* Do we need to explicitly resize? */
330 * The window callbacks the user can supply us with. Should be kept portable.
332 typedef struct tagSFG_WindowCallbacks SFG_WindowCallbacks;
333 struct tagSFG_WindowCallbacks
336 * Following callbacks are fully supported right now
337 * and are ready to be tested for GLUT conformance:
341 FGCBkeyboard Keyboard;
342 FGCBkeyboardUp KeyboardUp;
344 FGCBspecialUp SpecialUp;
349 FGCBvisibility Visibility;
350 FGCBwindowStatus WindowStatus;
351 FGCBjoystick Joystick;
355 * Those callbacks are being ignored for the moment
358 FGCBoverlayDisplay OverlayDisplay;
359 FGCBspaceMotion SpaceMotion;
360 FGCBspaceRotate SpaceRotation;
361 FGCBspaceButton SpaceButton;
363 FGCBbuttonBox ButtonBox;
364 FGCBtabletMotion TabletMotion;
365 FGCBtabletButton TabletButton;
369 * This structure describes a menu
371 typedef struct tagSFG_Menu SFG_Menu;
375 int ID; /* The global menu ID */
376 SFG_List Entries; /* The menu entries list */
377 FGCBmenu Callback; /* The menu callback */
378 GLboolean IsActive; /* Is the menu selected? */
379 int Width; /* Menu box width in pixels */
380 int Height; /* Menu box height in pixels */
381 int X, Y; /* Menu box raster position */
385 * This is a menu entry
387 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
388 struct tagSFG_MenuEntry
391 int ID; /* The menu entry ID (local) */
392 int Ordinal; /* The menu's ordinal number */
393 char* Text; /* The text to be displayed */
394 SFG_Menu* SubMenu; /* Optional sub-menu tree */
395 GLboolean IsActive; /* Is the entry highlighted? */
396 int Width; /* Label's width in pixels */
400 * A window, making part of FreeGLUT windows hierarchy. Should be kept portable.
402 typedef struct tagSFG_Window SFG_Window;
406 int ID; /* Window's ID number */
408 SFG_Context Window; /* Window and OpenGL context */
409 SFG_WindowState State; /* The window state */
410 SFG_WindowCallbacks Callbacks; /* The window callbacks */
412 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
413 SFG_Menu* ActiveMenu; /* The window's active menu */
415 SFG_Window* Parent; /* The parent to this window */
416 SFG_List Children; /* The subwindows d.l. list */
420 * A linked list structure of windows
422 typedef struct tagSFG_WindowList SFG_WindowList ;
423 struct tagSFG_WindowList
426 GLboolean needToClose ;
427 SFG_WindowList *next ;
431 * This holds information about all the windows, menus etc.
433 typedef struct tagSFG_Structure SFG_Structure;
434 struct tagSFG_Structure
436 SFG_List Windows; /* The global windows list */
437 SFG_List Menus; /* The global menus list */
439 SFG_Window* Window; /* The currently active win. */
440 SFG_Menu* Menu; /* Same, but menu... */
442 SFG_Window* GameMode; /* The game mode window */
444 int WindowID; /* The new current window ID */
445 int MenuID; /* The new current menu ID */
449 * This structure is used for the enumeration purposes.
450 * You can easily extend its functionalities by declaring
451 * a structure containing enumerator's contents and custom
452 * data, then casting its pointer to (SFG_Enumerator *).
454 typedef struct tagSFG_Enumerator SFG_Enumerator;
455 struct tagSFG_Enumerator
457 GLboolean found; /* Used to terminate search */
458 void* data; /* Custom data pointer */
460 typedef void (* FGCBenumerator )( SFG_Window *, SFG_Enumerator * );
463 * The bitmap font structure
465 typedef struct tagSFG_Font SFG_Font;
468 char* Name; /* The source font name */
469 int Quantity; /* Number of chars in font */
470 int Height; /* Height of the characters */
471 const GLubyte** Characters; /* The characters mapping */
473 float xorig, yorig ; /* The origin of the character relative to the draw location */
477 * The stroke font structures
480 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
481 struct tagSFG_StrokeVertex
486 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
487 struct tagSFG_StrokeStrip
490 const SFG_StrokeVertex* Vertices;
493 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
494 struct tagSFG_StrokeChar
498 const SFG_StrokeStrip* Strips;
501 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
502 struct tagSFG_StrokeFont
504 char* Name; /* The source font name */
505 int Quantity; /* Number of chars in font */
506 GLfloat Height; /* Height of the characters */
507 const SFG_StrokeChar** Characters; /* The characters mapping */
510 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
513 * Freeglut display related stuff (initialized once per session)
515 extern SFG_Display fgDisplay;
518 * Freeglut internal structure
520 extern SFG_Structure fgStructure;
523 * The current freeglut settings
525 extern SFG_State fgState;
528 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
531 * A call to this function makes us sure that the Display and Structure
532 * subsystems have been properly initialized and are ready to be used
534 #define freeglut_assert_ready assert( fgState.Time.Set );
537 * Following definitions are somewhat similiar to GLib's,
538 * but do not generate any log messages:
540 #define freeglut_return_if_fail( expr ) if( !(expr) ) return;
541 #define freeglut_return_val_if_fail( expr, val ) if( !(expr) ) return( val );
544 * A call to those macros assures us that there is a current
545 * window and menu set, respectively:
547 #define freeglut_assert_window assert( fgStructure.Window != NULL );
548 #define freeglut_assert_menu assert( fgStructure.Menu != NULL );
551 * The initialize and deinitialize functions get called on glutInit()
552 * and glutMainLoop() end respectively. They should create/clean up
553 * everything inside of the freeglut
555 void fgInitialize( const char* displayName );
556 void fgDeinitialize( void );
559 * Those two functions are used to create/destroy the freeglut internal
560 * structures. This actually happens when calling glutInit() and when
561 * quitting the glutMainLoop() (which actually happens, when all windows
564 void fgCreateStructure( void );
565 void fgDestroyStructure( void );
568 * A helper function to check if a display mode is possible to use
570 #if TARGET_HOST_UNIX_X11
571 XVisualInfo* fgChooseVisual( void );
575 * The window procedure for Win32 events handling
577 #if TARGET_HOST_WIN32
578 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam );
579 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly );
583 * Window creation, opening, closing and destruction.
584 * Defined in freeglut_structure.c, freeglut_window.c.
586 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title, int x, int y, int w, int h, GLboolean gameMode );
587 void fgOpenWindow( SFG_Window* window, const char* title, int x, int y, int w, int h, GLboolean gameMode, int isSubWindow );
588 void fgCloseWindow( SFG_Window* window );
589 void fgAddToWindowDestroyList ( SFG_Window* window, GLboolean needToClose ) ;
590 void fgCloseWindows () ;
591 void fgDestroyWindow( SFG_Window* window, GLboolean needToClose );
594 * Menu creation and destruction. Defined in freeglut_structure.c
596 SFG_Menu* fgCreateMenu( FGCBmenu menuCallback );
597 void fgDestroyMenu( SFG_Menu* menu );
600 * Joystick device management functions, defined in freeglut_joystick.c
602 void fgJoystickInit( int ident );
603 void fgJoystickClose( void );
604 void fgJoystickPollWindow( SFG_Window* window );
607 * Helper function to enumerate through all registered windows
608 * and one to enumerate all of a window's subwindows...
610 * The GFunc callback for those functions will be defined as:
612 * void enumCallback( gpointer window, gpointer enumerator );
614 * where window is the enumerated (sub)window pointer (SFG_Window *),
615 * and userData is the a custom user-supplied pointer. Functions
616 * are defined and exported from freeglut_structure.c file.
618 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
619 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
622 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
623 * first window in the queue matching the specified window handle.
624 * The function is defined in freeglut_structure.c file.
626 #if TARGET_HOST_UNIX_X11
627 SFG_Window* fgWindowByHandle( Window hWindow );
628 #elif TARGET_HOST_WIN32
630 SFG_Window* fgWindowByHandle( HWND hWindow );
634 * This function is similiar to the previous one, except it is
635 * looking for a specified (sub)window identifier. The function
636 * is defined in freeglut_structure.c file.
638 SFG_Window* fgWindowByID( int windowID );
641 * Looks up a menu given its ID. This is easier that fgWindowByXXX
642 * as all menus are placed in a single doubly linked list...
644 SFG_Menu* fgMenuByID( int menuID );
647 * The menu activation and deactivation the code. This is the meat
648 * of the menu user interface handling code...
650 void fgActivateMenu( SFG_Window* window, int button );
651 void fgExecuteMenuCallback( SFG_Menu* menu ) ;
652 GLboolean fgCheckActiveMenu ( SFG_Window *window, SFG_Menu *menu ) ;
653 void fgDeactivateMenu( SFG_Window *window );
656 * This function gets called just before the buffers swap, so that
657 * freeglut can display the pull-down menus via OpenGL. The function
658 * is defined in freeglut_menu.c file.
660 void fgDisplayMenu( void );
663 * Display the mouse cursor using OpenGL calls. The function
664 * is defined in freeglut_cursor.c file.
666 void fgDisplayCursor( void );
669 * Elapsed time as per glutGet(GLUT_ELAPSED_TIME).
671 long fgElapsedTime( void );
676 void fgListInit(SFG_List *list);
677 void fgListAppend(SFG_List *list, SFG_Node *node);
678 void fgListRemove(SFG_List *list, SFG_Node *node);
679 int fgListLength(SFG_List *list);
682 * Error Messages functions
684 void fgError( const char *fmt, ... );
685 void fgWarning( const char *fmt, ... );
687 #endif /* FREEGLUT_INTERNAL_H */
689 /*** END OF FILE ***/