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_POSIX_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_MS_WINDOWS
 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_POSIX_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_MS_WINDOWS
 206
 207     /* Restore the previously rememebered desktop display settings */
 208     ChangeDisplaySettings( &fgDisplay.DisplayMode, 0 );
 209
 210 #endif
 211 }
 212
 213 #if TARGET_HOST_POSIX_X11
 214 #ifdef X_XF86VidModeGetAllModeLines
 215
 216 /*
 217  * Checks a single display mode settings against user's preferences.
 218  */
 219 static GLboolean fghCheckDisplayMode( int width, int height, int depth, int refresh )
 220 {
 221     /* The desired values should be stored in fgState structure... */
 222     return ( width == fgState.GameModeSize.X ) &&
 223            ( height == fgState.GameModeSize.Y ) &&
 224            ( depth == fgState.GameModeDepth ) &&
 225            ( refresh == fgState.GameModeRefresh );
 226 }
 227
 228 /*
 229  * Checks all display modes settings against user's preferences.
 230  * Returns the mode number found or -1 if none could be found.
 231  */
 232 static int fghCheckDisplayModes( GLboolean exactMatch, int displayModesCount, XF86VidModeModeInfo** displayModes )
 233 {
 234     int i;
 235     for( i = 0; i < displayModesCount; i++ )
 236     {
 237         /* Compute the displays refresh rate, dotclock comes in kHz. */
 238         int refresh = ( displayModes[ i ]->dotclock * 1000 ) /
 239                       ( displayModes[ i ]->htotal * displayModes[ i ]->vtotal );
 240
 241         if( fghCheckDisplayMode( displayModes[ i ]->hdisplay,
 242                                  displayModes[ i ]->vdisplay,
 243                                  fgState.GameModeDepth,
 244                                  ( exactMatch ? refresh : fgState.GameModeRefresh ) ) ) {
 245             return i;
 246         }
 247     }
 248     return -1;
 249 }
 250
 251 #endif
 252 #endif
 253
 254 /*
 255  * Changes the current display mode to match user's settings
 256  */
 257 static GLboolean fghChangeDisplayMode( GLboolean haveToTest )
 258 {
 259     GLboolean success = GL_FALSE;
 260 #if TARGET_HOST_POSIX_X11
 261
 262     /*
 263      * This highly depends on the XFree86 extensions,
 264      * not approved as X Consortium standards
 265      */
 266 #   ifdef X_XF86VidModeGetAllModeLines
 267
 268     /*
 269      * This is also used by applcations which check modes by calling
 270      * glutGameModeGet(GLUT_GAME_MODE_POSSIBLE), so allow the check:
 271      */
 272     if( haveToTest || fgDisplay.DisplayModeValid )
 273     {
 274         XF86VidModeModeInfo** displayModes;
 275         int i, displayModesCount;
 276
 277         if( !XF86VidModeGetAllModeLines(
 278                  fgDisplay.Display,
 279                  fgDisplay.Screen,
 280                  &displayModesCount,
 281                  &displayModes ) )
 282         {
 283             fgWarning( "XF86VidModeGetAllModeLines failed" );
 284             return success;
 285         }
 286
 287
 288         /*
 289          * Check every of the modes looking for one that matches our demands,
 290          * ignoring the refresh rate if no exact match could be found.
 291          */
 292         i = fghCheckDisplayModes( GL_TRUE, displayModesCount, displayModes );
 293         if( i < 0 ) {
 294             i = fghCheckDisplayModes( GL_FALSE, displayModesCount, displayModes );
 295         }
 296         success = ( i < 0 ) ? GL_FALSE : GL_TRUE;
 297
 298         if( !haveToTest && success ) {
 299             if( !XF86VidModeSwitchToMode(
 300                      fgDisplay.Display,
 301                      fgDisplay.Screen,
 302                      displayModes[ i ] ) )
 303                 fgWarning( "XF86VidModeSwitchToMode failed" );
 304         }
 305
 306         XFree( displayModes );
 307     }
 308
 309 #   else
 310
 311     /*
 312      * XXX warning fghChangeDisplayMode: missing XFree86 video mode extensions,
 313      * XXX game mode will not change screen resolution when activated
 314      */
 315     success = GL_TRUE;
 316
 317 #   endif
 318
 319 #elif TARGET_HOST_MS_WINDOWS
 320
 321     DEVMODE  devMode;
 322     char *fggmstr = NULL;
 323
 324     success = GL_FALSE;
 325
 326     EnumDisplaySettings( NULL, -1, &devMode );
 327     devMode.dmFields |= DM_PELSWIDTH | DM_PELSHEIGHT | DM_BITSPERPEL | DM_DISPLAYFREQUENCY;
 328
 329     devMode.dmPelsWidth  = fgState.GameModeSize.X;
 330     devMode.dmPelsHeight = fgState.GameModeSize.Y;
 331     devMode.dmBitsPerPel = fgState.GameModeDepth;
 332     devMode.dmDisplayFrequency = fgState.GameModeRefresh;
 333     devMode.dmFields = DM_PELSWIDTH | DM_PELSHEIGHT | DM_BITSPERPEL | DM_DISPLAYFREQUENCY;
 334
 335     switch ( ChangeDisplaySettingsEx(NULL, &devMode, NULL, haveToTest ? CDS_TEST : CDS_FULLSCREEN , NULL) )
 336     {
 337     case DISP_CHANGE_SUCCESSFUL:
 338         success = GL_TRUE;
 339
 340         /* update vars in case if windows switched to proper mode */
 341         EnumDisplaySettings( NULL, FREEGLUT_ENUM_CURRENT_SETTINGS, &devMode );
 342         fgState.GameModeSize.X  = devMode.dmPelsWidth;
 343         fgState.GameModeSize.Y  = devMode.dmPelsHeight;
 344         fgState.GameModeDepth   = devMode.dmBitsPerPel;
 345         fgState.GameModeRefresh = devMode.dmDisplayFrequency;
 346                 break;
 347     case DISP_CHANGE_RESTART:
 348         fggmstr = "The computer must be restarted for the graphics mode to work.";
 349         break;
 350     case DISP_CHANGE_BADFLAGS:
 351         fggmstr = "An invalid set of flags was passed in.";
 352         break;
 353     case DISP_CHANGE_BADPARAM:
 354         fggmstr = "An invalid parameter was passed in. This can include an invalid flag or combination of flags.";
 355         break;
 356     case DISP_CHANGE_FAILED:
 357         fggmstr = "The display driver failed the specified graphics mode.";
 358         break;
 359     case DISP_CHANGE_BADMODE:
 360         fggmstr = "The graphics mode is not supported.";
 361         break;
 362     default:
 363         fggmstr = "Unknown error in graphics mode???"; /* dunno if it is possible,MSDN does not mention any other error */
 364         break;
 365     }
 366
 367     if ( !success )
 368         fgWarning(fggmstr); /* I'd rather get info whats going on in my program than wonder about */
 369                             /* magic happenings behind my back, its lib for devels at last ;) */
 370 #endif
 371
 372     return success;
 373 }
 374
 375
 376 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
 377
 378 /*
 379  * Sets the game mode display string
 380  */
 381 void FGAPIENTRY glutGameModeString( const char* string )
 382 {
 383     int width = 640, height = 480, depth = 16, refresh = 72;
 384
 385     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGameModeString" );
 386
 387     /*
 388      * This one seems a bit easier than glutInitDisplayString. The bad thing
 389      * about it that I was unable to find the game mode string definition, so
 390      * that I assumed it is: "[width]x[height]:[depth]@[refresh rate]", which
 391      * appears in all GLUT game mode programs I have seen to date.
 392      */
 393     if( sscanf( string, "%ix%i:%i@%i", &width, &height, &depth, &refresh ) !=
 394         4 )
 395         if( sscanf( string, "%ix%i:%i", &width, &height, &depth ) != 3 )
 396             if( sscanf( string, "%ix%i@%i", &width, &height, &refresh ) != 3 )
 397                 if( sscanf( string, "%ix%i", &width, &height ) != 2 )
 398                     if( sscanf( string, ":%i@%i", &depth, &refresh ) != 2 )
 399                         if( sscanf( string, ":%i", &depth ) != 1 )
 400                             if( sscanf( string, "@%i", &refresh ) != 1 )
 401                                 fgWarning(
 402                                     "unable to parse game mode string `%s'",
 403                                     string
 404                                 );
 405
 406     /* Hopefully it worked, and if not, we still have the default values */
 407     fgState.GameModeSize.X  = width;
 408     fgState.GameModeSize.Y  = height;
 409     fgState.GameModeDepth   = depth;
 410     fgState.GameModeRefresh = refresh;
 411 }
 412
 413 /*
 414  * Enters the game mode
 415  */
 416 int FGAPIENTRY glutEnterGameMode( void )
 417 {
 418     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutEnterGameMode" );
 419
 420     if( fgStructure.GameModeWindow )
 421         fgAddToWindowDestroyList( fgStructure.GameModeWindow );
 422     else
 423         fghRememberState( );
 424
 425     if( ! fghChangeDisplayMode( GL_FALSE ) )
 426     {
 427         fgWarning( "failed to change screen settings" );
 428         return 0;
 429     }
 430
 431     fgStructure.GameModeWindow = fgCreateWindow(
 432         NULL, "FREEGLUT", 0, 0,
 433         fgState.GameModeSize.X, fgState.GameModeSize.Y, GL_TRUE, GL_FALSE
 434     );
 435
 436     fgStructure.GameModeWindow->State.Width  = fgState.GameModeSize.X;
 437     fgStructure.GameModeWindow->State.Height = fgState.GameModeSize.Y;
 438     fgStructure.GameModeWindow->State.NeedToResize = GL_TRUE;
 439
 440 #if TARGET_HOST_POSIX_X11
 441
 442     /*
 443      * Sync needed to avoid a real race, the Xserver must have really created
 444      * the window before we can grab the pointer into it:
 445      */
 446     XSync( fgDisplay.Display, False );
 447
 448     /*
 449      * Grab the pointer to confine it into the window after the calls to
 450      * XWrapPointer() which ensure that the pointer really enters the window.
 451      *
 452      * We also need to wait here until XGrabPointer() returns GrabSuccess,
 453      * otherwise the new window is not viewable yet and if the next function
 454      * (XSetInputFocus) is called with a not yet viewable window, it will exit
 455      * the application which we have to aviod, so wait until it's viewable:
 456      */
 457     while( GrabSuccess != XGrabPointer(
 458                fgDisplay.Display, fgStructure.GameModeWindow->Window.Handle,
 459                TRUE,
 460                ButtonPressMask | ButtonReleaseMask | ButtonMotionMask
 461                | PointerMotionMask,
 462                GrabModeAsync, GrabModeAsync,
 463                fgStructure.GameModeWindow->Window.Handle, None, CurrentTime) )
 464         usleep( 100 );
 465
 466     /*
 467      * Change input focus to the new window. This will exit the application
 468      * if the new window is not viewable yet, see the XGrabPointer loop above.
 469      */
 470     XSetInputFocus(
 471         fgDisplay.Display,
 472         fgStructure.GameModeWindow->Window.Handle,
 473         RevertToNone,
 474         CurrentTime
 475     );
 476
 477     /* Move the Pointer to the middle of the fullscreen window */
 478     XWarpPointer(
 479         fgDisplay.Display,
 480         None,
 481         fgDisplay.RootWindow,
 482         0, 0, 0, 0,
 483         fgState.GameModeSize.X/2, fgState.GameModeSize.Y/2
 484     );
 485
 486 #   ifdef X_XF86VidModeSetViewPort
 487
 488     if( fgDisplay.DisplayModeValid )
 489     {
 490         int x, y;
 491         Window child;
 492
 493         /* Change to viewport to the window topleft edge: */
 494         if( !XF86VidModeSetViewPort( fgDisplay.Display, fgDisplay.Screen, 0, 0 ) )
 495             fgWarning( "XF86VidModeSetViewPort failed" );
 496
 497         /*
 498          * Final window repositioning: It could be avoided using an undecorated
 499          * window using override_redirect, but this * would possily require
 500          * more changes and investigation.
 501          */
 502
 503         /* Get the current postion of the drawable area on screen */
 504         XTranslateCoordinates(
 505             fgDisplay.Display,
 506             fgStructure.CurrentWindow->Window.Handle,
 507             fgDisplay.RootWindow,
 508             0, 0, &x, &y,
 509             &child
 510         );
 511
 512         /* Move the decorataions out of the topleft corner of the display */
 513         XMoveWindow( fgDisplay.Display, fgStructure.CurrentWindow->Window.Handle,
 514                      -x, -y);
 515     }
 516
 517 #endif
 518
 519     /* Grab the keyboard, too */
 520     XGrabKeyboard(
 521         fgDisplay.Display,
 522         fgStructure.GameModeWindow->Window.Handle,
 523         FALSE,
 524         GrabModeAsync, GrabModeAsync,
 525         CurrentTime
 526     );
 527
 528 #endif
 529
 530     return fgStructure.GameModeWindow->ID;
 531 }
 532
 533 /*
 534  * Leaves the game mode
 535  */
 536 void FGAPIENTRY glutLeaveGameMode( void )
 537 {
 538     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutLeaveGameMode" );
 539
 540     freeglut_return_if_fail( fgStructure.GameModeWindow );
 541
 542     fgAddToWindowDestroyList( fgStructure.GameModeWindow );
 543     fgStructure.GameModeWindow = NULL;
 544
 545 #if TARGET_HOST_POSIX_X11
 546
 547     XUngrabPointer( fgDisplay.Display, CurrentTime );
 548     XUngrabKeyboard( fgDisplay.Display, CurrentTime );
 549
 550 #endif
 551
 552     fghRestoreState();
 553 }
 554
 555 /*
 556  * Returns information concerning the freeglut game mode
 557  */
 558 int FGAPIENTRY glutGameModeGet( GLenum eWhat )
 559 {
 560     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGameModeGet" );
 561
 562     switch( eWhat )
 563     {
 564     case GLUT_GAME_MODE_ACTIVE:
 565         return !!fgStructure.GameModeWindow;
 566
 567     case GLUT_GAME_MODE_POSSIBLE:
 568         return fghChangeDisplayMode( GL_TRUE );
 569
 570     case GLUT_GAME_MODE_WIDTH:
 571         return fgState.GameModeSize.X;
 572
 573     case GLUT_GAME_MODE_HEIGHT:
 574         return fgState.GameModeSize.Y;
 575
 576     case GLUT_GAME_MODE_PIXEL_DEPTH:
 577         return fgState.GameModeDepth;
 578
 579     case GLUT_GAME_MODE_REFRESH_RATE:
 580         return fgState.GameModeRefresh;
 581
 582     case GLUT_GAME_MODE_DISPLAY_CHANGED:
 583         /*
 584          * This is true if the game mode has been activated successfully..
 585          */
 586         return !!fgStructure.GameModeWindow;
 587     }
 588
 589     fgWarning( "Unknown gamemode get: %d", eWhat );
 590     return -1;
 591 }
 592
 593 /*** END OF FILE ***/