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.
32 #include <GL/freeglut.h>
33 #include "freeglut_internal.h"
36 * TODO BEFORE THE STABLE RELEASE:
38 * fgDeinitialize() -- Win32's OK, X11 needs the OS-specific
39 * deinitialization done
40 * glutInitDisplayString() -- display mode string parsing
42 * Wouldn't it be cool to use gettext() for error messages? I just love
43 * bash saying "nie znaleziono pliku" instead of "file not found" :)
44 * Is gettext easily portable?
47 /* -- GLOBAL VARIABLES ----------------------------------------------------- */
50 * A structure pointed by g_pDisplay holds all information
51 * regarding the display, screen, root window etc.
53 SFG_Display fgDisplay;
56 * The settings for the current freeglut session
58 SFG_State fgState = { { -1, -1, GL_FALSE }, /* Position */
59 { 300, 300, GL_TRUE }, /* Size */
60 GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH, /* DisplayMode */
61 GL_FALSE, /* Initialised */
62 GL_FALSE, /* ForceDirectContext */
63 GL_TRUE, /* TryDirectContext */
64 GL_FALSE, /* ForceIconic */
65 GL_FALSE, /* UseCurrentContext */
66 GL_FALSE, /* GLDebugSwitch */
67 GL_FALSE, /* XSyncSwitch */
68 GL_TRUE, /* KeyRepeat */
69 0xffffffff, /* Modifiers */
73 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
74 { 0, GL_FALSE }, /* Time */
76 { { 0, 0 }, GL_FALSE },
78 { NULL, NULL }, /* Timers */
79 { NULL, NULL }, /* FreeTimers */
80 NULL, /* IdleCallback */
82 NULL, /* MenuStateCallback */
83 NULL, /* MenuStatusCallback */
84 { 640, 480, GL_TRUE }, /* GameModeSize */
85 16, /* GameModeDepth */
86 72, /* GameModeRefresh */
87 GLUT_ACTION_EXIT, /* ActionOnWindowClose */
88 GLUT_EXEC_STATE_INIT, /* ExecState */
89 NULL /* ProgramName */
93 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
96 * A call to this function should initialize all the display stuff...
98 void fgInitialize( const char* displayName )
100 #if TARGET_HOST_UNIX_X11
101 fgDisplay.Display = XOpenDisplay( displayName );
103 if( fgDisplay.Display == NULL )
104 fgError( "failed to open display '%s'", XDisplayName( displayName ) );
106 if( !glXQueryExtension( fgDisplay.Display, NULL, NULL ) )
107 fgError( "OpenGL GLX extension not supported by display '%s'",
108 XDisplayName( displayName ) );
110 fgDisplay.Screen = DefaultScreen( fgDisplay.Display );
111 fgDisplay.RootWindow = RootWindow(
116 fgDisplay.ScreenWidth = DisplayWidth(
120 fgDisplay.ScreenHeight = DisplayHeight(
125 fgDisplay.ScreenWidthMM = DisplayWidthMM(
129 fgDisplay.ScreenHeightMM = DisplayHeightMM(
134 fgDisplay.Connection = ConnectionNumber( fgDisplay.Display );
137 * Create the window deletion atom
139 fgDisplay.DeleteWindow = XInternAtom(
145 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
151 * What we need to do is to initialize the fgDisplay global structure here.
153 fgDisplay.Instance = GetModuleHandle( NULL );
155 atom = GetClassInfo( fgDisplay.Instance, _T("FREEGLUT"), &wc );
159 ZeroMemory( &wc, sizeof(WNDCLASS) );
162 * Each of the windows should have its own device context, and we
163 * want redraw events during Vertical and Horizontal Resizes by
166 * XXX Old code had "| CS_DBCLCKS" commented out. Plans for the
167 * XXX future? Dead-end idea?
169 wc.lpfnWndProc = fgWindowProc;
172 wc.hInstance = fgDisplay.Instance;
173 wc.hIcon = LoadIcon( fgDisplay.Instance, _T("GLUT_ICON") );
175 #if TARGET_HOST_WIN32
176 wc.style = CS_OWNDC | CS_HREDRAW | CS_VREDRAW;
178 wc.hIcon = LoadIcon( NULL, IDI_WINLOGO );
179 #else /* TARGET_HOST_WINCE */
180 wc.style = CS_HREDRAW | CS_VREDRAW;
183 wc.hCursor = LoadCursor( NULL, IDC_ARROW );
184 wc.hbrBackground = NULL;
185 wc.lpszMenuName = NULL;
186 wc.lpszClassName = _T("FREEGLUT");
189 * Register the window class
191 atom = RegisterClass( &wc );
196 * The screen dimensions can be obtained via GetSystemMetrics() calls
198 fgDisplay.ScreenWidth = GetSystemMetrics( SM_CXSCREEN );
199 fgDisplay.ScreenHeight = GetSystemMetrics( SM_CYSCREEN );
202 HWND desktop = GetDesktopWindow( );
203 HDC context = GetDC( desktop );
205 fgDisplay.ScreenWidthMM = GetDeviceCaps( context, HORZSIZE );
206 fgDisplay.ScreenHeightMM = GetDeviceCaps( context, VERTSIZE );
208 ReleaseDC( desktop, context );
213 #if !TARGET_HOST_WINCE
216 #endif /* !TARGET_HOST_WINCE */
218 fgState.Initialised = GL_TRUE;
222 * Perform the freeglut deinitialization...
224 void fgDeinitialize( void )
228 if( !fgState.Initialised )
230 fgWarning( "fgDeinitialize(): "
231 "no valid initialization has been performed" );
235 /* fgState.Initialised = GL_FALSE; */
238 * If there was a menu created, destroy the rendering context
240 if( fgStructure.MenuContext )
242 free( fgStructure.MenuContext );
243 fgStructure.MenuContext = NULL;
246 fgDestroyStructure( );
248 while( (timer = fgState.Timers.First) )
250 fgListRemove( &fgState.Timers, &timer->Node );
254 while( (timer = fgState.FreeTimers.First) )
256 fgListRemove( &fgState.FreeTimers, &timer->Node );
260 #if !TARGET_HOST_WINCE
262 #endif /* !TARGET_HOST_WINCE */
264 fgState.Initialised = GL_FALSE;
266 fgState.Position.X = -1;
267 fgState.Position.Y = -1;
268 fgState.Position.Use = GL_FALSE;
270 fgState.Size.X = 300;
271 fgState.Size.Y = 300;
272 fgState.Size.Use = GL_TRUE;
274 fgState.DisplayMode = GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH;
276 fgState.ForceDirectContext = GL_FALSE;
277 fgState.TryDirectContext = GL_TRUE;
278 fgState.ForceIconic = GL_FALSE;
279 fgState.UseCurrentContext = GL_FALSE;
280 fgState.GLDebugSwitch = GL_FALSE;
281 fgState.XSyncSwitch = GL_FALSE;
282 fgState.ActionOnWindowClose = GLUT_ACTION_EXIT;
283 fgState.ExecState = GLUT_EXEC_STATE_INIT;
285 fgState.KeyRepeat = GL_FALSE;
286 fgState.Modifiers = 0xffffffff;
288 fgState.GameModeSize.X = 640;
289 fgState.GameModeSize.Y = 480;
290 fgState.GameModeDepth = 16;
291 fgState.GameModeRefresh = 72;
293 fgState.Time.Set = GL_FALSE;
295 fgListInit( &fgState.Timers );
296 fgListInit( &fgState.FreeTimers );
298 fgState.IdleCallback = NULL;
299 fgState.MenuStateCallback = ( FGCBMenuState )NULL;
300 fgState.MenuStatusCallback = ( FGCBMenuStatus )NULL;
302 fgState.SwapCount = 0;
303 fgState.SwapTime = 0;
304 fgState.FPSInterval = 0;
306 if( fgState.ProgramName )
308 free( fgState.ProgramName );
309 fgState.ProgramName = NULL;
313 #if TARGET_HOST_UNIX_X11
316 * Make sure all X-client data we have created will be destroyed on
319 XSetCloseDownMode( fgDisplay.Display, DestroyAll );
322 * Close the display connection, destroying all windows we have
325 XCloseDisplay( fgDisplay.Display );
331 * Everything inside the following #ifndef is copied from the X sources.
334 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
338 Copyright 1985, 1986, 1987,1998 The Open Group
340 Permission to use, copy, modify, distribute, and sell this software and its
341 documentation for any purpose is hereby granted without fee, provided that
342 the above copyright notice appear in all copies and that both that
343 copyright notice and this permission notice appear in supporting
346 The above copyright notice and this permission notice shall be included
347 in all copies or substantial portions of the Software.
349 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
350 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
351 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
352 IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
353 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
354 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
355 OTHER DEALINGS IN THE SOFTWARE.
357 Except as contained in this notice, the name of The Open Group shall
358 not be used in advertising or otherwise to promote the sale, use or
359 other dealings in this Software without prior written authorization
364 #define NoValue 0x0000
365 #define XValue 0x0001
366 #define YValue 0x0002
367 #define WidthValue 0x0004
368 #define HeightValue 0x0008
369 #define AllValues 0x000F
370 #define XNegative 0x0010
371 #define YNegative 0x0020
374 * XParseGeometry parses strings of the form
375 * "=<width>x<height>{+-}<xoffset>{+-}<yoffset>", where
376 * width, height, xoffset, and yoffset are unsigned integers.
377 * Example: "=80x24+300-49"
378 * The equal sign is optional.
379 * It returns a bitmask that indicates which of the four values
380 * were actually found in the string. For each value found,
381 * the corresponding argument is updated; for each value
382 * not found, the corresponding argument is left unchanged.
386 ReadInteger(char *string, char **NextString)
388 register int Result = 0;
393 else if (*string == '-')
398 for (; (*string >= '0') && (*string <= '9'); string++)
400 Result = (Result * 10) + (*string - '0');
402 *NextString = string;
409 static int XParseGeometry (
413 unsigned int *width, /* RETURN */
414 unsigned int *height) /* RETURN */
417 register char *strind;
418 unsigned int tempWidth = 0, tempHeight = 0;
419 int tempX = 0, tempY = 0;
422 if ( (string == NULL) || (*string == '\0'))
425 string++; /* ignore possible '=' at beg of geometry spec */
427 strind = (char *)string;
428 if (*strind != '+' && *strind != '-' && *strind != 'x') {
429 tempWidth = ReadInteger(strind, &nextCharacter);
430 if (strind == nextCharacter)
432 strind = nextCharacter;
436 if (*strind == 'x' || *strind == 'X') {
438 tempHeight = ReadInteger(strind, &nextCharacter);
439 if (strind == nextCharacter)
441 strind = nextCharacter;
445 if ((*strind == '+') || (*strind == '-')) {
446 if (*strind == '-') {
448 tempX = -ReadInteger(strind, &nextCharacter);
449 if (strind == nextCharacter)
451 strind = nextCharacter;
457 tempX = ReadInteger(strind, &nextCharacter);
458 if (strind == nextCharacter)
460 strind = nextCharacter;
463 if ((*strind == '+') || (*strind == '-')) {
464 if (*strind == '-') {
466 tempY = -ReadInteger(strind, &nextCharacter);
467 if (strind == nextCharacter)
469 strind = nextCharacter;
475 tempY = ReadInteger(strind, &nextCharacter);
476 if (strind == nextCharacter)
478 strind = nextCharacter;
484 /* If strind isn't at the end of the string the it's an invalid
485 geometry specification. */
487 if (*strind != '\0') return 0;
493 if (mask & WidthValue)
495 if (mask & HeightValue)
496 *height = tempHeight;
501 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
504 * Perform initialization. This usually happens on the program startup
505 * and restarting after glutMainLoop termination...
507 void FGAPIENTRY glutInit( int* pargc, char** argv )
509 char* displayName = NULL;
510 char* geometry = NULL;
511 int i, j, argc = *pargc;
513 if( fgState.Initialised )
514 fgError( "illegal glutInit() reinitialization attempt" );
516 if (pargc && *pargc && argv && *argv && **argv)
518 fgState.ProgramName = strdup (*argv);
520 if( !fgState.ProgramName )
521 fgError ("Could not allocate space for the program's name.");
524 fgCreateStructure( );
528 /* check if GLUT_FPS env var is set */
529 #if !TARGET_HOST_WINCE
531 const char *fps = getenv( "GLUT_FPS" );
535 sscanf( fps, "%d", &interval );
538 fgState.FPSInterval = 5000; /* 5000 millisecond default */
540 fgState.FPSInterval = interval;
544 displayName = getenv( "DISPLAY");
546 for( i = 1; i < argc; i++ )
548 if( strcmp( argv[ i ], "-display" ) == 0 )
551 fgError( "-display parameter must be followed by display name" );
553 displayName = argv[ i ];
555 argv[ i - 1 ] = NULL;
559 else if( strcmp( argv[ i ], "-geometry" ) == 0 )
562 fgError( "-geometry parameter must be followed by window "
563 "geometry settings" );
565 geometry = argv[ i ];
567 argv[ i - 1 ] = NULL;
571 else if( strcmp( argv[ i ], "-direct" ) == 0)
573 if( ! fgState.TryDirectContext )
574 fgError( "parameters ambiguity, -direct and -indirect "
575 "cannot be both specified" );
577 fgState.ForceDirectContext = GL_TRUE;
581 else if( strcmp( argv[ i ], "-indirect" ) == 0 )
583 if( fgState.ForceDirectContext )
584 fgError( "parameters ambiguity, -direct and -indirect "
585 "cannot be both specified" );
587 fgState.TryDirectContext = GL_FALSE;
591 else if( strcmp( argv[ i ], "-iconic" ) == 0 )
593 fgState.ForceIconic = GL_TRUE;
597 else if( strcmp( argv[ i ], "-gldebug" ) == 0 )
599 fgState.GLDebugSwitch = GL_TRUE;
603 else if( strcmp( argv[ i ], "-sync" ) == 0 )
605 fgState.XSyncSwitch = GL_TRUE;
615 for( i = 1; i < *pargc; i++, j++ )
617 if( argv[ i ] == NULL )
619 /* Guaranteed to end because there are "*pargc" arguments left */
620 while ( argv[ j ] == NULL )
622 argv[ i ] = argv[ j ];
626 #endif /* TARGET_HOST_WINCE */
629 * Have the display created now. If there wasn't a "-display"
630 * in the program arguments, we will use the DISPLAY environment
631 * variable for opening the X display (see code above):
633 fgInitialize( displayName );
636 * Geometry parsing deffered until here because we may need the screen
642 int mask = XParseGeometry( geometry,
643 &fgState.Position.X, &fgState.Position.Y,
644 &fgState.Size.X, &fgState.Size.Y );
646 if( (mask & (WidthValue|HeightValue)) == (WidthValue|HeightValue) )
647 fgState.Size.Use = GL_TRUE;
649 if( mask & XNegative )
650 fgState.Position.X += fgDisplay.ScreenWidth - fgState.Size.X;
652 if( mask & YNegative )
653 fgState.Position.Y += fgDisplay.ScreenHeight - fgState.Size.Y;
655 if( (mask & (XValue|YValue)) == (XValue|YValue) )
656 fgState.Position.Use = GL_TRUE;
661 * Sets the default initial window position for new windows
663 void FGAPIENTRY glutInitWindowPosition( int x, int y )
665 fgState.Position.X = x;
666 fgState.Position.Y = y;
668 if( ( x >= 0 ) && ( y >= 0 ) )
669 fgState.Position.Use = GL_TRUE;
671 fgState.Position.Use = GL_FALSE;
675 * Sets the default initial window size for new windows
677 void FGAPIENTRY glutInitWindowSize( int width, int height )
679 fgState.Size.X = width;
680 fgState.Size.Y = height;
682 if( ( width > 0 ) && ( height > 0 ) )
683 fgState.Size.Use = GL_TRUE;
685 fgState.Size.Use = GL_FALSE;
689 * Sets the default display mode for all new windows
691 void FGAPIENTRY glutInitDisplayMode( unsigned int displayMode )
694 * We will make use of this value when creating a new OpenGL context...
696 fgState.DisplayMode = displayMode;
700 /* -- INIT DISPLAY STRING PARSING ------------------------------------------ */
702 #define NUM_TOKENS 28
703 static char* Tokens[] =
705 "alpha", "acca", "acc", "blue", "buffer", "conformant", "depth", "double",
706 "green", "index", "num", "red", "rgba", "rgb", "luminance", "stencil",
707 "single", "stereo", "samples", "slow", "win32pdf", "xvisual",
708 "xstaticgray", "xgrayscale", "xstaticcolor", "xpseudocolor",
709 "xtruecolor", "xdirectcolor"
712 static int TokenLengths[] =
714 5, 4, 3, 4, 6, 10, 5, 6,
715 5, 5, 3, 3, 4, 3, 9, 7,
721 void FGAPIENTRY glutInitDisplayString( const char* displayMode )
723 int glut_state_flag = 0 ;
725 * Unpack a lot of options from a character string. The options are
726 * delimited by blanks or tabs.
729 int len = strlen ( displayMode );
730 char *buffer = (char *)malloc ( (len+1) * sizeof(char) );
731 memcpy ( buffer, displayMode, len );
734 token = strtok ( buffer, " \t" );
741 for ( i = 0; i < NUM_TOKENS; i++ )
743 if ( strncmp ( token, Tokens[i], TokenLengths[i] ) == 0 ) break ;
748 case 0 : /* "alpha": Alpha color buffer precision in bits */
749 glut_state_flag |= GLUT_ALPHA ; /* Somebody fix this for me! */
752 case 1 : /* "acca": Red, green, blue, and alpha accumulation buffer
756 case 2 : /* "acc": Red, green, and blue accumulation buffer precision
757 in bits with zero bits alpha */
758 glut_state_flag |= GLUT_ACCUM ; /* Somebody fix this for me! */
761 case 3 : /* "blue": Blue color buffer precision in bits */
764 case 4 : /* "buffer": Number of bits in the color index color buffer
768 case 5 : /* "conformant": Boolean indicating if the frame buffer
769 configuration is conformant or not */
772 case 6 : /* "depth": Number of bits of precsion in the depth buffer */
773 glut_state_flag |= GLUT_DEPTH ; /* Somebody fix this for me! */
776 case 7 : /* "double": Boolean indicating if the color buffer is
778 glut_state_flag |= GLUT_DOUBLE ;
781 case 8 : /* "green": Green color buffer precision in bits */
784 case 9 : /* "index": Boolean if the color model is color index or not
786 glut_state_flag |= GLUT_INDEX ;
789 case 10 : /* "num": A special capability name indicating where the
790 value represents the Nth frame buffer configuration
791 matching the description string */
794 case 11 : /* "red": Red color buffer precision in bits */
797 case 12 : /* "rgba": Number of bits of red, green, blue, and alpha in
798 the RGBA color buffer */
799 glut_state_flag |= GLUT_RGBA ; /* Somebody fix this for me! */
802 case 13 : /* "rgb": Number of bits of red, green, and blue in the
803 RGBA color buffer with zero bits alpha */
804 glut_state_flag |= GLUT_RGB ; /* Somebody fix this for me! */
807 case 14 : /* "luminance": Number of bits of red in the RGBA and zero
808 bits of green, blue (alpha not specified) of color buffer
810 glut_state_flag |= GLUT_LUMINANCE ; /* Somebody fix this for me! */
813 case 15 : /* "stencil": Number of bits in the stencil buffer */
814 glut_state_flag |= GLUT_STENCIL; /* Somebody fix this for me! */
817 case 16 : /* "single": Boolean indicate the color buffer is single
819 glut_state_flag |= GLUT_SINGLE ;
822 case 17 : /* "stereo": Boolean indicating the color buffer supports
823 OpenGL-style stereo */
824 glut_state_flag |= GLUT_STEREO ;
827 case 18 : /* "samples": Indicates the number of multisamples to use
828 based on GLX's SGIS_multisample extension (for
830 glut_state_flag |= GLUT_MULTISAMPLE ; /*Somebody fix this for me!*/
833 case 19 : /* "slow": Boolean indicating if the frame buffer
834 configuration is slow or not */
837 case 20 : /* "win32pdf": matches the Win32 Pixel Format Descriptor by
839 #if TARGET_HOST_WIN32
843 case 21 : /* "xvisual": matches the X visual ID by number */
844 #if TARGET_HOST_UNIX_X11
848 case 22 : /* "xstaticgray": boolean indicating if the frame buffer
849 configuration's X visual is of type StaticGray */
850 #if TARGET_HOST_UNIX_X11
854 case 23 : /* "xgrayscale": boolean indicating if the frame buffer
855 configuration's X visual is of type GrayScale */
856 #if TARGET_HOST_UNIX_X11
860 case 24 : /* "xstaticcolor": boolean indicating if the frame buffer
861 configuration's X visual is of type StaticColor */
862 #if TARGET_HOST_UNIX_X11
866 case 25 : /* "xpseudocolor": boolean indicating if the frame buffer
867 configuration's X visual is of type PseudoColor */
868 #if TARGET_HOST_UNIX_X11
872 case 26 : /* "xtruecolor": boolean indicating if the frame buffer
873 configuration's X visual is of type TrueColor */
874 #if TARGET_HOST_UNIX_X11
878 case 27 : /* "xdirectcolor": boolean indicating if the frame buffer
879 configuration's X visual is of type DirectColor */
880 #if TARGET_HOST_UNIX_X11
884 case 28 : /* Unrecognized */
885 printf ( "WARNING - Display string token not recognized: %s\n",
890 token = strtok ( NULL, " \t" );
896 * We will make use of this value when creating a new OpenGL context...
898 fgState.DisplayMode = glut_state_flag;
901 /*** END OF FILE ***/