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 "fg_internal.h"
33 * TODO BEFORE THE STABLE RELEASE:
35 * fgDeinitialize() -- Win32's OK, X11 needs the OS-specific
36 * deinitialization done
37 * glutInitDisplayString() -- display mode string parsing
39 * Wouldn't it be cool to use gettext() for error messages? I just love
40 * bash saying "nie znaleziono pliku" instead of "file not found" :)
41 * Is gettext easily portable?
44 /* -- GLOBAL VARIABLES ----------------------------------------------------- */
47 * A structure pointed by fgDisplay holds all information
48 * regarding the display, screen, root window etc.
50 SFG_Display fgDisplay;
53 * The settings for the current freeglut session
55 SFG_State fgState = { { -1, -1, GL_FALSE }, /* Position */
56 { 300, 300, GL_TRUE }, /* Size */
57 GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH, /* DisplayMode */
58 GL_FALSE, /* Initialised */
59 GLUT_TRY_DIRECT_CONTEXT, /* DirectContext */
60 GL_FALSE, /* ForceIconic */
61 GL_FALSE, /* UseCurrentContext */
62 GL_FALSE, /* GLDebugSwitch */
63 GL_FALSE, /* XSyncSwitch */
64 GLUT_KEY_REPEAT_ON, /* KeyRepeat */
65 INVALID_MODIFIERS, /* Modifiers */
70 { NULL, NULL }, /* Timers */
71 { NULL, NULL }, /* FreeTimers */
72 NULL, /* IdleCallback */
74 NULL, /* MenuStateCallback */
75 NULL, /* MenuStatusCallback */
76 { -1, -1, GL_TRUE }, /* GameModeSize */
77 -1, /* GameModeDepth */
78 -1, /* GameModeRefresh */
79 GLUT_ACTION_EXIT, /* ActionOnWindowClose */
80 GLUT_EXEC_STATE_INIT, /* ExecState */
81 NULL, /* ProgramName */
82 GL_FALSE, /* JoysticksInitialised */
83 0, /* NumActiveJoysticks */
84 GL_FALSE, /* InputDevsInitialised */
85 0, /* MouseWheelTicks */
86 1, /* AuxiliaryBufferNumber */
88 1, /* OpenGL context MajorVersion */
89 0, /* OpenGL context MinorVersion */
90 0, /* OpenGL ContextFlags */
91 0, /* OpenGL ContextProfile */
93 NULL /* WarningFunc */
97 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
99 extern void fgPlatformInitialize( const char* displayName );
100 extern void fgPlatformDeinitialiseInputDevices ( void );
101 extern void fgPlatformCloseDisplay ( void );
102 extern void fgPlatformDestroyContext ( SFG_PlatformDisplay pDisplay, SFG_WindowContextType MContext );
105 void fghParseCommandLineArguments ( int* pargc, char** argv, char **pDisplayName, char **pGeometry )
108 int i, j, argc = *pargc;
111 /* check if GLUT_FPS env var is set */
112 const char *fps = getenv( "GLUT_FPS" );
117 sscanf( fps, "%d", &interval );
120 fgState.FPSInterval = 5000; /* 5000 millisecond default */
122 fgState.FPSInterval = interval;
126 *pDisplayName = getenv( "DISPLAY" );
128 for( i = 1; i < argc; i++ )
130 if( strcmp( argv[ i ], "-display" ) == 0 )
133 fgError( "-display parameter must be followed by display name" );
135 *pDisplayName = argv[ i ];
137 argv[ i - 1 ] = NULL;
141 else if( strcmp( argv[ i ], "-geometry" ) == 0 )
144 fgError( "-geometry parameter must be followed by window "
145 "geometry settings" );
147 *pGeometry = argv[ i ];
149 argv[ i - 1 ] = NULL;
153 else if( strcmp( argv[ i ], "-direct" ) == 0)
155 if( fgState.DirectContext == GLUT_FORCE_INDIRECT_CONTEXT )
156 fgError( "parameters ambiguity, -direct and -indirect "
157 "cannot be both specified" );
159 fgState.DirectContext = GLUT_FORCE_DIRECT_CONTEXT;
163 else if( strcmp( argv[ i ], "-indirect" ) == 0 )
165 if( fgState.DirectContext == GLUT_FORCE_DIRECT_CONTEXT )
166 fgError( "parameters ambiguity, -direct and -indirect "
167 "cannot be both specified" );
169 fgState.DirectContext = GLUT_FORCE_INDIRECT_CONTEXT;
173 else if( strcmp( argv[ i ], "-iconic" ) == 0 )
175 fgState.ForceIconic = GL_TRUE;
179 else if( strcmp( argv[ i ], "-gldebug" ) == 0 )
181 fgState.GLDebugSwitch = GL_TRUE;
185 else if( strcmp( argv[ i ], "-sync" ) == 0 )
187 fgState.XSyncSwitch = GL_TRUE;
193 /* Compact {argv}. */
194 for( i = j = 1; i < *pargc; i++, j++ )
196 /* Guaranteed to end because there are "*pargc" arguments left */
197 while ( argv[ j ] == NULL )
200 argv[ i ] = argv[ j ];
203 #endif /* _WIN32_WCE */
208 void fghCloseInputDevices ( void )
210 if ( fgState.JoysticksInitialised )
213 if ( fgState.InputDevsInitialised )
214 fgInputDeviceClose( );
219 * Perform the freeglut deinitialization...
221 void fgDeinitialize( void )
225 if( !fgState.Initialised )
230 /* If we're in game mode, we want to leave game mode */
231 if( fgStructure.GameModeWindow ) {
235 /* If there was a menu created, destroy the rendering context */
236 if( fgStructure.MenuContext )
238 fgPlatformDestroyContext (fgDisplay.pDisplay, fgStructure.MenuContext->MContext );
239 free( fgStructure.MenuContext );
240 fgStructure.MenuContext = NULL;
243 fgDestroyStructure( );
245 while( ( timer = fgState.Timers.First) )
247 fgListRemove( &fgState.Timers, &timer->Node );
251 while( ( timer = fgState.FreeTimers.First) )
253 fgListRemove( &fgState.FreeTimers, &timer->Node );
257 fgPlatformDeinitialiseInputDevices ();
259 fgState.MouseWheelTicks = 0;
261 fgState.MajorVersion = 1;
262 fgState.MinorVersion = 0;
263 fgState.ContextFlags = 0;
264 fgState.ContextProfile = 0;
266 fgState.Initialised = GL_FALSE;
268 fgState.Position.X = -1;
269 fgState.Position.Y = -1;
270 fgState.Position.Use = GL_FALSE;
272 fgState.Size.X = 300;
273 fgState.Size.Y = 300;
274 fgState.Size.Use = GL_TRUE;
276 fgState.DisplayMode = GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH;
278 fgState.DirectContext = GLUT_TRY_DIRECT_CONTEXT;
279 fgState.ForceIconic = GL_FALSE;
280 fgState.UseCurrentContext = GL_FALSE;
281 fgState.GLDebugSwitch = GL_FALSE;
282 fgState.XSyncSwitch = GL_FALSE;
283 fgState.ActionOnWindowClose = GLUT_ACTION_EXIT;
284 fgState.ExecState = GLUT_EXEC_STATE_INIT;
286 fgState.KeyRepeat = GLUT_KEY_REPEAT_ON;
287 fgState.Modifiers = INVALID_MODIFIERS;
289 fgState.GameModeSize.X = -1;
290 fgState.GameModeSize.Y = -1;
291 fgState.GameModeDepth = -1;
292 fgState.GameModeRefresh = -1;
294 fgListInit( &fgState.Timers );
295 fgListInit( &fgState.FreeTimers );
297 fgState.IdleCallback = NULL;
298 fgState.MenuStateCallback = ( FGCBMenuState )NULL;
299 fgState.MenuStatusCallback = ( FGCBMenuStatus )NULL;
301 fgState.SwapCount = 0;
302 fgState.SwapTime = 0;
303 fgState.FPSInterval = 0;
305 if( fgState.ProgramName )
307 free( fgState.ProgramName );
308 fgState.ProgramName = NULL;
311 fgPlatformCloseDisplay ();
313 fgState.Initialised = GL_FALSE;
317 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
318 #if defined(NEED_XPARSEGEOMETRY_IMPL)
319 # include "util/xparsegeometry_repl.h"
323 * Perform initialization. This usually happens on the program startup
324 * and restarting after glutMainLoop termination...
326 void FGAPIENTRY glutInit( int* pargc, char** argv )
328 char* displayName = NULL;
329 char* geometry = NULL;
330 if( fgState.Initialised )
331 fgError( "illegal glutInit() reinitialization attempt" );
333 if (pargc && *pargc && argv && *argv && **argv)
335 fgState.ProgramName = strdup (*argv);
337 if( !fgState.ProgramName )
338 fgError ("Could not allocate space for the program's name.");
341 fgCreateStructure( );
344 fgState.Time = fgSystemTime();
346 fghParseCommandLineArguments ( pargc, argv, &displayName, &geometry );
349 * Have the display created now. If there wasn't a "-display"
350 * in the program arguments, we will use the DISPLAY environment
351 * variable for opening the X display (see code above):
353 fgPlatformInitialize( displayName );
356 * Geometry parsing deferred until here because we may need the screen
362 unsigned int parsedWidth, parsedHeight;
363 int mask = XParseGeometry( geometry,
364 &fgState.Position.X, &fgState.Position.Y,
365 &parsedWidth, &parsedHeight );
366 /* TODO: Check for overflow? */
367 fgState.Size.X = parsedWidth;
368 fgState.Size.Y = parsedHeight;
370 if( (mask & (WidthValue|HeightValue)) == (WidthValue|HeightValue) )
371 fgState.Size.Use = GL_TRUE;
373 if( mask & XNegative )
374 fgState.Position.X += fgDisplay.ScreenWidth - fgState.Size.X;
376 if( mask & YNegative )
377 fgState.Position.Y += fgDisplay.ScreenHeight - fgState.Size.Y;
379 if( (mask & (XValue|YValue)) == (XValue|YValue) )
380 fgState.Position.Use = GL_TRUE;
385 * Undoes all the "glutInit" stuff
387 void FGAPIENTRY glutExit ( void )
393 * Sets the default initial window position for new windows
395 void FGAPIENTRY glutInitWindowPosition( int x, int y )
397 fgState.Position.X = x;
398 fgState.Position.Y = y;
400 if( ( x >= 0 ) && ( y >= 0 ) )
401 fgState.Position.Use = GL_TRUE;
403 fgState.Position.Use = GL_FALSE;
407 * Sets the default initial window size for new windows
409 void FGAPIENTRY glutInitWindowSize( int width, int height )
411 fgState.Size.X = width;
412 fgState.Size.Y = height;
414 if( ( width > 0 ) && ( height > 0 ) )
415 fgState.Size.Use = GL_TRUE;
417 fgState.Size.Use = GL_FALSE;
421 * Sets the default display mode for all new windows
423 void FGAPIENTRY glutInitDisplayMode( unsigned int displayMode )
425 /* We will make use of this value when creating a new OpenGL context... */
426 fgState.DisplayMode = displayMode;
430 /* -- INIT DISPLAY STRING PARSING ------------------------------------------ */
432 static char* Tokens[] =
434 "alpha", "acca", "acc", "blue", "buffer", "conformant", "depth", "double",
435 "green", "index", "num", "red", "rgba", "rgb", "luminance", "stencil",
436 "single", "stereo", "samples", "slow", "win32pdf", "win32pfd", "xvisual",
437 "xstaticgray", "xgrayscale", "xstaticcolor", "xpseudocolor",
438 "xtruecolor", "xdirectcolor",
439 "xstaticgrey", "xgreyscale", "xstaticcolour", "xpseudocolour",
440 "xtruecolour", "xdirectcolour", "borderless", "aux"
442 #define NUM_TOKENS (sizeof(Tokens) / sizeof(*Tokens))
444 void FGAPIENTRY glutInitDisplayString( const char* displayMode )
446 int glut_state_flag = 0 ;
448 * Unpack a lot of options from a character string. The options are
449 * delimited by blanks or tabs.
452 size_t len = strlen ( displayMode );
453 char *buffer = (char *)malloc ( (len+1) * sizeof(char) );
454 memcpy ( buffer, displayMode, len );
457 token = strtok ( buffer, " \t" );
461 /* Process this token */
464 /* Temporary fix: Ignore any length specifications and at least
465 * process the basic token
466 * TODO: Fix this permanently
468 size_t cleanlength = strcspn ( token, "=<>~!" );
470 for ( i = 0; i < NUM_TOKENS; i++ )
472 if ( strncmp ( token, Tokens[i], cleanlength ) == 0 ) break ;
477 case 0 : /* "alpha": Alpha color buffer precision in bits */
478 glut_state_flag |= GLUT_ALPHA ; /* Somebody fix this for me! */
481 case 1 : /* "acca": Red, green, blue, and alpha accumulation buffer
485 case 2 : /* "acc": Red, green, and blue accumulation buffer precision
486 in bits with zero bits alpha */
487 glut_state_flag |= GLUT_ACCUM ; /* Somebody fix this for me! */
490 case 3 : /* "blue": Blue color buffer precision in bits */
493 case 4 : /* "buffer": Number of bits in the color index color buffer
497 case 5 : /* "conformant": Boolean indicating if the frame buffer
498 configuration is conformant or not */
501 case 6 : /* "depth": Number of bits of precision in the depth buffer */
502 glut_state_flag |= GLUT_DEPTH ; /* Somebody fix this for me! */
505 case 7 : /* "double": Boolean indicating if the color buffer is
507 glut_state_flag |= GLUT_DOUBLE ;
510 case 8 : /* "green": Green color buffer precision in bits */
513 case 9 : /* "index": Boolean if the color model is color index or not
515 glut_state_flag |= GLUT_INDEX ;
518 case 10 : /* "num": A special capability name indicating where the
519 value represents the Nth frame buffer configuration
520 matching the description string */
523 case 11 : /* "red": Red color buffer precision in bits */
526 case 12 : /* "rgba": Number of bits of red, green, blue, and alpha in
527 the RGBA color buffer */
528 glut_state_flag |= GLUT_RGBA ; /* Somebody fix this for me! */
531 case 13 : /* "rgb": Number of bits of red, green, and blue in the
532 RGBA color buffer with zero bits alpha */
533 glut_state_flag |= GLUT_RGB ; /* Somebody fix this for me! */
536 case 14 : /* "luminance": Number of bits of red in the RGBA and zero
537 bits of green, blue (alpha not specified) of color buffer
539 glut_state_flag |= GLUT_LUMINANCE ; /* Somebody fix this for me! */
542 case 15 : /* "stencil": Number of bits in the stencil buffer */
543 glut_state_flag |= GLUT_STENCIL; /* Somebody fix this for me! */
546 case 16 : /* "single": Boolean indicate the color buffer is single
548 glut_state_flag |= GLUT_SINGLE ;
551 case 17 : /* "stereo": Boolean indicating the color buffer supports
552 OpenGL-style stereo */
553 glut_state_flag |= GLUT_STEREO ;
556 case 18 : /* "samples": Indicates the number of multisamples to use
557 based on GLX's SGIS_multisample extension (for
559 glut_state_flag |= GLUT_MULTISAMPLE ; /*Somebody fix this for me!*/
562 case 19 : /* "slow": Boolean indicating if the frame buffer
563 configuration is slow or not */
566 case 20 : /* "win32pdf": (incorrect spelling but was there before */
567 case 21 : /* "win32pfd": matches the Win32 Pixel Format Descriptor by
569 #if TARGET_HOST_MS_WINDOWS
573 case 22 : /* "xvisual": matches the X visual ID by number */
574 #if TARGET_HOST_POSIX_X11
578 case 23 : /* "xstaticgray": */
579 case 29 : /* "xstaticgrey": boolean indicating if the frame buffer
580 configuration's X visual is of type StaticGray */
581 #if TARGET_HOST_POSIX_X11
585 case 24 : /* "xgrayscale": */
586 case 30 : /* "xgreyscale": boolean indicating if the frame buffer
587 configuration's X visual is of type GrayScale */
588 #if TARGET_HOST_POSIX_X11
592 case 25 : /* "xstaticcolor": */
593 case 31 : /* "xstaticcolour": boolean indicating if the frame buffer
594 configuration's X visual is of type StaticColor */
595 #if TARGET_HOST_POSIX_X11
599 case 26 : /* "xpseudocolor": */
600 case 32 : /* "xpseudocolour": boolean indicating if the frame buffer
601 configuration's X visual is of type PseudoColor */
602 #if TARGET_HOST_POSIX_X11
606 case 27 : /* "xtruecolor": */
607 case 33 : /* "xtruecolour": boolean indicating if the frame buffer
608 configuration's X visual is of type TrueColor */
609 #if TARGET_HOST_POSIX_X11
613 case 28 : /* "xdirectcolor": */
614 case 34 : /* "xdirectcolour": boolean indicating if the frame buffer
615 configuration's X visual is of type DirectColor */
616 #if TARGET_HOST_POSIX_X11
620 case 35 : /* "borderless": windows should not have borders */
621 glut_state_flag |= GLUT_BORDERLESS;
624 case 36 : /* "aux": some number of aux buffers */
625 glut_state_flag |= GLUT_AUX;
628 case 37 : /* Unrecognized */
629 fgWarning ( "WARNING - Display string token not recognized: %s",
634 token = strtok ( NULL, " \t" );
639 /* We will make use of this value when creating a new OpenGL context... */
640 fgState.DisplayMode = glut_state_flag;
643 /* -- SETTING OPENGL 3.0 CONTEXT CREATION PARAMETERS ---------------------- */
645 void FGAPIENTRY glutInitContextVersion( int majorVersion, int minorVersion )
647 /* We will make use of these value when creating a new OpenGL context... */
648 fgState.MajorVersion = majorVersion;
649 fgState.MinorVersion = minorVersion;
653 void FGAPIENTRY glutInitContextFlags( int flags )
655 /* We will make use of this value when creating a new OpenGL context... */
656 fgState.ContextFlags = flags;
659 void FGAPIENTRY glutInitContextProfile( int profile )
661 /* We will make use of this value when creating a new OpenGL context... */
662 fgState.ContextProfile = profile;
665 /* -------------- User Defined Error/Warning Handler Support -------------- */
668 * Sets the user error handler (note the use of va_list for the args to the fmt)
670 void FGAPIENTRY glutInitErrorFunc( void (* vfgError) ( const char *fmt, va_list ap ) )
672 /* This allows user programs to handle freeglut errors */
673 fgState.ErrorFunc = vfgError;
677 * Sets the user warning handler (note the use of va_list for the args to the fmt)
679 void FGAPIENTRY glutInitWarningFunc( void (* vfgWarning) ( const char *fmt, va_list ap ) )
681 /* This allows user programs to handle freeglut warnings */
682 fgState.WarningFunc = vfgWarning;
685 /*** END OF FILE ***/