git.mutantstargoat.com Git - freeglut/blob - src/freeglut_gamemode.c

   1 /*
   2  * freeglut_gamemode.c
   3  *
   4  * The game mode handling code.
   5  *
   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 16 1999
   9  *
  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:
  16  *
  17  * The above copyright notice and this permission notice shall be included
  18  * in all copies or substantial portions of the Software.
  19  *
  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.
  26  */
  27
  28 #include <GL/freeglut.h>
  29 #include "freeglut_internal.h"
  30
  31 /*
  32  * TODO BEFORE THE STABLE RELEASE:
  33  *
  34  *  glutGameModeString()    -- missing
  35  *  glutEnterGameMode()     -- X11 version
  36  *  glutLeaveGameMode()     -- is that correct?
  37  *  glutGameModeGet()       -- is that correct?
  38  */
  39
  40
  41 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
  42
  43 /*
  44  * Remembers the current visual settings, so that
  45  * we can change them and restore later...
  46  */
  47 static void fghRememberState( void )
  48 {
  49 #if TARGET_HOST_UNIX_X11
  50
  51     /*
  52      * This highly depends on the XFree86 extensions,
  53      * not approved as X Consortium standards
  54      */
  55 #   ifdef X_XF86VidModeGetModeLine
  56
  57
  58     /*
  59      * Remember the current ViewPort location of the screen to be able to
  60      * restore the ViewPort on LeaveGameMode():
  61      */
  62     if( !XF86VidModeGetViewPort(
  63              fgDisplay.Display,
  64              fgDisplay.Screen,
  65              &fgDisplay.DisplayViewPortX,
  66              &fgDisplay.DisplayViewPortY ) )
  67         fgWarning( "XF86VidModeGetViewPort failed" );
  68
  69     /*
  70      * Remember the current pointer location before going fullscreen
  71      * for restoring it later:
  72      */
  73     {
  74         Window junk_window;
  75         unsigned int mask;
  76
  77         XQueryPointer(
  78             fgDisplay.Display, fgDisplay.RootWindow,
  79             &junk_window, &junk_window,
  80             &fgDisplay.DisplayPointerX, &fgDisplay.DisplayPointerY,
  81             &fgDisplay.DisplayPointerX, &fgDisplay.DisplayPointerY, &mask
  82         );
  83     }
  84
  85     /* Query the current display settings: */
  86     fgDisplay.DisplayModeValid =
  87       XF86VidModeGetModeLine(
  88         fgDisplay.Display,
  89         fgDisplay.Screen,
  90         &fgDisplay.DisplayModeClock,
  91         &fgDisplay.DisplayMode
  92     );
  93
  94     if( !fgDisplay.DisplayModeValid )
  95             fgWarning( "XF86VidModeGetModeLine failed" );
  96
  97 #   else
  98     /*
  99      * XXX warning fghRememberState: missing XFree86 video mode extensions,
 100      * XXX game mode will not change screen resolution when activated
 101      */
 102 #   endif
 103
 104 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 105
 106 /*    DEVMODE devMode; */
 107
 108     /* Grab the current desktop settings... */
 109
 110 /* hack to get around my stupid cross-gcc headers */
 111 #define FREEGLUT_ENUM_CURRENT_SETTINGS -1
 112
 113     EnumDisplaySettings( NULL, FREEGLUT_ENUM_CURRENT_SETTINGS,
 114                          &fgDisplay.DisplayMode );
 115
 116     /* Make sure we will be restoring all settings needed */
 117     fgDisplay.DisplayMode.dmFields |=
 118         DM_PELSWIDTH | DM_PELSHEIGHT | DM_BITSPERPEL | DM_DISPLAYFREQUENCY;
 119
 120 #endif
 121 }
 122
 123 /*
 124  * Restores the previously remembered visual settings
 125  */
 126 static void fghRestoreState( void )
 127 {
 128 #if TARGET_HOST_UNIX_X11
 129
 130 #   ifdef X_XF86VidModeGetAllModeLines
 131     /* Restore the remembered pointer position: */
 132     XWarpPointer(
 133         fgDisplay.Display, None, fgDisplay.RootWindow, 0, 0, 0, 0,
 134         fgDisplay.DisplayPointerX, fgDisplay.DisplayPointerY
 135     );
 136
 137     /*
 138      * This highly depends on the XFree86 extensions,
 139      * not approved as X Consortium standards
 140      */
 141
 142     if( fgDisplay.DisplayModeValid )
 143     {
 144         XF86VidModeModeInfo** displayModes;
 145         int i, displayModesCount;
 146
 147         if( !XF86VidModeGetAllModeLines(
 148                  fgDisplay.Display,
 149                  fgDisplay.Screen,
 150                  &displayModesCount,
 151                  &displayModes ) )
 152         {
 153             fgWarning( "XF86VidModeGetAllModeLines failed" );
 154             return;
 155         }
 156
 157
 158         /*
 159          * Check every of the modes looking for one that matches our demands.
 160          * If we find one, switch to it and restore the remembered viewport.
 161          */
 162         for( i = 0; i < displayModesCount; i++ )
 163         {
 164             if(displayModes[ i ]->hdisplay == fgDisplay.DisplayMode.hdisplay &&
 165                displayModes[ i ]->vdisplay == fgDisplay.DisplayMode.vdisplay &&
 166                displayModes[ i ]->dotclock == fgDisplay.DisplayModeClock )
 167             {
 168                 if( !XF86VidModeSwitchToMode(
 169                          fgDisplay.Display,
 170                          fgDisplay.Screen,
 171                          displayModes[ i ] ) )
 172                 {
 173                     fgWarning( "XF86VidModeSwitchToMode failed" );
 174                     break;
 175                 }
 176
 177                 if( !XF86VidModeSetViewPort(
 178                          fgDisplay.Display,
 179                          fgDisplay.Screen,
 180                          fgDisplay.DisplayViewPortX,
 181                          fgDisplay.DisplayViewPortY ) )
 182                     fgWarning( "XF86VidModeSetViewPort failed" );
 183
 184
 185                 /*
 186                  * For the case this would be the last X11 call the application
 187                  * calls exit() we've to flush the X11 output queue to have the
 188                  * commands sent to the X server before the application exits.
 189                  */
 190                 XFlush( fgDisplay.Display );
 191
 192                 break;
 193             }
 194         }
 195         XFree( displayModes );
 196     }
 197
 198 #   else
 199     /*
 200      * XXX warning fghRestoreState: missing XFree86 video mode extensions,
 201      * XXX game mode will not change screen resolution when activated
 202      */
 203 #   endif
 204
 205 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 206
 207     /* Restore the previously rememebered desktop display settings */
 208     ChangeDisplaySettings( &fgDisplay.DisplayMode, 0 );
 209
 210 #endif
 211 }
 212
 213 /*
 214  * Checks the display mode settings against user's preferences
 215  */
 216 static GLboolean fghCheckDisplayMode( int width, int height, int depth, int refresh )
 217 {
 218     /* The desired values should be stored in fgState structure... */
 219     return ( width == fgState.GameModeSize.X ) &&
 220            ( height == fgState.GameModeSize.Y ) &&
 221            ( depth == fgState.GameModeDepth ) &&
 222            (refresh == fgState.GameModeRefresh );
 223 }
 224
 225 /*
 226  * Changes the current display mode to match user's settings
 227  */
 228 static GLboolean fghChangeDisplayMode( GLboolean haveToTest )
 229 {
 230     GLboolean success = GL_FALSE;
 231 #if TARGET_HOST_UNIX_X11
 232
 233     /*
 234      * This highly depends on the XFree86 extensions,
 235      * not approved as X Consortium standards
 236      */
 237 #   ifdef X_XF86VidModeGetAllModeLines
 238
 239     /*
 240      * This is also used by applcations which check modes by calling
 241      * glutGameModeGet(GLUT_GAME_MODE_POSSIBLE), so allow the check:
 242      */
 243     if( haveToTest || fgDisplay.DisplayModeValid )
 244     {
 245         XF86VidModeModeInfo** displayModes;
 246         int i, ignoreRefreshRate, displayModesCount;
 247
 248         if( !XF86VidModeGetAllModeLines(
 249                  fgDisplay.Display,
 250                  fgDisplay.Screen,
 251                  &displayModesCount,
 252                  &displayModes ) )
 253         {
 254             fgWarning( "XF86VidModeGetAllModeLines failed" );
 255             return success;
 256         }
 257
 258
 259         /*
 260          * Check every of the modes looking for one that matches our demands,
 261          * ignoring the refresh rate if no exact match could be found.
 262          */
 263         for( ignoreRefreshRate = 0;
 264              !success && ( ignoreRefreshRate <= 1 );
 265              ignoreRefreshRate++)
 266         {
 267             for( i = 0;
 268                  !success && ( i < displayModesCount );
 269                  i++ )
 270             {
 271                 /* Compute the displays refresh rate, dotclock comes in kHz. */
 272                 int refresh = ( displayModes[ i ]->dotclock * 1000 ) /
 273                               ( displayModes[ i ]->htotal * displayModes[ i ]->vtotal );
 274
 275                 success = fghCheckDisplayMode( displayModes[ i ]->hdisplay,
 276                                                displayModes[ i ]->vdisplay,
 277                                                fgState.GameModeDepth,
 278                                                ( ignoreRefreshRate ? fgState.GameModeRefresh : refresh ) );
 279             }
 280         }
 281
 282         if( !haveToTest && success ) {
 283             if( !XF86VidModeSwitchToMode(
 284                      fgDisplay.Display,
 285                      fgDisplay.Screen,
 286                      displayModes[ i ] ) )
 287                 fgWarning( "XF86VidModeSwitchToMode failed" );
 288         }
 289
 290         XFree( displayModes );
 291     }
 292
 293 #   else
 294
 295     /*
 296      * XXX warning fghChangeDisplayMode: missing XFree86 video mode extensions,
 297      * XXX game mode will not change screen resolution when activated
 298      */
 299     success = GL_TRUE;
 300
 301 #   endif
 302
 303 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 304
 305     DEVMODE  devMode;
 306     char *fggmstr = NULL;
 307
 308     success = GL_FALSE;
 309
 310     EnumDisplaySettings( NULL, -1, &devMode );
 311     devMode.dmFields |= DM_PELSWIDTH | DM_PELSHEIGHT | DM_BITSPERPEL | DM_DISPLAYFREQUENCY;
 312
 313     devMode.dmPelsWidth  = fgState.GameModeSize.X;
 314     devMode.dmPelsHeight = fgState.GameModeSize.Y;
 315     devMode.dmBitsPerPel = fgState.GameModeDepth;
 316     devMode.dmDisplayFrequency = fgState.GameModeRefresh;
 317     devMode.dmFields = DM_PELSWIDTH | DM_PELSHEIGHT | DM_BITSPERPEL | DM_DISPLAYFREQUENCY;
 318
 319     switch ( ChangeDisplaySettingsEx(NULL, &devMode, NULL, haveToTest ? CDS_TEST : CDS_FULLSCREEN , NULL) )
 320     {
 321     case DISP_CHANGE_SUCCESSFUL:
 322         success = GL_TRUE;
 323
 324         /* update vars in case if windows switched to proper mode */
 325         EnumDisplaySettings( NULL, FREEGLUT_ENUM_CURRENT_SETTINGS, &devMode );
 326         fgState.GameModeSize.X  = devMode.dmPelsWidth;
 327         fgState.GameModeSize.Y  = devMode.dmPelsHeight;
 328         fgState.GameModeDepth   = devMode.dmBitsPerPel;
 329         fgState.GameModeRefresh = devMode.dmDisplayFrequency;
 330                 break;
 331     case DISP_CHANGE_RESTART:
 332         fggmstr = "The computer must be restarted for the graphics mode to work.";
 333         break;
 334     case DISP_CHANGE_BADFLAGS:
 335         fggmstr = "An invalid set of flags was passed in.";
 336         break;
 337     case DISP_CHANGE_BADPARAM:
 338         fggmstr = "An invalid parameter was passed in. This can include an invalid flag or combination of flags.";
 339         break;
 340     case DISP_CHANGE_FAILED:
 341         fggmstr = "The display driver failed the specified graphics mode.";
 342         break;
 343     case DISP_CHANGE_BADMODE:
 344         fggmstr = "The graphics mode is not supported.";
 345         break;
 346     default:
 347         fggmstr = "Unknown error in graphics mode???"; /* dunno if it is possible,MSDN does not mention any other error */
 348         break;
 349     }
 350
 351     if ( !success )
 352         fgWarning(fggmstr); /* I'd rather get info whats going on in my program than wonder about */
 353                             /* magic happenings behind my back, its lib for devels at last ;) */
 354 #endif
 355
 356     return success;
 357 }
 358
 359
 360 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
 361
 362 /*
 363  * Sets the game mode display string
 364  */
 365 void FGAPIENTRY glutGameModeString( const char* string )
 366 {
 367     int width = 640, height = 480, depth = 16, refresh = 72;
 368
 369     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGameModeString" );
 370
 371     /*
 372      * This one seems a bit easier than glutInitDisplayString. The bad thing
 373      * about it that I was unable to find the game mode string definition, so
 374      * that I assumed it is: "[width]x[height]:[depth]@[refresh rate]", which
 375      * appears in all GLUT game mode programs I have seen to date.
 376      */
 377     if( sscanf( string, "%ix%i:%i@%i", &width, &height, &depth, &refresh ) !=
 378         4 )
 379         if( sscanf( string, "%ix%i:%i", &width, &height, &depth ) != 3 )
 380             if( sscanf( string, "%ix%i@%i", &width, &height, &refresh ) != 3 )
 381                 if( sscanf( string, "%ix%i", &width, &height ) != 2 )
 382                     if( sscanf( string, ":%i@%i", &depth, &refresh ) != 2 )
 383                         if( sscanf( string, ":%i", &depth ) != 1 )
 384                             if( sscanf( string, "@%i", &refresh ) != 1 )
 385                                 fgWarning(
 386                                     "unable to parse game mode string `%s'",
 387                                     string
 388                                 );
 389
 390     /* Hopefully it worked, and if not, we still have the default values */
 391     fgState.GameModeSize.X  = width;
 392     fgState.GameModeSize.Y  = height;
 393     fgState.GameModeDepth   = depth;
 394     fgState.GameModeRefresh = refresh;
 395 }
 396
 397 /*
 398  * Enters the game mode
 399  */
 400 int FGAPIENTRY glutEnterGameMode( void )
 401 {
 402     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutEnterGameMode" );
 403
 404     if( fgStructure.GameMode )
 405         fgAddToWindowDestroyList( fgStructure.GameMode );
 406     else
 407         fghRememberState( );
 408
 409     if( ! fghChangeDisplayMode( GL_FALSE ) )
 410     {
 411         fgWarning( "failed to change screen settings" );
 412         return FALSE;
 413     }
 414
 415     fgStructure.GameMode = fgCreateWindow(
 416         NULL, "FREEGLUT", 0, 0,
 417         fgState.GameModeSize.X, fgState.GameModeSize.Y, GL_TRUE, GL_FALSE
 418     );
 419
 420     fgStructure.GameMode->State.Width  = fgState.GameModeSize.X;
 421     fgStructure.GameMode->State.Height = fgState.GameModeSize.Y;
 422
 423     fgStructure.GameMode->State.IsGameMode = GL_TRUE;
 424
 425 #if TARGET_HOST_UNIX_X11
 426
 427     /*
 428      * Sync needed to avoid a real race, the Xserver must have really created
 429      * the window before we can grab the pointer into it:
 430      */
 431     XSync( fgDisplay.Display, False );
 432
 433     /*
 434      * Grab the pointer to confine it into the window after the calls to
 435      * XWrapPointer() which ensure that the pointer really enters the window.
 436      *
 437      * We also need to wait here until XGrabPointer() returns GrabSuccess,
 438      * otherwise the new window is not viewable yet and if the next function
 439      * (XSetInputFocus) is called with a not yet viewable window, it will exit
 440      * the application which we have to aviod, so wait until it's viewable:
 441      */
 442     while( GrabSuccess != XGrabPointer(
 443                fgDisplay.Display, fgStructure.GameMode->Window.Handle,
 444                TRUE,
 445                ButtonPressMask | ButtonReleaseMask | ButtonMotionMask
 446                | PointerMotionMask,
 447                GrabModeAsync, GrabModeAsync,
 448                fgStructure.GameMode->Window.Handle, None, CurrentTime) )
 449         usleep( 100 );
 450
 451     /*
 452      * Change input focus to the new window. This will exit the application
 453      * if the new window is not viewable yet, see the XGrabPointer loop above.
 454      */
 455     XSetInputFocus(
 456         fgDisplay.Display,
 457         fgStructure.GameMode->Window.Handle,
 458         RevertToNone,
 459         CurrentTime
 460     );
 461
 462     /* Move the Pointer to the middle of the fullscreen window */
 463     XWarpPointer(
 464         fgDisplay.Display,
 465         None,
 466         fgDisplay.RootWindow,
 467         0, 0, 0, 0,
 468         fgState.GameModeSize.X/2, fgState.GameModeSize.Y/2
 469     );
 470
 471 #   ifdef X_XF86VidModeSetViewPort
 472
 473     if( fgDisplay.DisplayModeValid )
 474     {
 475         int x, y;
 476         Window child;
 477
 478         /* Change to viewport to the window topleft edge: */
 479         if( !XF86VidModeSetViewPort( fgDisplay.Display, fgDisplay.Screen, 0, 0 ) )
 480             fgWarning( "XF86VidModeSetViewPort failed" );
 481
 482         /*
 483          * Final window repositioning: It could be avoided using an undecorated
 484          * window using override_redirect, but this * would possily require
 485          * more changes and investigation.
 486          */
 487
 488         /* Get the current postion of the drawable area on screen */
 489         XTranslateCoordinates(
 490             fgDisplay.Display,
 491             fgStructure.CurrentWindow->Window.Handle,
 492             fgDisplay.RootWindow,
 493             0, 0, &x, &y,
 494             &child
 495         );
 496
 497         /* Move the decorataions out of the topleft corner of the display */
 498         XMoveWindow( fgDisplay.Display, fgStructure.CurrentWindow->Window.Handle,
 499                      -x, -y);
 500     }
 501
 502 #endif
 503
 504     /* Grab the keyboard, too */
 505     XGrabKeyboard(
 506         fgDisplay.Display,
 507         fgStructure.GameMode->Window.Handle,
 508         FALSE,
 509         GrabModeAsync, GrabModeAsync,
 510         CurrentTime
 511     );
 512
 513 #endif
 514
 515     return TRUE;
 516 }
 517
 518 /*
 519  * Leaves the game mode
 520  */
 521 void FGAPIENTRY glutLeaveGameMode( void )
 522 {
 523     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutLeaveGameMode" );
 524
 525     freeglut_return_if_fail( fgStructure.GameMode );
 526
 527     fgStructure.GameMode->State.IsGameMode = GL_FALSE;
 528
 529     fgAddToWindowDestroyList( fgStructure.GameMode );
 530     fgStructure.GameMode = NULL;
 531
 532 #if TARGET_HOST_UNIX_X11
 533
 534     XUngrabPointer( fgDisplay.Display, CurrentTime );
 535     XUngrabKeyboard( fgDisplay.Display, CurrentTime );
 536
 537 #endif
 538
 539     fghRestoreState();
 540 }
 541
 542 /*
 543  * Returns information concerning the freeglut game mode
 544  */
 545 int FGAPIENTRY glutGameModeGet( GLenum eWhat )
 546 {
 547     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGameModeGet" );
 548
 549     switch( eWhat )
 550     {
 551     case GLUT_GAME_MODE_ACTIVE:
 552         return !!fgStructure.GameMode;
 553
 554     case GLUT_GAME_MODE_POSSIBLE:
 555         return fghChangeDisplayMode( GL_TRUE );
 556
 557     case GLUT_GAME_MODE_WIDTH:
 558         return fgState.GameModeSize.X;
 559
 560     case GLUT_GAME_MODE_HEIGHT:
 561         return fgState.GameModeSize.Y;
 562
 563     case GLUT_GAME_MODE_PIXEL_DEPTH:
 564         return fgState.GameModeDepth;
 565
 566     case GLUT_GAME_MODE_REFRESH_RATE:
 567         return fgState.GameModeRefresh;
 568
 569     case GLUT_GAME_MODE_DISPLAY_CHANGED:
 570         /*
 571          * This is true if the game mode has been activated successfully..
 572          */
 573         return !!fgStructure.GameMode;
 574     }
 575
 576     fgWarning( "Unknown gamemode get: %d", eWhat );
 577     return -1;
 578 }
 579
 580 /*** END OF FILE ***/