4 * Various freeglut initialization functions.
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 #define FREEGLUT_BUILDING_LIB
29 #include <GL/freeglut.h>
30 #include "freeglut_internal.h"
32 #if TARGET_HOST_POSIX_X11
33 #include <limits.h> /* LONG_MAX */
37 * TODO BEFORE THE STABLE RELEASE:
39 * fgDeinitialize() -- Win32's OK, X11 needs the OS-specific
40 * deinitialization done
41 * glutInitDisplayString() -- display mode string parsing
43 * Wouldn't it be cool to use gettext() for error messages? I just love
44 * bash saying "nie znaleziono pliku" instead of "file not found" :)
45 * Is gettext easily portable?
48 /* -- GLOBAL VARIABLES ----------------------------------------------------- */
51 * A structure pointed by g_pDisplay holds all information
52 * regarding the display, screen, root window etc.
54 SFG_Display fgDisplay;
57 * The settings for the current freeglut session
59 SFG_State fgState = { { -1, -1, GL_FALSE }, /* Position */
60 { 300, 300, GL_TRUE }, /* Size */
61 GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH, /* DisplayMode */
62 GL_FALSE, /* Initialised */
63 GLUT_TRY_DIRECT_CONTEXT, /* DirectContext */
64 GL_FALSE, /* ForceIconic */
65 GL_FALSE, /* UseCurrentContext */
66 GL_FALSE, /* GLDebugSwitch */
67 GL_FALSE, /* XSyncSwitch */
68 GLUT_KEY_REPEAT_ON, /* KeyRepeat */
69 INVALID_MODIFIERS, /* Modifiers */
74 { NULL, NULL }, /* Timers */
75 { NULL, NULL }, /* FreeTimers */
76 NULL, /* IdleCallback */
78 NULL, /* MenuStateCallback */
79 NULL, /* MenuStatusCallback */
80 { 640, 480, GL_TRUE }, /* GameModeSize */
81 16, /* GameModeDepth */
82 72, /* GameModeRefresh */
83 GLUT_ACTION_EXIT, /* ActionOnWindowClose */
84 GLUT_EXEC_STATE_INIT, /* ExecState */
85 NULL, /* ProgramName */
86 GL_FALSE, /* JoysticksInitialised */
87 0, /* NumActiveJoysticks */
88 GL_FALSE, /* InputDevsInitialised */
89 0, /* MouseWheelTicks */
90 1, /* AuxiliaryBufferNumber */
95 0, /* ContextProfile */
97 NULL /* WarningFunc */
101 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
103 #if TARGET_HOST_POSIX_X11
105 /* Return the atom associated with "name". */
106 static Atom fghGetAtom(const char * name)
108 return XInternAtom(fgDisplay.Display, name, False);
112 * Check if "property" is set on "window". The property's values are returned
113 * through "data". If the property is set and is of type "type", return the
114 * number of elements in "data". Return zero otherwise. In both cases, use
115 * "Xfree()" to free "data".
117 static int fghGetWindowProperty(Window window,
120 unsigned char ** data)
123 * Caller always has to use "Xfree()" to free "data", since
124 * "XGetWindowProperty() always allocates one extra byte in prop_return
125 * [i.e. "data"] (even if the property is zero length) [..]".
128 int status; /* Returned by "XGetWindowProperty". */
131 int temp_format; /* Not used. */
132 unsigned long number_of_elements;
133 unsigned long temp_bytes_after; /* Not used. */
136 status = XGetWindowProperty(fgDisplay.Display,
149 FREEGLUT_INTERNAL_ERROR_EXIT(status == Success,
150 "XGetWindowProperty failled",
151 "fghGetWindowProperty");
153 if (type_returned != type)
155 number_of_elements = 0;
158 return number_of_elements;
161 /* Check if the window manager is NET WM compliant. */
162 static int fghNetWMSupported(void)
165 Window ** window_ptr_1;
167 int number_of_windows;
168 int net_wm_supported;
171 net_wm_supported = 0;
173 wm_check = fghGetAtom("_NET_SUPPORTING_WM_CHECK");
174 window_ptr_1 = malloc(sizeof(Window *));
177 * Check that the window manager has set this property on the root window.
178 * The property must be the ID of a child window.
180 number_of_windows = fghGetWindowProperty(fgDisplay.RootWindow,
183 (unsigned char **) window_ptr_1);
184 if (number_of_windows == 1)
186 Window ** window_ptr_2;
188 window_ptr_2 = malloc(sizeof(Window *));
190 /* Check that the window has the same property set to the same value. */
191 number_of_windows = fghGetWindowProperty(**window_ptr_1,
194 (unsigned char **) window_ptr_2);
195 if ((number_of_windows == 1) && (**window_ptr_1 == **window_ptr_2))
197 /* NET WM compliant */
198 net_wm_supported = 1;
201 XFree(*window_ptr_2);
205 XFree(*window_ptr_1);
208 return net_wm_supported;
211 /* Check if "hint" is present in "property" for "window". */
212 int fgHintPresent(Window window, Atom property, Atom hint)
221 atoms_ptr = malloc(sizeof(Atom *));
222 number_of_atoms = fghGetWindowProperty(window,
225 (unsigned char **) atoms_ptr);
226 for (i = 0; i < number_of_atoms; i++)
228 if ((*atoms_ptr)[i] == hint)
238 #endif /* TARGET_HOST_POSIX_X11 */
242 * A call to this function should initialize all the display stuff...
244 static void fghInitialize( const char* displayName )
246 #if TARGET_HOST_POSIX_X11
247 fgDisplay.Display = XOpenDisplay( displayName );
249 if( fgDisplay.Display == NULL )
250 fgError( "failed to open display '%s'", XDisplayName( displayName ) );
252 if( !glXQueryExtension( fgDisplay.Display, NULL, NULL ) )
253 fgError( "OpenGL GLX extension not supported by display '%s'",
254 XDisplayName( displayName ) );
256 fgDisplay.Screen = DefaultScreen( fgDisplay.Display );
257 fgDisplay.RootWindow = RootWindow(
262 fgDisplay.ScreenWidth = DisplayWidth(
266 fgDisplay.ScreenHeight = DisplayHeight(
271 fgDisplay.ScreenWidthMM = DisplayWidthMM(
275 fgDisplay.ScreenHeightMM = DisplayHeightMM(
280 fgDisplay.Connection = ConnectionNumber( fgDisplay.Display );
282 /* Create the window deletion atom */
283 fgDisplay.DeleteWindow = fghGetAtom("WM_DELETE_WINDOW");
285 /* Create the state and full screen atoms */
286 fgDisplay.State = None;
287 fgDisplay.StateFullScreen = None;
289 if (fghNetWMSupported())
291 const Atom supported = fghGetAtom("_NET_SUPPORTED");
292 const Atom state = fghGetAtom("_NET_WM_STATE");
294 /* Check if the state hint is supported. */
295 if (fgHintPresent(fgDisplay.RootWindow, supported, state))
297 const Atom full_screen = fghGetAtom("_NET_WM_STATE_FULLSCREEN");
299 fgDisplay.State = state;
301 /* Check if the window manager supports full screen. */
302 /** Check "_NET_WM_ALLOWED_ACTIONS" on our window instead? **/
303 if (fgHintPresent(fgDisplay.RootWindow, supported, full_screen))
305 fgDisplay.StateFullScreen = full_screen;
310 #elif TARGET_HOST_MS_WINDOWS
315 /* What we need to do is to initialize the fgDisplay global structure here. */
316 fgDisplay.Instance = GetModuleHandle( NULL );
317 fgDisplay.DisplayName= displayName ? strdup(displayName) : 0 ;
318 atom = GetClassInfo( fgDisplay.Instance, _T("FREEGLUT"), &wc );
322 ZeroMemory( &wc, sizeof(WNDCLASS) );
325 * Each of the windows should have its own device context, and we
326 * want redraw events during Vertical and Horizontal Resizes by
329 * XXX Old code had "| CS_DBCLCKS" commented out. Plans for the
330 * XXX future? Dead-end idea?
332 wc.lpfnWndProc = fgWindowProc;
335 wc.hInstance = fgDisplay.Instance;
336 wc.hIcon = LoadIcon( fgDisplay.Instance, _T("GLUT_ICON") );
338 #if defined(_WIN32_WCE)
339 wc.style = CS_HREDRAW | CS_VREDRAW;
341 wc.style = CS_OWNDC | CS_HREDRAW | CS_VREDRAW;
343 wc.hIcon = LoadIcon( NULL, IDI_WINLOGO );
346 wc.hCursor = LoadCursor( NULL, IDC_ARROW );
347 wc.hbrBackground = NULL;
348 wc.lpszMenuName = NULL;
349 wc.lpszClassName = _T("FREEGLUT");
351 /* Register the window class */
352 atom = RegisterClass( &wc );
353 FREEGLUT_INTERNAL_ERROR_EXIT ( atom, "Window Class Not Registered", "fghInitialize" );
356 /* The screen dimensions can be obtained via GetSystemMetrics() calls */
357 fgDisplay.ScreenWidth = GetSystemMetrics( SM_CXSCREEN );
358 fgDisplay.ScreenHeight = GetSystemMetrics( SM_CYSCREEN );
361 HWND desktop = GetDesktopWindow( );
362 HDC context = GetDC( desktop );
364 fgDisplay.ScreenWidthMM = GetDeviceCaps( context, HORZSIZE );
365 fgDisplay.ScreenHeightMM = GetDeviceCaps( context, VERTSIZE );
367 ReleaseDC( desktop, context );
369 /* If we have a DisplayName try to use it for metrics */
370 if( fgDisplay.DisplayName )
372 HDC context = CreateDC(fgDisplay.DisplayName,0,0,0);
375 fgDisplay.ScreenWidth = GetDeviceCaps( context, HORZRES );
376 fgDisplay.ScreenHeight = GetDeviceCaps( context, VERTRES );
377 fgDisplay.ScreenWidthMM = GetDeviceCaps( context, HORZSIZE );
378 fgDisplay.ScreenHeightMM = GetDeviceCaps( context, VERTSIZE );
382 fgWarning("fghInitialize: "
383 "CreateDC failed, Screen size info may be incorrect\n"
384 "This is quite likely caused by a bad '-display' parameter");
387 /* Set the timer granularity to 1 ms */
388 timeBeginPeriod ( 1 );
392 fgState.Initialised = GL_TRUE;
393 atexit(fgDeinitialize);
395 /* InputDevice uses GlutTimerFunc(), so fgState.Initialised must be TRUE */
396 fgInitialiseInputDevices();
400 * Perform the freeglut deinitialization...
402 void fgDeinitialize( void )
406 if( !fgState.Initialised )
411 /* If there was a menu created, destroy the rendering context */
412 if( fgStructure.MenuContext )
414 #if TARGET_HOST_POSIX_X11
415 /* Note that the MVisualInfo is not owned by the MenuContext! */
416 glXDestroyContext( fgDisplay.Display, fgStructure.MenuContext->MContext );
418 free( fgStructure.MenuContext );
419 fgStructure.MenuContext = NULL;
422 fgDestroyStructure( );
424 while( ( timer = fgState.Timers.First) )
426 fgListRemove( &fgState.Timers, &timer->Node );
430 while( ( timer = fgState.FreeTimers.First) )
432 fgListRemove( &fgState.FreeTimers, &timer->Node );
436 #if !defined(_WIN32_WCE)
437 if ( fgState.JoysticksInitialised )
440 if ( fgState.InputDevsInitialised )
441 fgInputDeviceClose( );
442 #endif /* !defined(_WIN32_WCE) */
443 fgState.JoysticksInitialised = GL_FALSE;
444 fgState.InputDevsInitialised = GL_FALSE;
446 fgState.MouseWheelTicks = 0;
448 fgState.MajorVersion = 1;
449 fgState.MinorVersion = 0;
450 fgState.ContextFlags = 0;
451 fgState.ContextProfile = 0;
453 fgState.Initialised = GL_FALSE;
455 fgState.Position.X = -1;
456 fgState.Position.Y = -1;
457 fgState.Position.Use = GL_FALSE;
459 fgState.Size.X = 300;
460 fgState.Size.Y = 300;
461 fgState.Size.Use = GL_TRUE;
463 fgState.DisplayMode = GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH;
465 fgState.DirectContext = GLUT_TRY_DIRECT_CONTEXT;
466 fgState.ForceIconic = GL_FALSE;
467 fgState.UseCurrentContext = GL_FALSE;
468 fgState.GLDebugSwitch = GL_FALSE;
469 fgState.XSyncSwitch = GL_FALSE;
470 fgState.ActionOnWindowClose = GLUT_ACTION_EXIT;
471 fgState.ExecState = GLUT_EXEC_STATE_INIT;
473 fgState.KeyRepeat = GLUT_KEY_REPEAT_ON;
474 fgState.Modifiers = INVALID_MODIFIERS;
476 fgState.GameModeSize.X = 640;
477 fgState.GameModeSize.Y = 480;
478 fgState.GameModeDepth = 16;
479 fgState.GameModeRefresh = 72;
481 fgListInit( &fgState.Timers );
482 fgListInit( &fgState.FreeTimers );
484 fgState.IdleCallback = NULL;
485 fgState.MenuStateCallback = ( FGCBMenuState )NULL;
486 fgState.MenuStatusCallback = ( FGCBMenuStatus )NULL;
488 fgState.SwapCount = 0;
489 fgState.SwapTime = 0;
490 fgState.FPSInterval = 0;
492 if( fgState.ProgramName )
494 free( fgState.ProgramName );
495 fgState.ProgramName = NULL;
498 #if TARGET_HOST_POSIX_X11
501 * Make sure all X-client data we have created will be destroyed on
504 XSetCloseDownMode( fgDisplay.Display, DestroyAll );
507 * Close the display connection, destroying all windows we have
510 XCloseDisplay( fgDisplay.Display );
512 #elif TARGET_HOST_MS_WINDOWS
513 if( fgDisplay.DisplayName )
515 free( fgDisplay.DisplayName );
516 fgDisplay.DisplayName = NULL;
519 /* Reset the timer granularity */
524 fgState.Initialised = GL_FALSE;
528 * Everything inside the following #ifndef is copied from the X sources.
531 #if TARGET_HOST_MS_WINDOWS
535 Copyright 1985, 1986, 1987,1998 The Open Group
537 Permission to use, copy, modify, distribute, and sell this software and its
538 documentation for any purpose is hereby granted without fee, provided that
539 the above copyright notice appear in all copies and that both that
540 copyright notice and this permission notice appear in supporting
543 The above copyright notice and this permission notice shall be included
544 in all copies or substantial portions of the Software.
546 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
547 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
548 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
549 IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
550 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
551 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
552 OTHER DEALINGS IN THE SOFTWARE.
554 Except as contained in this notice, the name of The Open Group shall
555 not be used in advertising or otherwise to promote the sale, use or
556 other dealings in this Software without prior written authorization
561 #define NoValue 0x0000
562 #define XValue 0x0001
563 #define YValue 0x0002
564 #define WidthValue 0x0004
565 #define HeightValue 0x0008
566 #define AllValues 0x000F
567 #define XNegative 0x0010
568 #define YNegative 0x0020
571 * XParseGeometry parses strings of the form
572 * "=<width>x<height>{+-}<xoffset>{+-}<yoffset>", where
573 * width, height, xoffset, and yoffset are unsigned integers.
574 * Example: "=80x24+300-49"
575 * The equal sign is optional.
576 * It returns a bitmask that indicates which of the four values
577 * were actually found in the string. For each value found,
578 * the corresponding argument is updated; for each value
579 * not found, the corresponding argument is left unchanged.
583 ReadInteger(char *string, char **NextString)
585 register int Result = 0;
590 else if (*string == '-')
595 for (; (*string >= '0') && (*string <= '9'); string++)
597 Result = (Result * 10) + (*string - '0');
599 *NextString = string;
606 static int XParseGeometry (
610 unsigned int *width, /* RETURN */
611 unsigned int *height) /* RETURN */
614 register char *strind;
615 unsigned int tempWidth = 0, tempHeight = 0;
616 int tempX = 0, tempY = 0;
619 if ( (string == NULL) || (*string == '\0'))
622 string++; /* ignore possible '=' at beg of geometry spec */
624 strind = (char *)string;
625 if (*strind != '+' && *strind != '-' && *strind != 'x') {
626 tempWidth = ReadInteger(strind, &nextCharacter);
627 if (strind == nextCharacter)
629 strind = nextCharacter;
633 if (*strind == 'x' || *strind == 'X') {
635 tempHeight = ReadInteger(strind, &nextCharacter);
636 if (strind == nextCharacter)
638 strind = nextCharacter;
642 if ((*strind == '+') || (*strind == '-')) {
643 if (*strind == '-') {
645 tempX = -ReadInteger(strind, &nextCharacter);
646 if (strind == nextCharacter)
648 strind = nextCharacter;
654 tempX = ReadInteger(strind, &nextCharacter);
655 if (strind == nextCharacter)
657 strind = nextCharacter;
660 if ((*strind == '+') || (*strind == '-')) {
661 if (*strind == '-') {
663 tempY = -ReadInteger(strind, &nextCharacter);
664 if (strind == nextCharacter)
666 strind = nextCharacter;
672 tempY = ReadInteger(strind, &nextCharacter);
673 if (strind == nextCharacter)
675 strind = nextCharacter;
681 /* If strind isn't at the end of the string the it's an invalid
682 geometry specification. */
684 if (*strind != '\0') return 0;
690 if (mask & WidthValue)
692 if (mask & HeightValue)
693 *height = tempHeight;
698 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
701 * Perform initialization. This usually happens on the program startup
702 * and restarting after glutMainLoop termination...
704 void FGAPIENTRY glutInit( int* pargc, char** argv )
706 char* displayName = NULL;
707 char* geometry = NULL;
708 int i, j, argc = *pargc;
710 if( fgState.Initialised )
711 fgError( "illegal glutInit() reinitialization attempt" );
713 if (pargc && *pargc && argv && *argv && **argv)
715 fgState.ProgramName = strdup (*argv);
717 if( !fgState.ProgramName )
718 fgError ("Could not allocate space for the program's name.");
721 fgCreateStructure( );
724 fgState.Time = fgSystemTime();
726 /* check if GLUT_FPS env var is set */
729 const char *fps = getenv( "GLUT_FPS" );
734 sscanf( fps, "%d", &interval );
737 fgState.FPSInterval = 5000; /* 5000 millisecond default */
739 fgState.FPSInterval = interval;
743 displayName = getenv( "DISPLAY" );
745 for( i = 1; i < argc; i++ )
747 if( strcmp( argv[ i ], "-display" ) == 0 )
750 fgError( "-display parameter must be followed by display name" );
752 displayName = argv[ i ];
754 argv[ i - 1 ] = NULL;
758 else if( strcmp( argv[ i ], "-geometry" ) == 0 )
761 fgError( "-geometry parameter must be followed by window "
762 "geometry settings" );
764 geometry = argv[ i ];
766 argv[ i - 1 ] = NULL;
770 else if( strcmp( argv[ i ], "-direct" ) == 0)
772 if( fgState.DirectContext == GLUT_FORCE_INDIRECT_CONTEXT )
773 fgError( "parameters ambiguity, -direct and -indirect "
774 "cannot be both specified" );
776 fgState.DirectContext = GLUT_FORCE_DIRECT_CONTEXT;
780 else if( strcmp( argv[ i ], "-indirect" ) == 0 )
782 if( fgState.DirectContext == GLUT_FORCE_DIRECT_CONTEXT )
783 fgError( "parameters ambiguity, -direct and -indirect "
784 "cannot be both specified" );
786 fgState.DirectContext = GLUT_FORCE_INDIRECT_CONTEXT;
790 else if( strcmp( argv[ i ], "-iconic" ) == 0 )
792 fgState.ForceIconic = GL_TRUE;
796 else if( strcmp( argv[ i ], "-gldebug" ) == 0 )
798 fgState.GLDebugSwitch = GL_TRUE;
802 else if( strcmp( argv[ i ], "-sync" ) == 0 )
804 fgState.XSyncSwitch = GL_TRUE;
810 /* Compact {argv}. */
811 for( i = j = 1; i < *pargc; i++, j++ )
813 /* Guaranteed to end because there are "*pargc" arguments left */
814 while ( argv[ j ] == NULL )
817 argv[ i ] = argv[ j ];
820 #endif /* _WIN32_WCE */
823 * Have the display created now. If there wasn't a "-display"
824 * in the program arguments, we will use the DISPLAY environment
825 * variable for opening the X display (see code above):
827 fghInitialize( displayName );
830 * Geometry parsing deffered until here because we may need the screen
836 unsigned int parsedWidth, parsedHeight;
837 int mask = XParseGeometry( geometry,
838 &fgState.Position.X, &fgState.Position.Y,
839 &parsedWidth, &parsedHeight );
840 /* TODO: Check for overflow? */
841 fgState.Size.X = parsedWidth;
842 fgState.Size.Y = parsedHeight;
844 if( (mask & (WidthValue|HeightValue)) == (WidthValue|HeightValue) )
845 fgState.Size.Use = GL_TRUE;
847 if( mask & XNegative )
848 fgState.Position.X += fgDisplay.ScreenWidth - fgState.Size.X;
850 if( mask & YNegative )
851 fgState.Position.Y += fgDisplay.ScreenHeight - fgState.Size.Y;
853 if( (mask & (XValue|YValue)) == (XValue|YValue) )
854 fgState.Position.Use = GL_TRUE;
858 #if TARGET_HOST_MS_WINDOWS
859 void (__cdecl *__glutExitFunc)( int return_value ) = NULL;
861 void FGAPIENTRY __glutInitWithExit( int *pargc, char **argv, void (__cdecl *exit_function)(int) )
863 __glutExitFunc = exit_function;
864 glutInit(pargc, argv);
869 * Undoes all the "glutInit" stuff
871 void FGAPIENTRY glutExit ( void )
877 * Sets the default initial window position for new windows
879 void FGAPIENTRY glutInitWindowPosition( int x, int y )
881 fgState.Position.X = x;
882 fgState.Position.Y = y;
884 if( ( x >= 0 ) && ( y >= 0 ) )
885 fgState.Position.Use = GL_TRUE;
887 fgState.Position.Use = GL_FALSE;
891 * Sets the default initial window size for new windows
893 void FGAPIENTRY glutInitWindowSize( int width, int height )
895 fgState.Size.X = width;
896 fgState.Size.Y = height;
898 if( ( width > 0 ) && ( height > 0 ) )
899 fgState.Size.Use = GL_TRUE;
901 fgState.Size.Use = GL_FALSE;
905 * Sets the default display mode for all new windows
907 void FGAPIENTRY glutInitDisplayMode( unsigned int displayMode )
909 /* We will make use of this value when creating a new OpenGL context... */
910 fgState.DisplayMode = displayMode;
914 /* -- INIT DISPLAY STRING PARSING ------------------------------------------ */
916 static char* Tokens[] =
918 "alpha", "acca", "acc", "blue", "buffer", "conformant", "depth", "double",
919 "green", "index", "num", "red", "rgba", "rgb", "luminance", "stencil",
920 "single", "stereo", "samples", "slow", "win32pdf", "win32pfd", "xvisual",
921 "xstaticgray", "xgrayscale", "xstaticcolor", "xpseudocolor",
922 "xtruecolor", "xdirectcolor",
923 "xstaticgrey", "xgreyscale", "xstaticcolour", "xpseudocolour",
924 "xtruecolour", "xdirectcolour", "borderless", "aux"
926 #define NUM_TOKENS (sizeof(Tokens) / sizeof(*Tokens))
928 void FGAPIENTRY glutInitDisplayString( const char* displayMode )
930 int glut_state_flag = 0 ;
932 * Unpack a lot of options from a character string. The options are
933 * delimited by blanks or tabs.
936 size_t len = strlen ( displayMode );
937 char *buffer = (char *)malloc ( (len+1) * sizeof(char) );
938 memcpy ( buffer, displayMode, len );
941 token = strtok ( buffer, " \t" );
945 /* Process this token */
948 /* Temporary fix: Ignore any length specifications and at least
949 * process the basic token
950 * TODO: Fix this permanently
952 size_t cleanlength = strcspn ( token, "=<>~!" );
954 for ( i = 0; i < NUM_TOKENS; i++ )
956 if ( strncmp ( token, Tokens[i], cleanlength ) == 0 ) break ;
961 case 0 : /* "alpha": Alpha color buffer precision in bits */
962 glut_state_flag |= GLUT_ALPHA ; /* Somebody fix this for me! */
965 case 1 : /* "acca": Red, green, blue, and alpha accumulation buffer
969 case 2 : /* "acc": Red, green, and blue accumulation buffer precision
970 in bits with zero bits alpha */
971 glut_state_flag |= GLUT_ACCUM ; /* Somebody fix this for me! */
974 case 3 : /* "blue": Blue color buffer precision in bits */
977 case 4 : /* "buffer": Number of bits in the color index color buffer
981 case 5 : /* "conformant": Boolean indicating if the frame buffer
982 configuration is conformant or not */
985 case 6 : /* "depth": Number of bits of precsion in the depth buffer */
986 glut_state_flag |= GLUT_DEPTH ; /* Somebody fix this for me! */
989 case 7 : /* "double": Boolean indicating if the color buffer is
991 glut_state_flag |= GLUT_DOUBLE ;
994 case 8 : /* "green": Green color buffer precision in bits */
997 case 9 : /* "index": Boolean if the color model is color index or not
999 glut_state_flag |= GLUT_INDEX ;
1002 case 10 : /* "num": A special capability name indicating where the
1003 value represents the Nth frame buffer configuration
1004 matching the description string */
1007 case 11 : /* "red": Red color buffer precision in bits */
1010 case 12 : /* "rgba": Number of bits of red, green, blue, and alpha in
1011 the RGBA color buffer */
1012 glut_state_flag |= GLUT_RGBA ; /* Somebody fix this for me! */
1015 case 13 : /* "rgb": Number of bits of red, green, and blue in the
1016 RGBA color buffer with zero bits alpha */
1017 glut_state_flag |= GLUT_RGB ; /* Somebody fix this for me! */
1020 case 14 : /* "luminance": Number of bits of red in the RGBA and zero
1021 bits of green, blue (alpha not specified) of color buffer
1023 glut_state_flag |= GLUT_LUMINANCE ; /* Somebody fix this for me! */
1026 case 15 : /* "stencil": Number of bits in the stencil buffer */
1027 glut_state_flag |= GLUT_STENCIL; /* Somebody fix this for me! */
1030 case 16 : /* "single": Boolean indicate the color buffer is single
1032 glut_state_flag |= GLUT_SINGLE ;
1035 case 17 : /* "stereo": Boolean indicating the color buffer supports
1036 OpenGL-style stereo */
1037 glut_state_flag |= GLUT_STEREO ;
1040 case 18 : /* "samples": Indicates the number of multisamples to use
1041 based on GLX's SGIS_multisample extension (for
1043 glut_state_flag |= GLUT_MULTISAMPLE ; /*Somebody fix this for me!*/
1046 case 19 : /* "slow": Boolean indicating if the frame buffer
1047 configuration is slow or not */
1050 case 20 : /* "win32pdf": (incorrect spelling but was there before */
1051 case 21 : /* "win32pfd": matches the Win32 Pixel Format Descriptor by
1053 #if TARGET_HOST_MS_WINDOWS
1057 case 22 : /* "xvisual": matches the X visual ID by number */
1058 #if TARGET_HOST_POSIX_X11
1062 case 23 : /* "xstaticgray": */
1063 case 29 : /* "xstaticgrey": boolean indicating if the frame buffer
1064 configuration's X visual is of type StaticGray */
1065 #if TARGET_HOST_POSIX_X11
1069 case 24 : /* "xgrayscale": */
1070 case 30 : /* "xgreyscale": boolean indicating if the frame buffer
1071 configuration's X visual is of type GrayScale */
1072 #if TARGET_HOST_POSIX_X11
1076 case 25 : /* "xstaticcolor": */
1077 case 31 : /* "xstaticcolour": boolean indicating if the frame buffer
1078 configuration's X visual is of type StaticColor */
1079 #if TARGET_HOST_POSIX_X11
1083 case 26 : /* "xpseudocolor": */
1084 case 32 : /* "xpseudocolour": boolean indicating if the frame buffer
1085 configuration's X visual is of type PseudoColor */
1086 #if TARGET_HOST_POSIX_X11
1090 case 27 : /* "xtruecolor": */
1091 case 33 : /* "xtruecolour": boolean indicating if the frame buffer
1092 configuration's X visual is of type TrueColor */
1093 #if TARGET_HOST_POSIX_X11
1097 case 28 : /* "xdirectcolor": */
1098 case 34 : /* "xdirectcolour": boolean indicating if the frame buffer
1099 configuration's X visual is of type DirectColor */
1100 #if TARGET_HOST_POSIX_X11
1104 case 35 : /* "borderless": windows should not have borders */
1105 #if TARGET_HOST_POSIX_X11
1109 case 36 : /* "aux": some number of aux buffers */
1110 glut_state_flag |= GLUT_AUX;
1113 case 37 : /* Unrecognized */
1114 fgWarning ( "WARNING - Display string token not recognized: %s",
1119 token = strtok ( NULL, " \t" );
1124 /* We will make use of this value when creating a new OpenGL context... */
1125 fgState.DisplayMode = glut_state_flag;
1128 /* -- SETTING OPENGL 3.0 CONTEXT CREATION PARAMETERS ---------------------- */
1130 void FGAPIENTRY glutInitContextVersion( int majorVersion, int minorVersion )
1132 /* We will make use of these valuse when creating a new OpenGL context... */
1133 fgState.MajorVersion = majorVersion;
1134 fgState.MinorVersion = minorVersion;
1138 void FGAPIENTRY glutInitContextFlags( int flags )
1140 /* We will make use of this value when creating a new OpenGL context... */
1141 fgState.ContextFlags = flags;
1144 void FGAPIENTRY glutInitContextProfile( int profile )
1146 /* We will make use of this value when creating a new OpenGL context... */
1147 fgState.ContextProfile = profile;
1150 /* -------------- User Defined Error/Warning Handler Support -------------- */
1153 * Sets the user error handler (note the use of va_list for the args to the fmt)
1155 void FGAPIENTRY glutInitErrorFunc( void (* vfgError) ( const char *fmt, va_list ap ) )
1157 /* This allows user programs to handle freeglut errors */
1158 fgState.ErrorFunc = vfgError;
1162 * Sets the user warning handler (note the use of va_list for the args to the fmt)
1164 void FGAPIENTRY glutInitWarningFunc( void (* vfgWarning) ( const char *fmt, va_list ap ) )
1166 /* This allows user programs to handle freeglut warnings */
1167 fgState.WarningFunc = vfgWarning;
1170 /*** END OF FILE ***/