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
35 #include "fg_version.h"
36 #include "fg_callback_macros.h"
38 /* Freeglut is intended to function under all Unix/X11 and Win32 platforms. */
39 /* XXX: Don't all MS-Windows compilers (except Cygwin) have _WIN32 defined?
40 * XXX: If so, remove the first set of defined()'s below.
42 #if !defined(TARGET_HOST_POSIX_X11) && !defined(TARGET_HOST_MS_WINDOWS) && !defined(TARGET_HOST_MAC_OSX) && !defined(TARGET_HOST_SOLARIS) && \
43 !defined(TARGET_HOST_ANDROID) && !defined(TARGET_HOST_BLACKBERRY) && !defined(TARGET_HOST_POSIX_WAYLAND)
44 #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__MINGW32__) \
45 || defined(_WIN32) || defined(_WIN32_WCE) \
46 || ( defined(__CYGWIN__) && defined(X_DISPLAY_MISSING) )
47 # define TARGET_HOST_MS_WINDOWS 1
49 #elif defined (__ANDROID__)
50 # define TARGET_HOST_ANDROID 1
52 #elif defined (__QNXNTO__) || defined (__PLAYBOOK__)
53 # define TARGET_HOST_BLACKBERRY 1
55 #elif defined(__posix__) || defined(__unix__) || defined(__linux__) || defined(__sun)
56 # if defined(FREEGLUT_WAYLAND)
57 # define TARGET_HOST_POSIX_WAYLAND 1
59 # define TARGET_HOST_POSIX_X11 1
62 #elif defined(__APPLE__)
63 /* This is a placeholder until we get native OSX support ironed out -- JFF 11/18/09 */
64 # define TARGET_HOST_POSIX_X11 1
65 /* # define TARGET_HOST_MAC_OSX 1 */
68 # error "Unrecognized target host!"
73 /* Detect both SunPro and gcc compilers on Sun Solaris */
74 #if defined (__SVR4) && defined (__sun)
75 # define TARGET_HOST_SOLARIS 1
78 #ifndef TARGET_HOST_MS_WINDOWS
79 # define TARGET_HOST_MS_WINDOWS 0
82 #ifndef TARGET_HOST_ANDROID
83 # define TARGET_HOST_ANDROID 0
86 #ifndef TARGET_HOST_BLACKBERRY
87 # define TARGET_HOST_BLACKBERRY 0
90 #ifndef TARGET_HOST_POSIX_WAYLAND
91 # define TARGET_HOST_POSIX_WAYLAND 0
94 #ifndef TARGET_HOST_POSIX_X11
95 # define TARGET_HOST_POSIX_X11 0
98 #ifndef TARGET_HOST_MAC_OSX
99 # define TARGET_HOST_MAC_OSX 0
102 #ifndef TARGET_HOST_SOLARIS
103 # define TARGET_HOST_SOLARIS 0
106 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
108 #define FREEGLUT_MAX_MENUS 3
110 /* These files should be available on every platform. */
117 /* These are included based on autoconf directives. */
118 #ifdef HAVE_SYS_TYPES_H
119 # include <sys/types.h>
124 #ifdef TIME_WITH_SYS_TIME
125 # include <sys/time.h>
127 #elif defined(HAVE_SYS_TIME_H)
128 # include <sys/time.h>
133 /* -- AUTOCONF HACKS --------------------------------------------------------*/
135 /* XXX: Update autoconf to avoid these.
136 * XXX: Are non-POSIX platforms intended not to use autoconf?
137 * If so, perhaps there should be a config_guess.h for them. Alternatively,
138 * config guesses could be placed above, just after the config.h exclusion.
140 #if defined(__FreeBSD__) || defined(__NetBSD__)
141 # define HAVE_USB_JS 1
142 # if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
143 # define HAVE_USBHID_H 1
147 #if defined(_MSC_VER) || defined(__WATCOMC__)
148 /* strdup() is non-standard, for all but POSIX-2001 */
149 #define strdup _strdup
152 /* M_PI is non-standard (defined by BSD, not ISO-C) */
154 # define M_PI 3.14159265358979323846
157 #ifdef HAVE_STDBOOL_H
158 # include <stdbool.h>
174 /* General defines */
175 #define INVALID_MODIFIERS 0xffffffff
177 /* FreeGLUT internal time type */
178 #if defined(HAVE_STDINT_H)
180 typedef uint64_t fg_time_t;
181 #elif defined(HAVE_INTTYPES_H)
182 # include <inttypes.h>
183 typedef uint64_t fg_time_t;
184 #elif defined(HAVE_U__INT64)
185 typedef unsigned __int64 fg_time_t;
186 #elif defined(HAVE_ULONG_LONG)
187 typedef unsigned long long fg_time_t;
189 typedef unsigned long fg_time_t;
194 # define __fg_unused __attribute__((unused))
200 /* Platform-specific includes */
201 #if TARGET_HOST_POSIX_WAYLAND
202 #include "wayland/fg_internal_wl.h"
204 #if TARGET_HOST_POSIX_X11
205 #include "x11/fg_internal_x11.h"
207 #if TARGET_HOST_MS_WINDOWS
208 #include "mswin/fg_internal_mswin.h"
210 #if TARGET_HOST_ANDROID
211 #include "android/fg_internal_android.h"
213 #if TARGET_HOST_BLACKBERRY
214 #include "blackberry/fg_internal_blackberry.h"
218 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
221 * Freeglut callbacks type definitions
223 * If anything here is modified or added, update fg_callback_macros.h functions.
225 * This is not ideal, but freeglut needs to either define minimal compiler specs,
226 * or update header every time this is changed or updated.
228 typedef void* FGCBUserData;
230 typedef void (* FGCBDisplay )( void );
231 typedef void (* FGCBDisplayUC )( FGCBUserData );
232 typedef void (* FGCBReshape )( int, int );
233 typedef void (* FGCBReshapeUC )( int, int, FGCBUserData );
234 typedef void (* FGCBPosition )( int, int );
235 typedef void (* FGCBPositionUC )( int, int, FGCBUserData );
236 typedef void (* FGCBVisibility )( int );
237 typedef void (* FGCBVisibilityUC )( int, FGCBUserData );
238 typedef void (* FGCBKeyboard )( unsigned char, int, int );
239 typedef void (* FGCBKeyboardUC )( unsigned char, int, int, FGCBUserData );
240 typedef void (* FGCBKeyboardUp )( unsigned char, int, int );
241 typedef void (* FGCBKeyboardUpUC )( unsigned char, int, int, FGCBUserData );
242 typedef void (* FGCBSpecial )( int, int, int );
243 typedef void (* FGCBSpecialUC )( int, int, int, FGCBUserData );
244 typedef void (* FGCBSpecialUp )( int, int, int );
245 typedef void (* FGCBSpecialUpUC )( int, int, int, FGCBUserData );
246 typedef void (* FGCBMouse )( int, int, int, int );
247 typedef void (* FGCBMouseUC )( int, int, int, int, FGCBUserData );
248 typedef void (* FGCBMouseWheel )( int, int, int, int );
249 typedef void (* FGCBMouseWheelUC )( int, int, int, int, FGCBUserData );
250 typedef void (* FGCBMotion )( int, int );
251 typedef void (* FGCBMotionUC )( int, int, FGCBUserData );
252 typedef void (* FGCBPassive )( int, int );
253 typedef void (* FGCBPassiveUC )( int, int, FGCBUserData );
254 typedef void (* FGCBEntry )( int );
255 typedef void (* FGCBEntryUC )( int, FGCBUserData );
256 typedef void (* FGCBWindowStatus )( int );
257 typedef void (* FGCBWindowStatusUC )( int, FGCBUserData );
258 typedef void (* FGCBJoystick )( unsigned int, int, int, int );
259 typedef void (* FGCBJoystickUC )( unsigned int, int, int, int, FGCBUserData );
260 typedef void (* FGCBOverlayDisplay )( void );
261 typedef void (* FGCBOverlayDisplayUC)( FGCBUserData );
262 typedef void (* FGCBSpaceMotion )( int, int, int );
263 typedef void (* FGCBSpaceMotionUC )( int, int, int, FGCBUserData );
264 typedef void (* FGCBSpaceRotation )( int, int, int );
265 typedef void (* FGCBSpaceRotationUC )( int, int, int, FGCBUserData );
266 typedef void (* FGCBSpaceButton )( int, int );
267 typedef void (* FGCBSpaceButtonUC )( int, int, FGCBUserData );
268 typedef void (* FGCBDials )( int, int );
269 typedef void (* FGCBDialsUC )( int, int, FGCBUserData );
270 typedef void (* FGCBButtonBox )( int, int );
271 typedef void (* FGCBButtonBoxUC )( int, int, FGCBUserData );
272 typedef void (* FGCBTabletMotion )( int, int );
273 typedef void (* FGCBTabletMotionUC )( int, int, FGCBUserData );
274 typedef void (* FGCBTabletButton )( int, int, int, int );
275 typedef void (* FGCBTabletButtonUC )( int, int, int, int, FGCBUserData );
276 typedef void (* FGCBDestroy )( void ); /* Used for both window and menu destroy callbacks */
277 typedef void (* FGCBDestroyUC )( FGCBUserData );
279 typedef void (* FGCBMultiEntry )( int, int );
280 typedef void (* FGCBMultiEntryUC )( int, int, FGCBUserData );
281 typedef void (* FGCBMultiButton )( int, int, int, int, int );
282 typedef void (* FGCBMultiButtonUC )( int, int, int, int, int, FGCBUserData );
283 typedef void (* FGCBMultiMotion )( int, int, int );
284 typedef void (* FGCBMultiMotionUC )( int, int, int, FGCBUserData );
285 typedef void (* FGCBMultiPassive )( int, int, int );
286 typedef void (* FGCBMultiPassiveUC )( int, int, int, FGCBUserData );
288 typedef void (* FGCBInitContext )( void );
289 typedef void (* FGCBInitContextUC )( FGCBUserData );
290 typedef void (* FGCBAppStatus )( int );
291 typedef void (* FGCBAppStatusUC )( int, FGCBUserData );
293 /* The global callbacks type definitions */
294 typedef void (* FGCBIdle )( void ); \
295 typedef void (* FGCBIdleUC )( FGCBUserData );
296 typedef void (* FGCBTimer )( int );
297 typedef void (* FGCBTimerUC )( int, FGCBUserData );
298 typedef void (* FGCBMenuState )( int );
299 typedef void (* FGCBMenuStatus )( int, int, int );
300 typedef void (* FGCBMenuStatusUC )( int, int, int, FGCBUserData );
302 /* The callback used when creating/using menus */
303 typedef void (* FGCBMenu )( int );
304 typedef void (* FGCBMenuUC )( int, FGCBUserData );
306 /* The FreeGLUT error/warning handler type definition */
307 typedef void (* FGError )( const char *fmt, va_list ap );
308 typedef void (* FGErrorUC )( const char *fmt, va_list ap, FGCBUserData userData );
309 typedef void (* FGWarning )( const char *fmt, va_list ap );
310 typedef void (* FGWarningUC )( const char *fmt, va_list ap, FGCBUserData userData );
313 /* A list structure */
314 typedef struct tagSFG_List SFG_List;
321 /* A list node structure */
322 typedef struct tagSFG_Node SFG_Node;
329 /* A helper structure holding two ints and a boolean */
330 typedef struct tagSFG_XYUse SFG_XYUse;
333 GLint X, Y; /* The two integers... */
334 GLboolean Use; /* ...and a single boolean. */
338 * An enumeration containing the state of the GLUT execution:
339 * initializing, running, or stopping
343 GLUT_EXEC_STATE_INIT,
344 GLUT_EXEC_STATE_RUNNING,
348 /* This structure holds different freeglut settings */
349 typedef struct tagSFG_State SFG_State;
352 SFG_XYUse Position; /* The default windows' position */
353 SFG_XYUse Size; /* The default windows' size */
354 unsigned int DisplayMode; /* Display mode for new windows */
356 GLboolean Initialised; /* freeglut has been initialised */
358 int DirectContext; /* Direct rendering state */
360 GLboolean ForceIconic; /* New top windows are iconified */
361 GLboolean UseCurrentContext; /* New windows share with current */
363 GLboolean GLDebugSwitch; /* OpenGL state debugging switch */
364 GLboolean XSyncSwitch; /* X11 sync protocol switch */
366 int KeyRepeat; /* Global key repeat mode. */
367 int Modifiers; /* Current ALT/SHIFT/CTRL state */
369 GLuint FPSInterval; /* Interval between FPS printfs */
370 GLuint SwapCount; /* Count of glutSwapBuffer calls */
371 GLuint SwapTime; /* Time of last SwapBuffers */
373 fg_time_t Time; /* Time that glutInit was called */
374 SFG_List Timers; /* The freeglut timer hooks */
375 SFG_List FreeTimers; /* The unused timer hooks */
377 FGCBIdleUC IdleCallback; /* The global idle callback */
378 FGCBUserData IdleCallbackData; /* The global idle callback data */
380 int ActiveMenus; /* Num. of currently active menus */
381 FGCBMenuState MenuStateCallback; /* Menu callbacks are global */
382 FGCBMenuStatusUC MenuStatusCallback;
383 FGCBUserData MenuStatusCallbackData;
384 void* MenuFont; /* Font to be used for newly created menus */
386 SFG_XYUse GameModeSize; /* Game mode screen's dimensions */
387 int GameModeDepth; /* The pixel depth for game mode */
388 int GameModeRefresh; /* The refresh rate for game mode */
390 int ActionOnWindowClose; /* Action when user closes window */
392 fgExecutionState ExecState; /* Used for GLUT termination */
393 char *ProgramName; /* Name of the invoking program */
394 GLboolean JoysticksInitialised; /* Only initialize if application calls for them */
395 int NumActiveJoysticks; /* Number of active joysticks (callback defined and positive pollrate) -- if zero, don't poll joysticks */
396 GLboolean InputDevsInitialised; /* Only initialize if application calls for them */
398 int MouseWheelTicks; /* Number of ticks the mouse wheel has turned */
400 int AuxiliaryBufferNumber;/* Number of auxiliary buffers */
401 int SampleNumber; /* Number of samples per pixel */
403 GLboolean SkipStaleMotion; /* skip stale motion events */
405 GLboolean StrokeFontDrawJoinDots;/* Draw dots between line segments of stroke fonts? */
406 GLboolean AllowNegativeWindowPosition; /* GLUT, by default, doesn't allow negative window positions. Enable it? */
408 int MajorVersion; /* Major OpenGL context version */
409 int MinorVersion; /* Minor OpenGL context version */
410 int ContextFlags; /* OpenGL context flags */
411 int ContextProfile; /* OpenGL context profile */
412 int HasOpenGL20; /* fgInitGL2 could find all OpenGL 2.0 functions */
413 FGErrorUC ErrorFunc; /* User defined error handler */
414 FGCBUserData ErrorFuncData; /* User defined error handler user data */
415 FGWarningUC WarningFunc; /* User defined warning handler */
416 FGCBUserData WarningFuncData; /* User defined warning handler user data */
419 /* The structure used by display initialization in fg_init.c */
420 typedef struct tagSFG_Display SFG_Display;
421 struct tagSFG_Display
423 SFG_PlatformDisplay pDisplay;
425 int ScreenWidth; /* The screen's width in pixels */
426 int ScreenHeight; /* The screen's height in pixels */
427 int ScreenWidthMM; /* The screen's width in milimeters */
428 int ScreenHeightMM; /* The screen's height in milimeters */
432 /* The user can create any number of timer hooks */
433 typedef struct tagSFG_Timer SFG_Timer;
437 int ID; /* The timer ID integer */
438 FGCBTimerUC Callback; /* The timer callback */
439 FGCBUserData CallbackData; /* The timer callback user data */
440 fg_time_t TriggerTime; /* The timer trigger time */
444 * A window and its OpenGL context. The contents of this structure
445 * are highly dependent on the target operating system we aim at...
447 typedef struct tagSFG_Context SFG_Context;
448 struct tagSFG_Context
450 SFG_WindowHandleType Handle; /* The window's handle */
451 SFG_WindowContextType Context; /* The window's OpenGL/WGL context */
453 SFG_PlatformContext pContext; /* The window's FBConfig (X11) or device context (Windows) */
455 int DoubleBuffered; /* Treat the window as double-buffered */
457 /* When drawing geometry to vertex attribute buffers, user specifies
458 * the attribute indices for vertices, normals and/or texture coords
459 * to freeglut. Those are stored here
461 GLint attribute_v_coord;
462 GLint attribute_v_normal;
463 GLint attribute_v_texture;
468 * Bitmasks indicating the different kinds of
469 * actions that can be scheduled for a window.
471 #define GLUT_INIT_WORK (1<<0)
472 #define GLUT_VISIBILITY_WORK (1<<1)
473 #define GLUT_POSITION_WORK (1<<2)
474 #define GLUT_SIZE_WORK (1<<3)
475 #define GLUT_ZORDER_WORK (1<<4)
476 #define GLUT_FULL_SCREEN_WORK (1<<5)
477 #define GLUT_DISPLAY_WORK (1<<6)
480 * An enumeration containing the desired mapping state of a window
487 } fgDesiredVisibility ;
490 * There is considerable confusion about the "right thing to
491 * do" concerning window size and position. GLUT itself is
492 * not consistent between Windows and UNIX/X11; since
493 * platform independence is a virtue for "freeglut", we
494 * decided to break with GLUT's behaviour.
496 * Under UNIX/X11, it is apparently not possible to get the
497 * window border sizes in order to subtract them off the
498 * window's initial position until some time after the window
499 * has been created. Therefore we decided on the following
500 * behaviour, both under Windows and under UNIX/X11:
501 * - When you create a window with position (x,y) and size
502 * (w,h), the upper left hand corner of the outside of the
503 * window is at (x,y) and the size of the drawable area is
505 * - When you query the size and position of the window--as
506 * is happening here for Windows--"freeglut" will return
507 * the size of the drawable area--the (w,h) that you
508 * specified when you created the window--and the coordinates
509 * of the upper left hand corner of the drawable area, i.e.
510 * of the client rect--which is NOT the (x,y) you specified.
512 typedef struct tagSFG_WindowState SFG_WindowState;
513 struct tagSFG_WindowState /* as per notes above, sizes always refer to the client area (thus without the window decorations) */
515 /* window state - size, position, look */
516 int Xpos; /* Window's top-left of client area, X-coordinate */
517 int Ypos; /* Window's top-left of client area, Y-coordinate */
518 int Width; /* Window's width in pixels */
519 int Height; /* The same about the height */
520 GLboolean Visible; /* Is the window visible now? Not using fgVisibilityState as we only care if visible or not */
521 int Cursor; /* The currently selected cursor style */
522 GLboolean IsFullscreen; /* is the window fullscreen? */
524 /* FreeGLUT operations are deferred, that is, window moving, resizing,
525 * Z-order changing, making full screen or not do not happen immediately
526 * upon the user's request, but only in the next iteration of the main
527 * loop, before the display callback is called. This allows multiple
528 * reshape, position, etc requests to be combined into one and is
529 * compatible with the way GLUT does things. Callbacks get triggered
530 * based on the feedback/messages/notifications from the window manager.
531 * Below here we define what work should be done, as well as the relevant
532 * parameters for this work.
534 unsigned int WorkMask; /* work (resize, etc) to be done on the window */
535 int DesiredXpos; /* desired X location */
536 int DesiredYpos; /* desired Y location */
537 int DesiredWidth; /* desired window width */
538 int DesiredHeight; /* desired window height */
539 int DesiredZOrder; /* desired window Z Order position */
540 fgDesiredVisibility DesiredVisibility;/* desired visibility (hidden, iconic, shown/normal) */
542 SFG_PlatformWindowState pWState; /* Window width/height (X11) or rectangle/style (Windows) from before a resize, and other stuff only needed on specific platforms */
544 long JoystickPollRate; /* The joystick polling rate */
545 fg_time_t JoystickLastPoll; /* When the last poll happened */
547 int MouseX, MouseY; /* The most recent mouse position */
549 GLboolean IgnoreKeyRepeat; /* Whether to ignore key repeat. */
551 GLboolean VisualizeNormals; /* When drawing objects, draw vectors representing the normals as well? */
556 * A generic function pointer. We should really use the GLUTproc type
557 * defined in freeglut_ext.h, but if we include that header in this file
558 * a bunch of other stuff (font-related) blows up!
560 typedef void (*SFG_Proc)();
564 * SET_WCB() is used as:
566 * SET_WCB( window, cbname, func, udata );
568 * ...where {window} is the freeglut window to set the callback,
569 * {cbname} is the window-specific callback to set,
570 * {func} is a function-pointer,
571 * {udata} is a void* pointer for user data.
573 * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
574 * but this can cause warnings because the FETCH_WCB() macro type-
575 * casts its result, and a type-cast value shouldn't be an lvalue.
577 * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
578 * and for no other reason. Since it's hidden in the macro, the
579 * ugliness is felt to be rather benign.
581 * If the function-pointer is the same, the data will be the only
582 * value updated. If the function-pointer changes, the data will
583 * be changed as well, preventing stail data from being passed in.
584 * Just updating the data does nothing unless a function-pointer
585 * exists, as the data is otherwise already allocated.
587 #define SET_WCB(window,cbname,func,udata) \
590 if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) ) \
592 (((window).CallBacks[WCB_ ## cbname]) = (SFG_Proc)(func)); \
593 (((window).CallbackDatas[WCB_ ## cbname]) = (udata)); \
595 else if( FETCH_USER_DATA_WCB( window, cbname ) != udata ) \
597 (((window).CallbackDatas[WCB_ ## cbname]) = (udata)); \
602 * FETCH_WCB() is used as:
604 * FETCH_WCB( window, cbname );
606 * ...where {window} is the freeglut window to fetch the callback from,
607 * {cbname} is the window-specific callback to fetch.
609 * The result is correctly type-cast to the callback function pointer
612 #define FETCH_WCB(window,cbname) \
613 ((window).CallBacks[WCB_ ## cbname])
616 * FETCH_USER_DATA_WCB() is used as:
618 * FETCH_USER_DATA_WCB( window, cbname );
620 * ...where {window} is the freeglut window,
621 * {cbname} is the window-specific callback to be invoked,
623 * This expects a variable named "window" of type tagSFG_Window to exist.
625 * The result is the callback data pointer.
627 #define FETCH_USER_DATA_WCB(window,cbname) \
628 ((window).CallbackDatas[WCB_ ## cbname])
631 * EXPAND_WCB() is used as:
633 * EXPAND_WCB( cbname )(( arg_list, userData ))
635 * ... where {(arg_list)} is the parameter list and userData is user
638 * This will take the arg_list and extend it by one argument, adding
639 * the argument "userData" to the end of the list.
641 * All of this is defined in fg_callback_macros.h
643 * See that header for more info.
645 * ------------------------------------------------------------------
649 * INVOKE_WCB() is used as:
651 * INVOKE_WCB( window, cbname, ( arg_list ) );
653 * ...where {window} is the freeglut window,
654 * {cbname} is the window-specific callback to be invoked,
655 * {(arg_list)} is the parameter list.
657 * The callback is invoked as:
659 * callback( arg_list, userData );
661 * ...where userData is added to the arg_list, but the parentheses
662 * are REQUIRED in the {arg_list}.
664 * NOTE that it does a sanity-check and also sets the
668 #define INVOKE_WCB(window,cbname,arg_list) \
671 if( FETCH_WCB( window, cbname ) ) \
673 FGCB ## cbname ## UC func = (FGCB ## cbname ## UC)(FETCH_WCB( window, cbname )); \
674 FGCBUserData userData = FETCH_USER_DATA_WCB( window, cbname ); \
675 fgSetWindow( &window ); \
676 func EXPAND_WCB( cbname )(( arg_list, userData )); \
681 * The window callbacks the user can supply us with. Should be kept portable.
683 * This enumeration provides the freeglut CallBack numbers.
684 * The symbolic constants are indices into a window's array of
685 * function callbacks. The names are formed by splicing a common
686 * prefix onto the callback's base name. (This was originally
687 * done so that an early stage of development could live side-by-
688 * side with the old callback code. The old callback code used
689 * the bare callback's name as a structure member, so I used a
690 * prefix for the array index name.)
711 /* Multi-Pointer X and touch related */
717 /* Mobile platforms LifeCycle */
721 /* Presently ignored */
724 WCB_SpaceMotion, /* presently implemented only on UNIX/X11 and Windows */
725 WCB_SpaceRotation, /* presently implemented only on UNIX/X11 and Windows */
726 WCB_SpaceButton, /* presently implemented only on UNIX/X11 and Windows */
732 /* Always make this the LAST one */
737 /* This structure holds the OpenGL rendering context for all the menu windows */
738 typedef struct tagSFG_MenuContext SFG_MenuContext;
739 struct tagSFG_MenuContext
741 SFG_WindowContextType MContext; /* The menu window's WGL context */
744 /* This structure describes a menu */
745 typedef struct tagSFG_Window SFG_Window;
746 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
747 typedef struct tagSFG_Menu SFG_Menu;
751 void *UserData; /* User data passed back at callback */
752 int ID; /* The global menu ID */
753 SFG_List Entries; /* The menu entries list */
754 FGCBMenuUC Callback; /* The menu callback */
755 FGCBUserData CallbackData; /* The menu callback user data */
756 FGCBDestroyUC Destroy; /* Destruction callback */
757 FGCBUserData DestroyData; /* Destruction callback user data */
758 GLboolean IsActive; /* Is the menu selected? */
759 void* Font; /* Font to be used for displaying this menu */
760 int Width; /* Menu box width in pixels */
761 int Height; /* Menu box height in pixels */
762 int X, Y; /* Menu box raster position */
764 SFG_MenuEntry *ActiveEntry; /* Currently active entry in the menu */
765 SFG_Window *Window; /* Window for menu */
766 SFG_Window *ParentWindow; /* Window in which the menu is invoked */
769 /* This is a menu entry */
770 struct tagSFG_MenuEntry
773 int ID; /* The menu entry ID (local) */
774 int Ordinal; /* The menu's ordinal number */
775 char* Text; /* The text to be displayed */
776 SFG_Menu* SubMenu; /* Optional sub-menu tree */
777 GLboolean IsActive; /* Is the entry highlighted? */
778 int Width; /* Label's width in pixels */
782 * A window, making part of freeglut windows hierarchy.
783 * Should be kept portable.
785 * NOTE that ActiveMenu is set to menu itself if the window is a menu.
790 int ID; /* Window's ID number */
792 SFG_Context Window; /* Window and OpenGL context */
793 SFG_WindowState State; /* The window state */
794 SFG_Proc CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
795 FGCBUserData CallbackDatas[ TOTAL_CALLBACKS ]; /* Array of window callback datas */
796 void *UserData ; /* For use by user */
798 SFG_Menu* Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window */
799 SFG_Menu* ActiveMenu; /* The window's active menu */
801 SFG_Window* Parent; /* The parent to this window */
802 SFG_List Children; /* The subwindows d.l. list */
804 GLboolean IsMenu; /* Set to 1 if we are a menu */
808 /* A linked list structure of windows */
809 typedef struct tagSFG_WindowList SFG_WindowList ;
810 struct tagSFG_WindowList
816 /* This holds information about all the windows, menus etc. */
817 typedef struct tagSFG_Structure SFG_Structure;
818 struct tagSFG_Structure
820 SFG_List Windows; /* The global windows list */
821 SFG_List Menus; /* The global menus list */
822 SFG_List WindowsToDestroy;
824 SFG_Window* CurrentWindow; /* The currently set window */
825 SFG_Menu* CurrentMenu; /* Same, but menu... */
827 SFG_MenuContext* MenuContext; /* OpenGL rendering context for menus */
829 SFG_Window* GameModeWindow; /* The game mode window */
831 int WindowID; /* The window ID for the next window to be created */
832 int MenuID; /* The menu ID for the next menu to be created */
836 * This structure is used for the enumeration purposes.
837 * You can easily extend its functionalities by declaring
838 * a structure containing enumerator's contents and custom
839 * data, then casting its pointer to (SFG_Enumerator *).
841 typedef struct tagSFG_Enumerator SFG_Enumerator;
842 struct tagSFG_Enumerator
844 GLboolean found; /* Used to terminate search */
845 void* data; /* Custom data pointer */
847 typedef void (* FGCBWindowEnumerator )( SFG_Window *, SFG_Enumerator * );
848 typedef void (* FGCBMenuEnumerator )( SFG_Menu *, SFG_Enumerator * );
850 /* The bitmap font structure */
851 typedef struct tagSFG_Font SFG_Font;
854 char* Name; /* The source font name */
855 int Quantity; /* Number of chars in font */
856 int Height; /* Height of the characters */
857 const GLubyte** Characters; /* The characters mapping */
859 float xorig, yorig; /* Relative origin of the character */
862 /* The stroke font structures */
864 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
865 struct tagSFG_StrokeVertex
870 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
871 struct tagSFG_StrokeStrip
874 const SFG_StrokeVertex* Vertices;
877 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
878 struct tagSFG_StrokeChar
882 const SFG_StrokeStrip* Strips;
885 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
886 struct tagSFG_StrokeFont
888 char* Name; /* The source font name */
889 int Quantity; /* Number of chars in font */
890 GLfloat Height; /* Height of the characters */
891 const SFG_StrokeChar** Characters; /* The characters mapping */
895 /* -- JOYSTICK-SPECIFIC STRUCTURES AND TYPES ------------------------------- */
897 * Initial defines from "js.h" starting around line 33 with the existing "fg_joystick.c"
901 #if TARGET_HOST_MACINTOSH
902 # include <InputSprocket.h>
905 #if TARGET_HOST_MAC_OSX
906 # include <mach/mach.h>
907 # include <IOKit/IOkitLib.h>
908 # include <IOKit/hid/IOHIDLib.h>
911 /* XXX It might be better to poll the operating system for the numbers of buttons and
912 * XXX axes and then dynamically allocate the arrays.
914 #define _JS_MAX_BUTTONS 32
916 #if TARGET_HOST_MACINTOSH
917 # define _JS_MAX_AXES 9
918 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
919 struct tagSFG_PlatformJoystick
921 #define ISP_NUM_AXIS 9
922 #define ISP_NUM_NEEDS 41
923 ISpElementReference isp_elem [ ISP_NUM_NEEDS ];
924 ISpNeed isp_needs [ ISP_NUM_NEEDS ];
928 #if TARGET_HOST_MAC_OSX
929 # define _JS_MAX_AXES 16
930 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
931 struct tagSFG_PlatformJoystick
933 IOHIDDeviceInterface ** hidDev;
934 IOHIDElementCookie buttonCookies[41];
935 IOHIDElementCookie axisCookies[_JS_MAX_AXES];
936 /* The next two variables are not used anywhere */
937 /* long minReport[_JS_MAX_AXES],
938 * maxReport[_JS_MAX_AXES];
945 * Definition of "SFG_Joystick" structure -- based on JS's "jsJoystick" object class.
946 * See "js.h" lines 80-178.
948 typedef struct tagSFG_Joystick SFG_Joystick;
949 struct tagSFG_Joystick
951 SFG_PlatformJoystick pJoystick;
959 float dead_band[ _JS_MAX_AXES ];
960 float saturate [ _JS_MAX_AXES ];
961 float center [ _JS_MAX_AXES ];
962 float max [ _JS_MAX_AXES ];
963 float min [ _JS_MAX_AXES ];
968 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
970 /* Freeglut display related stuff (initialized once per session) */
971 extern SFG_Display fgDisplay;
973 /* Freeglut internal structure */
974 extern SFG_Structure fgStructure;
976 /* The current freeglut settings */
977 extern SFG_State fgState;
980 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
983 * A call to this function makes us sure that the Display and Structure
984 * subsystems have been properly initialized and are ready to be used
986 #define FREEGLUT_EXIT_IF_NOT_INITIALISED( string ) \
987 if ( ! fgState.Initialised ) \
989 fgError ( " ERROR: Function <%s> called" \
990 " without first calling 'glutInit'.", (string) ) ; \
993 #define FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string ) \
994 if ( ! fgState.Initialised ) \
996 fgError ( " ERROR: Internal <%s> function called" \
997 " without first calling 'glutInit'.", (string) ) ; \
1000 #define FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function ) \
1003 fgError ( " ERROR: Internal error <%s> in function %s", \
1004 (string), (function) ) ; \
1008 * Following definitions are somewhat similar to GLib's,
1009 * but do not generate any log messages:
1011 #define freeglut_return_if_fail( expr ) \
1014 #define freeglut_return_val_if_fail( expr, val ) \
1019 * A call to those macros assures us that there is a current
1020 * window set, respectively:
1022 #define FREEGLUT_EXIT_IF_NO_WINDOW( string ) \
1023 if ( ! fgStructure.CurrentWindow && \
1024 ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) ) \
1026 fgError ( " ERROR: Function <%s> called" \
1027 " with no current window defined.", (string) ) ; \
1031 * The deinitialize function gets called on glutMainLoop() end. It should clean up
1032 * everything inside of the freeglut
1034 void fgDeinitialize( void );
1037 * Those two functions are used to create/destroy the freeglut internal
1038 * structures. This actually happens when calling glutInit() and when
1039 * quitting the glutMainLoop() (which actually happens, when all windows
1040 * have been closed).
1042 void fgCreateStructure( void );
1043 void fgDestroyStructure( void );
1046 * Window creation, opening, closing and destruction.
1047 * Also CallBack clearing/initialization.
1048 * Defined in fg_structure.c, fg_window.c.
1050 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
1051 GLboolean positionUse, int x, int y,
1052 GLboolean sizeUse, int w, int h,
1053 GLboolean gameMode, GLboolean isMenu );
1054 void fgSetWindow ( SFG_Window *window );
1055 void fgOpenWindow( SFG_Window* window, const char* title,
1056 GLboolean positionUse, int x, int y,
1057 GLboolean sizeUse, int w, int h,
1058 GLboolean gameMode, GLboolean isSubWindow );
1059 void fgCloseWindow( SFG_Window* window );
1060 void fgAddToWindowDestroyList ( SFG_Window* window );
1061 void fgCloseWindows ();
1062 void fgDestroyWindow( SFG_Window* window );
1064 /* Menu creation and destruction. Defined in fg_structure.c */
1065 SFG_Menu* fgCreateMenu( FGCBMenuUC menuCallback, FGCBUserData userData );
1066 void fgDestroyMenu( SFG_Menu* menu );
1068 /* Joystick device management functions, defined in fg_joystick.c */
1069 int fgJoystickDetect( void );
1070 void fgInitialiseJoysticks( void );
1071 void fgJoystickClose( void );
1072 void fgJoystickPollWindow( SFG_Window* window );
1074 /* InputDevice Initialisation and Closure */
1075 int fgInputDeviceDetect( void );
1076 void fgInitialiseInputDevices( void );
1077 void fgInputDeviceClose( void );
1079 /* spaceball device functions, defined in fg_spaceball.c */
1080 void fgInitialiseSpaceball( void );
1081 void fgSpaceballClose( void );
1082 void fgSpaceballSetWindow( SFG_Window *window );
1084 int fgHasSpaceball( void );
1085 int fgSpaceballNumButtons( void );
1087 /* Setting the cursor for a given window */
1088 void fgSetCursor ( SFG_Window *window, int cursorID );
1091 * Helper function to enumerate through all registered windows
1092 * and one to enumerate all of a window's subwindows...
1094 * The GFunc callback for those functions will be defined as:
1096 * void enumCallback( gpointer window, gpointer enumerator );
1098 * where window is the enumerated (sub)window pointer (SFG_Window *),
1099 * and userData is the a custom user-supplied pointer. Functions
1100 * are defined and exported from fg_structure.c file.
1102 void fgEnumWindows( FGCBWindowEnumerator enumCallback, SFG_Enumerator* enumerator );
1103 void fgEnumSubWindows( SFG_Window* window, FGCBWindowEnumerator enumCallback,
1104 SFG_Enumerator* enumerator );
1107 * fgWindowByHandle returns a (SFG_Window *) value pointing to the
1108 * first window in the queue matching the specified window handle.
1109 * The function is defined in fg_structure.c file.
1111 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
1114 * This function is similar to the previous one, except it is
1115 * looking for a specified (sub)window identifier. The function
1116 * is defined in fg_structure.c file.
1118 SFG_Window* fgWindowByID( int windowID );
1121 * Looks up a menu given its ID. This is easier than fgWindowByXXX
1122 * as all menus are placed in a single doubly linked list...
1124 SFG_Menu* fgMenuByID( int menuID );
1127 * Returns active menu, if any. Assumption: only one menu active throughout application at any one time.
1128 * This is easier than fgWindowByXXX as all menus are placed in one doubly linked list...
1130 SFG_Menu* fgGetActiveMenu( );
1133 * The menu activation and deactivation the code. This is the meat
1134 * of the menu user interface handling code...
1136 void fgUpdateMenuHighlight ( SFG_Menu *menu );
1137 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
1138 int mouse_x, int mouse_y );
1139 void fgDeactivateMenu( SFG_Window *window );
1142 * This function gets called just before the buffers swap, so that
1143 * freeglut can display the pull-down menus via OpenGL. The function
1144 * is defined in fg_menu.c file.
1146 void fgDisplayMenu( void );
1148 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
1149 fg_time_t fgElapsedTime( void );
1151 /* System time in milliseconds */
1152 fg_time_t fgSystemTime(void);
1154 /* List functions */
1155 void fgListInit(SFG_List *list);
1156 void fgListAppend(SFG_List *list, SFG_Node *node);
1157 void fgListRemove(SFG_List *list, SFG_Node *node);
1158 int fgListLength(SFG_List *list);
1159 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
1161 /* Error Message functions */
1162 void fgError( const char *fmt, ... );
1163 void fgWarning( const char *fmt, ... );
1165 SFG_Proc fgPlatformGetProcAddress( const char *procName );
1167 /* pushing attribute/value pairs into an array */
1168 #define ATTRIB(a) attributes[where++]=(a)
1169 #define ATTRIB_VAL(a,v) {ATTRIB(a); ATTRIB(v);}
1171 int fghMapBit( int mask, int from, int to );
1172 int fghIsLegacyContextRequested( void );
1173 void fghContextCreationError( void );
1174 int fghNumberOfAuxBuffersRequested( void );
1176 #endif /* FREEGLUT_INTERNAL_H */
1178 /*** END OF FILE ***/