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

   1 /*
   2  * freeglut_window.c
   3  *
   4  * Window management methods.
   5  *
   6  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
   7  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
   8  * Creation date: Fri Dec 3 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 #define FREEGLUT_BUILDING_LIB
  29 #include <GL/freeglut.h>
  30 #include "fg_internal.h"
  31 #include "fg_gl2.h"
  32
  33 /*
  34  * TODO BEFORE THE STABLE RELEASE:
  35  *
  36  *  fgSetupPixelFormat      -- ignores the display mode settings
  37  *  fgOpenWindow()          -- check the Win32 version, -iconic handling!
  38  *  fgCloseWindow()         -- check the Win32 version
  39  *  glutCreateWindow()      -- Check when default position and size is {-1,-1}
  40  *  glutCreateSubWindow()   -- Check when default position and size is {-1,-1}
  41  *  glutDestroyWindow()     -- check the Win32 version
  42  *  glutSetWindow()         -- check the Win32 version
  43  *  glutSetWindowTitle()    -- check the Win32 version
  44  *  glutSetIconTitle()      -- check the Win32 version
  45  *  glutShowWindow()        -- check the Win32 version
  46  *  glutHideWindow()        -- check the Win32 version
  47  *  glutIconifyWindow()     -- check the Win32 version
  48  *  glutPushWindow()        -- check the Win32 version
  49  *  glutPopWindow()         -- check the Win32 version
  50  */
  51
  52
  53 extern void fgPlatformSetWindow ( SFG_Window *window );
  54 extern void fgPlatformOpenWindow( SFG_Window* window, const char* title,
  55                                   GLboolean positionUse, int x, int y,
  56                                   GLboolean sizeUse, int w, int h,
  57                                   GLboolean gameMode, GLboolean isSubWindow );
  58 extern void fgPlatformCloseWindow( SFG_Window* window );
  59 extern void fgPlatformGlutShowWindow( void );
  60 extern void fgPlatformGlutHideWindow( void );
  61 extern void fgPlatformGlutIconifyWindow( void );
  62 extern void fgPlatformGlutSetWindowTitle( const char* title );
  63 extern void fgPlatformGlutSetIconTitle( const char* title );
  64 extern void fgPlatformGlutPositionWindow( int x, int y );
  65 extern void fgPlatformGlutPushWindow( void );
  66 extern void fgPlatformGlutPopWindow( void );
  67 extern void fgPlatformGlutFullScreen( SFG_Window *win );
  68 extern void fgPlatformGlutLeaveFullScreen( SFG_Window *win );
  69 extern void fgPlatformGlutFullScreenToggle( SFG_Window *win );
  70
  71
  72 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
  73
  74 int fghIsLegacyContextRequested( void )
  75 {
  76     return fgState.MajorVersion < 2 || (fgState.MajorVersion == 2 && fgState.MinorVersion <= 1);
  77 }
  78
  79 int fghNumberOfAuxBuffersRequested( void )
  80 {
  81   if ( fgState.DisplayMode & GLUT_AUX4 ) {
  82     return 4;
  83   }
  84   if ( fgState.DisplayMode & GLUT_AUX3 ) {
  85     return 3;
  86   }
  87   if ( fgState.DisplayMode & GLUT_AUX2 ) {
  88     return 2;
  89   }
  90   if ( fgState.DisplayMode & GLUT_AUX1 ) { /* NOTE: Same as GLUT_AUX! */
  91     return fgState.AuxiliaryBufferNumber;
  92   }
  93   return 0;
  94 }
  95
  96 int fghMapBit( int mask, int from, int to )
  97 {
  98   return ( mask & from ) ? to : 0;
  99
 100 }
 101
 102 void fghContextCreationError( void )
 103 {
 104     fgError( "Unable to create OpenGL %d.%d context (flags %x, profile %x)",
 105              fgState.MajorVersion, fgState.MinorVersion, fgState.ContextFlags,
 106              fgState.ContextProfile );
 107 }
 108
 109
 110 /* -- SYSTEM-DEPENDENT PRIVATE FUNCTIONS ------------------------------------ */
 111
 112 /*
 113  * Sets the OpenGL context and the fgStructure "Current Window" pointer to
 114  * the window structure passed in.
 115  */
 116 void fgSetWindow ( SFG_Window *window )
 117 {
 118         fgPlatformSetWindow ( window );
 119
 120     fgStructure.CurrentWindow = window;
 121 }
 122
 123 /*
 124  * Opens a window. Requires a SFG_Window object created and attached
 125  * to the freeglut structure. OpenGL context is created here.
 126  */
 127 void fgOpenWindow( SFG_Window* window, const char* title,
 128                    GLboolean positionUse, int x, int y,
 129                    GLboolean sizeUse, int w, int h,
 130                    GLboolean gameMode, GLboolean isSubWindow )
 131 {
 132         fgPlatformOpenWindow( window, title,
 133                    positionUse, x, y,
 134                    sizeUse, w, h,
 135                    gameMode, isSubWindow );
 136
 137     fgSetWindow( window );
 138
 139     window->Window.DoubleBuffered =
 140         ( fgState.DisplayMode & GLUT_DOUBLE ) ? 1 : 0;
 141
 142 #ifndef EGL_VERSION_1_0  /* No glDrawBuffer/glReadBuffer in GLES */
 143     if ( ! window->Window.DoubleBuffered )
 144     {
 145         glDrawBuffer ( GL_FRONT );
 146         glReadBuffer ( GL_FRONT );
 147     }
 148 #endif
 149     window->Window.attribute_v_coord = -1;
 150     window->Window.attribute_v_normal = -1;
 151
 152     fgInitGL2();
 153
 154     window->State.NeedToInitContext = GL_TRUE;
 155 }
 156
 157 /*
 158  * Closes a window, destroying the frame and OpenGL context
 159  */
 160 void fgCloseWindow( SFG_Window* window )
 161 {
 162     /* if we're in gamemode and we're closing the gamemode window,
 163      * call glutLeaveGameMode first to make sure the gamemode is
 164      * properly closed before closing the window
 165      */
 166     if (fgStructure.GameModeWindow != NULL && fgStructure.GameModeWindow->ID==window->ID)
 167         glutLeaveGameMode();
 168
 169         fgPlatformCloseWindow ( window );
 170 }
 171
 172
 173 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
 174
 175 /*
 176  * Creates a new top-level freeglut window
 177  */
 178 int FGAPIENTRY glutCreateWindow( const char* title )
 179 {
 180     /* XXX GLUT does not exit; it simply calls "glutInit" quietly if the
 181      * XXX application has not already done so.  The "freeglut" community
 182      * XXX decided not to go this route (freeglut-developer e-mail from
 183      * XXX Steve Baker, 12/16/04, 4:22 PM CST, "Re: [Freeglut-developer]
 184      * XXX Desired 'freeglut' behaviour when there is no current window"
 185      */
 186     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateWindow" );
 187
 188     return fgCreateWindow( NULL, title, fgState.Position.Use,
 189                            fgState.Position.X, fgState.Position.Y,
 190                            fgState.Size.Use, fgState.Size.X, fgState.Size.Y,
 191                            GL_FALSE, GL_FALSE )->ID;
 192 }
 193
 194 /*
 195  * This function creates a sub window.
 196  */
 197 int FGAPIENTRY glutCreateSubWindow( int parentID, int x, int y, int w, int h )
 198 {
 199     int ret = 0;
 200     SFG_Window* window = NULL;
 201     SFG_Window* parent = NULL;
 202
 203     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateSubWindow" );
 204     parent = fgWindowByID( parentID );
 205     freeglut_return_val_if_fail( parent != NULL, 0 );
 206     if ( x < 0 )
 207     {
 208         x = parent->State.Width + x ;
 209         if ( w >= 0 ) x -= w ;
 210     }
 211
 212     if ( w < 0 ) w = parent->State.Width - x + w ;
 213     if ( w < 0 )
 214     {
 215         x += w ;
 216         w = -w ;
 217     }
 218
 219     if ( y < 0 )
 220     {
 221         y = parent->State.Height + y ;
 222         if ( h >= 0 ) y -= h ;
 223     }
 224
 225     if ( h < 0 ) h = parent->State.Height - y + h ;
 226     if ( h < 0 )
 227     {
 228         y += h ;
 229         h = -h ;
 230     }
 231
 232     window = fgCreateWindow( parent, "", GL_TRUE, x, y, GL_TRUE, w, h, GL_FALSE, GL_FALSE );
 233     ret = window->ID;
 234
 235     return ret;
 236 }
 237
 238 /*
 239  * Destroys a window and all of its subwindows
 240  */
 241 void FGAPIENTRY glutDestroyWindow( int windowID )
 242 {
 243     SFG_Window* window;
 244     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDestroyWindow" );
 245     window = fgWindowByID( windowID );
 246     freeglut_return_if_fail( window != NULL );
 247     {
 248         fgExecutionState ExecState = fgState.ExecState;
 249         fgAddToWindowDestroyList( window );
 250         fgState.ExecState = ExecState;
 251     }
 252 }
 253
 254 /*
 255  * This function selects the specified window as the current window
 256  */
 257 void FGAPIENTRY glutSetWindow( int ID )
 258 {
 259     SFG_Window* window = NULL;
 260
 261     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindow" );
 262     if( fgStructure.CurrentWindow != NULL )
 263         if( fgStructure.CurrentWindow->ID == ID )
 264             return;
 265
 266     window = fgWindowByID( ID );
 267     if( window == NULL )
 268     {
 269         fgWarning( "glutSetWindow(): window ID %d not found!", ID );
 270         return;
 271     }
 272
 273     fgSetWindow( window );
 274 }
 275
 276 /*
 277  * This function returns the ID number of the current window, 0 if none exists
 278  */
 279 int FGAPIENTRY glutGetWindow( void )
 280 {
 281     SFG_Window *win = fgStructure.CurrentWindow;
 282     /*
 283      * Since GLUT did not throw an error if this function was called without a prior call to
 284      * "glutInit", this function shouldn't do so here.  Instead let us return a zero.
 285      * See Feature Request "[ 1307049 ] glutInit check".
 286      */
 287     if ( ! fgState.Initialised )
 288         return 0;
 289
 290     while ( win && win->IsMenu )
 291         win = win->Parent;
 292     return win ? win->ID : 0;
 293 }
 294
 295 /*
 296  * This function makes the current window visible
 297  */
 298 void FGAPIENTRY glutShowWindow( void )
 299 {
 300     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutShowWindow" );
 301     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutShowWindow" );
 302
 303         fgPlatformGlutShowWindow ();
 304
 305     fgStructure.CurrentWindow->State.Redisplay = GL_TRUE;
 306 }
 307
 308 /*
 309  * This function hides the current window
 310  */
 311 void FGAPIENTRY glutHideWindow( void )
 312 {
 313     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutHideWindow" );
 314     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutHideWindow" );
 315
 316         fgPlatformGlutHideWindow ();
 317
 318     fgStructure.CurrentWindow->State.Redisplay = GL_FALSE;
 319 }
 320
 321 /*
 322  * Iconify the current window (top-level windows only)
 323  */
 324 void FGAPIENTRY glutIconifyWindow( void )
 325 {
 326     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutIconifyWindow" );
 327     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutIconifyWindow" );
 328
 329         fgPlatformGlutIconifyWindow ();
 330
 331     fgStructure.CurrentWindow->State.Redisplay = GL_FALSE;
 332 }
 333
 334 /*
 335  * Set the current window's title
 336  */
 337 void FGAPIENTRY glutSetWindowTitle( const char* title )
 338 {
 339     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowTitle" );
 340     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowTitle" );
 341     if( ! fgStructure.CurrentWindow->Parent )
 342     {
 343                 fgPlatformGlutSetWindowTitle ( title );
 344     }
 345 }
 346
 347 /*
 348  * Set the current window's iconified title
 349  */
 350 void FGAPIENTRY glutSetIconTitle( const char* title )
 351 {
 352     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetIconTitle" );
 353     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetIconTitle" );
 354
 355     if( ! fgStructure.CurrentWindow->Parent )
 356     {
 357                 fgPlatformGlutSetIconTitle ( title );
 358     }
 359 }
 360
 361 /*
 362  * Change the current window's size
 363  */
 364 void FGAPIENTRY glutReshapeWindow( int width, int height )
 365 {
 366     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutReshapeWindow" );
 367     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutReshapeWindow" );
 368
 369     if (glutGet(GLUT_FULL_SCREEN))
 370     {
 371       /*  Leave full screen state before resizing. */
 372       glutLeaveFullScreen();
 373     }
 374
 375     fgStructure.CurrentWindow->State.NeedToResize = GL_TRUE;
 376     fgStructure.CurrentWindow->State.Width  = width ;
 377     fgStructure.CurrentWindow->State.Height = height;
 378 }
 379
 380 /*
 381  * Change the current window's position
 382  */
 383 void FGAPIENTRY glutPositionWindow( int x, int y )
 384 {
 385     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPositionWindow" );
 386     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPositionWindow" );
 387
 388     if (glutGet(GLUT_FULL_SCREEN))
 389     {
 390       /*  Leave full screen state before moving. */
 391       glutLeaveFullScreen();
 392     }
 393
 394         fgPlatformGlutPositionWindow ( x, y );
 395 }
 396
 397 /*
 398  * Lowers the current window (by Z order change)
 399  */
 400 void FGAPIENTRY glutPushWindow( void )
 401 {
 402     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPushWindow" );
 403     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPushWindow" );
 404
 405         fgPlatformGlutPushWindow ();
 406 }
 407
 408 /*
 409  * Raises the current window (by Z order change)
 410  */
 411 void FGAPIENTRY glutPopWindow( void )
 412 {
 413     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPopWindow" );
 414     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPopWindow" );
 415
 416         fgPlatformGlutPopWindow ();
 417 }
 418
 419 /*
 420  * Resize the current window so that it fits the whole screen
 421  */
 422 void FGAPIENTRY glutFullScreen( void )
 423 {
 424     SFG_Window *win;
 425
 426     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreen" );
 427     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreen" );
 428
 429     win = fgStructure.CurrentWindow;
 430
 431     if (win->Parent)
 432     {
 433         /* Child windows cannot be made fullscreen, consistent with GLUT's behavior
 434          * Also, what would it mean for a child window to be fullscreen, given that it
 435          * is confined to its parent?
 436          */
 437         fgWarning("glutFullScreen called on a child window, ignoring...");
 438         return;
 439     }
 440     else if (fgStructure.GameModeWindow != NULL && fgStructure.GameModeWindow->ID==win->ID && win->State.IsFullscreen)
 441     {
 442         /* Ignore fullscreen call on GameMode window, those are always fullscreen already
 443          * only exception is during first entering GameMode
 444          */
 445         return;
 446     }
 447
 448         fgPlatformGlutFullScreen ( win );
 449 }
 450
 451 /*
 452  * If we are fullscreen, resize the current window back to its original size
 453  */
 454 void FGAPIENTRY glutLeaveFullScreen( void )
 455 {
 456     SFG_Window *win;
 457
 458     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreen" );
 459     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreen" );
 460
 461     win = fgStructure.CurrentWindow;
 462
 463         fgPlatformGlutLeaveFullScreen ( win );
 464 }
 465
 466 /*
 467  * Toggle the window's full screen state.
 468  */
 469 void FGAPIENTRY glutFullScreenToggle( void )
 470 {
 471     SFG_Window *win;
 472
 473     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreenToggle" );
 474     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreenToggle" );
 475
 476     win = fgStructure.CurrentWindow;
 477
 478         fgPlatformGlutFullScreenToggle ( win );
 479 }
 480
 481 /*
 482  * A.Donev: Set and retrieve the window's user data
 483  */
 484 void* FGAPIENTRY glutGetWindowData( void )
 485 {
 486     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetWindowData" );
 487     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutGetWindowData" );
 488     return fgStructure.CurrentWindow->UserData;
 489 }
 490
 491 void FGAPIENTRY glutSetWindowData(void* data)
 492 {
 493     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowData" );
 494     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowData" );
 495     fgStructure.CurrentWindow->UserData = data;
 496 }
 497
 498 /*** END OF FILE ***/