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 "../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, /* IgnoreKeyRepeat */
69 0xffffffff, /* Modifiers */
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
151 * What we need to do is to initialize the fgDisplay global structure here.
153 fgDisplay.Instance = GetModuleHandle( NULL );
155 atom = GetClassInfo( fgDisplay.Instance, "FREEGLUT", &wc );
158 ZeroMemory( &wc, sizeof(WNDCLASS) );
161 * Each of the windows should have its own device context, and we
162 * want redraw events during Vertical and Horizontal Resizes by
165 * XXX Old code had "| CS_DBCLCKS" commented out. Plans for the
166 * XXX future? Dead-end idea?
168 wc.style = CS_OWNDC | CS_HREDRAW | CS_VREDRAW;
169 wc.lpfnWndProc = fgWindowProc;
172 wc.hInstance = fgDisplay.Instance;
173 wc.hIcon = LoadIcon( fgDisplay.Instance, "GLUT_ICON" );
175 wc.hIcon = LoadIcon( NULL, IDI_WINLOGO );
177 wc.hCursor = LoadCursor( NULL, IDC_ARROW );
178 wc.hbrBackground = NULL;
179 wc.lpszMenuName = NULL;
180 wc.lpszClassName = "FREEGLUT";
183 * Register the window class
185 atom = RegisterClass( &wc );
190 * The screen dimensions can be obtained via GetSystemMetrics() calls
192 fgDisplay.ScreenWidth = GetSystemMetrics( SM_CXSCREEN );
193 fgDisplay.ScreenHeight = GetSystemMetrics( SM_CYSCREEN );
196 HWND desktop = GetDesktopWindow( );
197 HDC context = GetDC( desktop );
199 fgDisplay.ScreenWidthMM = GetDeviceCaps( context, HORZSIZE );
200 fgDisplay.ScreenHeightMM = GetDeviceCaps( context, VERTSIZE );
202 ReleaseDC( desktop, context );
210 fgState.Initialised = GL_TRUE;
214 * Perform the freeglut deinitialization...
216 void fgDeinitialize( void )
220 if( !fgState.Initialised )
222 fgWarning( "fgDeinitialize(): "
223 "no valid initialization has been performed" );
227 /* fgState.Initialised = GL_FALSE; */
230 * If there was a menu created, destroy the rendering context
232 if( fgStructure.MenuContext )
234 free( fgStructure.MenuContext );
235 fgStructure.MenuContext = NULL;
238 fgDestroyStructure( );
240 while( (timer = fgState.Timers.First) )
242 fgListRemove( &fgState.Timers, &timer->Node );
246 while( (timer = fgState.FreeTimers.First) )
248 fgListRemove( &fgState.FreeTimers, &timer->Node );
254 fgState.Initialised = GL_FALSE;
256 fgState.Position.X = -1;
257 fgState.Position.Y = -1;
258 fgState.Position.Use = GL_FALSE;
260 fgState.Size.X = 300;
261 fgState.Size.Y = 300;
262 fgState.Size.Use = GL_TRUE;
264 fgState.DisplayMode = GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH;
266 fgState.ForceDirectContext = GL_FALSE;
267 fgState.TryDirectContext = GL_TRUE;
268 fgState.ForceIconic = GL_FALSE;
269 fgState.UseCurrentContext = GL_FALSE;
270 fgState.GLDebugSwitch = GL_FALSE;
271 fgState.XSyncSwitch = GL_FALSE;
272 fgState.ActionOnWindowClose = GLUT_ACTION_EXIT;
273 fgState.ExecState = GLUT_EXEC_STATE_INIT;
275 fgState.IgnoreKeyRepeat = GL_TRUE;
276 fgState.Modifiers = 0xffffffff;
278 fgState.GameModeSize.X = 640;
279 fgState.GameModeSize.Y = 480;
280 fgState.GameModeDepth = 16;
281 fgState.GameModeRefresh = 72;
283 fgState.Time.Set = GL_FALSE;
285 fgListInit( &fgState.Timers );
286 fgListInit( &fgState.FreeTimers );
288 fgState.IdleCallback = NULL;
289 fgState.MenuStateCallback = ( FGCBMenuState )NULL;
290 fgState.MenuStatusCallback = ( FGCBMenuStatus )NULL;
292 fgState.SwapCount = 0;
293 fgState.SwapTime = 0;
294 fgState.FPSInterval = 0;
296 if( fgState.ProgramName )
298 free( fgState.ProgramName );
299 fgState.ProgramName = NULL;
303 #if TARGET_HOST_UNIX_X11
306 * Make sure all X-client data we have created will be destroyed on
309 XSetCloseDownMode( fgDisplay.Display, DestroyAll );
312 * Close the display connection, destroying all windows we have
315 XCloseDisplay( fgDisplay.Display );
321 * Everything inside the following #ifndef is copied from the X sources.
324 #if TARGET_HOST_WIN32
328 Copyright 1985, 1986, 1987,1998 The Open Group
330 Permission to use, copy, modify, distribute, and sell this software and its
331 documentation for any purpose is hereby granted without fee, provided that
332 the above copyright notice appear in all copies and that both that
333 copyright notice and this permission notice appear in supporting
336 The above copyright notice and this permission notice shall be included
337 in all copies or substantial portions of the Software.
339 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
340 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
341 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
342 IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
343 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
344 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
345 OTHER DEALINGS IN THE SOFTWARE.
347 Except as contained in this notice, the name of The Open Group shall
348 not be used in advertising or otherwise to promote the sale, use or
349 other dealings in this Software without prior written authorization
354 #define NoValue 0x0000
355 #define XValue 0x0001
356 #define YValue 0x0002
357 #define WidthValue 0x0004
358 #define HeightValue 0x0008
359 #define AllValues 0x000F
360 #define XNegative 0x0010
361 #define YNegative 0x0020
364 * XParseGeometry parses strings of the form
365 * "=<width>x<height>{+-}<xoffset>{+-}<yoffset>", where
366 * width, height, xoffset, and yoffset are unsigned integers.
367 * Example: "=80x24+300-49"
368 * The equal sign is optional.
369 * It returns a bitmask that indicates which of the four values
370 * were actually found in the string. For each value found,
371 * the corresponding argument is updated; for each value
372 * not found, the corresponding argument is left unchanged.
376 ReadInteger(char *string, char **NextString)
378 register int Result = 0;
383 else if (*string == '-')
388 for (; (*string >= '0') && (*string <= '9'); string++)
390 Result = (Result * 10) + (*string - '0');
392 *NextString = string;
399 static int XParseGeometry (
403 unsigned int *width, /* RETURN */
404 unsigned int *height) /* RETURN */
407 register char *strind;
408 unsigned int tempWidth = 0, tempHeight = 0;
409 int tempX = 0, tempY = 0;
412 if ( (string == NULL) || (*string == '\0'))
415 string++; /* ignore possible '=' at beg of geometry spec */
417 strind = (char *)string;
418 if (*strind != '+' && *strind != '-' && *strind != 'x') {
419 tempWidth = ReadInteger(strind, &nextCharacter);
420 if (strind == nextCharacter)
422 strind = nextCharacter;
426 if (*strind == 'x' || *strind == 'X') {
428 tempHeight = ReadInteger(strind, &nextCharacter);
429 if (strind == nextCharacter)
431 strind = nextCharacter;
435 if ((*strind == '+') || (*strind == '-')) {
436 if (*strind == '-') {
438 tempX = -ReadInteger(strind, &nextCharacter);
439 if (strind == nextCharacter)
441 strind = nextCharacter;
447 tempX = ReadInteger(strind, &nextCharacter);
448 if (strind == nextCharacter)
450 strind = nextCharacter;
453 if ((*strind == '+') || (*strind == '-')) {
454 if (*strind == '-') {
456 tempY = -ReadInteger(strind, &nextCharacter);
457 if (strind == nextCharacter)
459 strind = nextCharacter;
465 tempY = ReadInteger(strind, &nextCharacter);
466 if (strind == nextCharacter)
468 strind = nextCharacter;
474 /* If strind isn't at the end of the string the it's an invalid
475 geometry specification. */
477 if (*strind != '\0') return 0;
483 if (mask & WidthValue)
485 if (mask & HeightValue)
486 *height = tempHeight;
491 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
494 * Perform initialization. This usually happens on the program startup
495 * and restarting after glutMainLoop termination...
497 void FGAPIENTRY glutInit( int* pargc, char** argv )
499 char* displayName = NULL;
500 char* geometry = NULL;
501 int i, j, argc = *pargc;
503 if( fgState.Initialised )
504 fgError( "illegal glutInit() reinitialization attempt" );
506 if (pargc && *pargc && argv && *argv && **argv)
508 fgState.ProgramName = strdup (*argv);
510 if( !fgState.ProgramName )
511 fgError ("Could not allocate space for the program's name.");
514 fgCreateStructure( );
518 /* check if GLUT_FPS env var is set */
520 const char *fps = getenv( "GLUT_FPS" );
524 sscanf( fps, "%d", &interval );
527 fgState.FPSInterval = 5000; /* 5000 millisecond default */
529 fgState.FPSInterval = interval;
533 displayName = getenv( "DISPLAY");
535 for( i = 1; i < argc; i++ )
537 if( strcmp( argv[ i ], "-display" ) == 0 )
540 fgError( "-display parameter must be followed by display name" );
542 displayName = argv[ i ];
544 argv[ i - 1 ] = NULL;
548 else if( strcmp( argv[ i ], "-geometry" ) == 0 )
551 fgError( "-geometry parameter must be followed by window "
552 "geometry settings" );
554 geometry = argv[ i ];
556 argv[ i - 1 ] = NULL;
560 else if( strcmp( argv[ i ], "-direct" ) == 0)
562 if( ! fgState.TryDirectContext )
563 fgError( "parameters ambiguity, -direct and -indirect "
564 "cannot be both specified" );
566 fgState.ForceDirectContext = GL_TRUE;
570 else if( strcmp( argv[ i ], "-indirect" ) == 0 )
572 if( fgState.ForceDirectContext )
573 fgError( "parameters ambiguity, -direct and -indirect "
574 "cannot be both specified" );
576 fgState.TryDirectContext = GL_FALSE;
580 else if( strcmp( argv[ i ], "-iconic" ) == 0 )
582 fgState.ForceIconic = GL_TRUE;
586 else if( strcmp( argv[ i ], "-gldebug" ) == 0 )
588 fgState.GLDebugSwitch = GL_TRUE;
592 else if( strcmp( argv[ i ], "-sync" ) == 0 )
594 fgState.XSyncSwitch = GL_TRUE;
604 for( i = 1; i < *pargc; i++, j++ )
606 if( argv[ i ] == NULL )
608 /* Guaranteed to end because there are "*pargc" arguments left */
609 while ( argv[ j ] == NULL )
611 argv[ i ] = argv[ j ];
616 * Have the display created now. As I am too lazy to implement
617 * the program arguments parsing, we will have the DISPLAY
618 * environment variable used for opening the X display:
620 * XXX The above comment is rather unclear. We have just
621 * XXX completed parsing of the program arguments for GLUT
622 * XXX parameters. We obviously canNOT parse the application-
623 * XXX specific parameters. Can someone re-write the above
626 fgInitialize( displayName );
629 * Geometry parsing deffered until here because we may need the screen
635 int mask = XParseGeometry( geometry,
636 &fgState.Position.X, &fgState.Position.Y,
637 &fgState.Size.X, &fgState.Size.Y );
639 if( (mask & (WidthValue|HeightValue)) == (WidthValue|HeightValue) )
640 fgState.Size.Use = GL_TRUE;
642 if( mask & XNegative )
643 fgState.Position.X += fgDisplay.ScreenWidth - fgState.Size.X;
645 if( mask & YNegative )
646 fgState.Position.Y += fgDisplay.ScreenHeight - fgState.Size.Y;
648 if( (mask & (XValue|YValue)) == (XValue|YValue) )
649 fgState.Position.Use = GL_TRUE;
654 * Sets the default initial window position for new windows
656 void FGAPIENTRY glutInitWindowPosition( int x, int y )
658 fgState.Position.X = x;
659 fgState.Position.Y = y;
661 if( ( x >= 0 ) && ( y >= 0 ) )
662 fgState.Position.Use = GL_TRUE;
664 fgState.Position.Use = GL_FALSE;
668 * Sets the default initial window size for new windows
670 void FGAPIENTRY glutInitWindowSize( int width, int height )
672 fgState.Size.X = width;
673 fgState.Size.Y = height;
675 if( ( width > 0 ) && ( height > 0 ) )
676 fgState.Size.Use = GL_TRUE;
678 fgState.Size.Use = GL_FALSE;
682 * Sets the default display mode for all new windows
684 void FGAPIENTRY glutInitDisplayMode( unsigned int displayMode )
687 * We will make use of this value when creating a new OpenGL context...
689 fgState.DisplayMode = displayMode;
693 /* -- INIT DISPLAY STRING PARSING ------------------------------------------ */
695 #define NUM_TOKENS 28
696 static char* Tokens[] =
698 "alpha", "acca", "acc", "blue", "buffer", "conformant", "depth", "double",
699 "green", "index", "num", "red", "rgba", "rgb", "luminance", "stencil",
700 "single", "stereo", "samples", "slow", "win32pdf", "xvisual",
701 "xstaticgray", "xgrayscale", "xstaticcolor", "xpseudocolor",
702 "xtruecolor", "xdirectcolor"
705 static int TokenLengths[] =
707 5, 4, 3, 4, 6, 10, 5, 6,
708 5, 5, 3, 3, 4, 3, 9, 7,
714 void FGAPIENTRY glutInitDisplayString( const char* displayMode )
716 int glut_state_flag = 0 ;
718 * Unpack a lot of options from a character string. The options are
719 * delimited by blanks or tabs.
722 int len = strlen ( displayMode );
723 char *buffer = (char *)malloc ( (len+1) * sizeof(char) );
724 memcpy ( buffer, displayMode, len );
727 token = strtok ( buffer, " \t" );
734 for ( i = 0; i < NUM_TOKENS; i++ )
736 if ( strncmp ( token, Tokens[i], TokenLengths[i] ) == 0 ) break ;
741 case 0 : /* "alpha": Alpha color buffer precision in bits */
742 glut_state_flag |= GLUT_ALPHA ; /* Somebody fix this for me! */
745 case 1 : /* "acca": Red, green, blue, and alpha accumulation buffer
749 case 2 : /* "acc": Red, green, and blue accumulation buffer precision
750 in bits with zero bits alpha */
751 glut_state_flag |= GLUT_ACCUM ; /* Somebody fix this for me! */
754 case 3 : /* "blue": Blue color buffer precision in bits */
757 case 4 : /* "buffer": Number of bits in the color index color buffer
761 case 5 : /* "conformant": Boolean indicating if the frame buffer
762 configuration is conformant or not */
765 case 6 : /* "depth": Number of bits of precsion in the depth buffer */
766 glut_state_flag |= GLUT_DEPTH ; /* Somebody fix this for me! */
769 case 7 : /* "double": Boolean indicating if the color buffer is
771 glut_state_flag |= GLUT_DOUBLE ;
774 case 8 : /* "green": Green color buffer precision in bits */
777 case 9 : /* "index": Boolean if the color model is color index or not
779 glut_state_flag |= GLUT_INDEX ;
782 case 10 : /* "num": A special capability name indicating where the
783 value represents the Nth frame buffer configuration
784 matching the description string */
787 case 11 : /* "red": Red color buffer precision in bits */
790 case 12 : /* "rgba": Number of bits of red, green, blue, and alpha in
791 the RGBA color buffer */
792 glut_state_flag |= GLUT_RGBA ; /* Somebody fix this for me! */
795 case 13 : /* "rgb": Number of bits of red, green, and blue in the
796 RGBA color buffer with zero bits alpha */
797 glut_state_flag |= GLUT_RGB ; /* Somebody fix this for me! */
800 case 14 : /* "luminance": Number of bits of red in the RGBA and zero
801 bits of green, blue (alpha not specified) of color buffer
803 glut_state_flag |= GLUT_LUMINANCE ; /* Somebody fix this for me! */
806 case 15 : /* "stencil": Number of bits in the stencil buffer */
807 glut_state_flag |= GLUT_STENCIL; /* Somebody fix this for me! */
810 case 16 : /* "single": Boolean indicate the color buffer is single
812 glut_state_flag |= GLUT_SINGLE ;
815 case 17 : /* "stereo": Boolean indicating the color buffer supports
816 OpenGL-style stereo */
817 glut_state_flag |= GLUT_STEREO ;
820 case 18 : /* "samples": Indicates the number of multisamples to use
821 based on GLX's SGIS_multisample extension (for
823 glut_state_flag |= GLUT_MULTISAMPLE ; /*Somebody fix this for me!*/
826 case 19 : /* "slow": Boolean indicating if the frame buffer
827 configuration is slow or not */
830 case 20 : /* "win32pdf": matches the Win32 Pixel Format Descriptor by
832 #if TARGET_HOST_WIN32
836 case 21 : /* "xvisual": matches the X visual ID by number */
837 #if TARGET_HOST_UNIX_X11
841 case 22 : /* "xstaticgray": boolean indicating if the frame buffer
842 configuration's X visual is of type StaticGray */
843 #if TARGET_HOST_UNIX_X11
847 case 23 : /* "xgrayscale": boolean indicating if the frame buffer
848 configuration's X visual is of type GrayScale */
849 #if TARGET_HOST_UNIX_X11
853 case 24 : /* "xstaticcolor": boolean indicating if the frame buffer
854 configuration's X visual is of type StaticColor */
855 #if TARGET_HOST_UNIX_X11
859 case 25 : /* "xpseudocolor": boolean indicating if the frame buffer
860 configuration's X visual is of type PseudoColor */
861 #if TARGET_HOST_UNIX_X11
865 case 26 : /* "xtruecolor": boolean indicating if the frame buffer
866 configuration's X visual is of type TrueColor */
867 #if TARGET_HOST_UNIX_X11
871 case 27 : /* "xdirectcolor": boolean indicating if the frame buffer
872 configuration's X visual is of type DirectColor */
873 #if TARGET_HOST_UNIX_X11
877 case 28 : /* Unrecognized */
878 printf ( "WARNING - Display string token not recognized: %s\n",
883 token = strtok ( NULL, " \t" );
889 * We will make use of this value when creating a new OpenGL context...
891 fgState.DisplayMode = glut_state_flag;
894 /*** END OF FILE ***/