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
  32 /*
  33  * TODO BEFORE THE STABLE RELEASE:
  34  *
  35  *  fgSetupPixelFormat      -- ignores the display mode settings
  36  *  fgOpenWindow()          -- check the Win32 version, -iconic handling!
  37  *  fgCloseWindow()         -- check the Win32 version
  38  *  glutCreateWindow()      -- Check when default position and size is {-1,-1}
  39  *  glutCreateSubWindow()   -- Check when default position and size is {-1,-1}
  40  *  glutDestroyWindow()     -- check the Win32 version
  41  *  glutSetWindow()         -- check the Win32 version
  42  *  glutSetWindowTitle()    -- check the Win32 version
  43  *  glutSetIconTitle()      -- check the Win32 version
  44  *  glutShowWindow()        -- check the Win32 version
  45  *  glutHideWindow()        -- check the Win32 version
  46  *  glutIconifyWindow()     -- check the Win32 version
  47  *  glutPushWindow()        -- check the Win32 version
  48  *  glutPopWindow()         -- check the Win32 version
  49  */
  50
  51
  52 extern void fgPlatformSetWindow ( SFG_Window *window );
  53 extern void fgPlatformOpenWindow( SFG_Window* window, const char* title,
  54                                   GLboolean positionUse, int x, int y,
  55                                   GLboolean sizeUse, int w, int h,
  56                                   GLboolean gameMode, GLboolean isSubWindow );
  57 extern void fgPlatformCloseWindow( SFG_Window* window );
  58 extern void fgPlatformGlutShowWindow( void );
  59 extern void fgPlatformGlutHideWindow( void );
  60 extern void fgPlatformGlutIconifyWindow( void );
  61 extern void fgPlatformGlutSetWindowTitle( const char* title );
  62 extern void fgPlatformGlutSetIconTitle( const char* title );
  63 extern void fgPlatformGlutPositionWindow( int x, int y );
  64 extern void fgPlatformGlutPushWindow( void );
  65 extern void fgPlatformGlutPopWindow( void );
  66 extern void fgPlatformGlutFullScreen( SFG_Window *win );
  67 extern void fgPlatformGlutLeaveFullScreen( SFG_Window *win );
  68 extern void fgPlatformGlutFullScreenToggle( SFG_Window *win );
  69
  70
  71 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
  72
  73 int fghIsLegacyContextVersionRequested( void )
  74 {
  75   return fgState.MajorVersion < 2 || (fgState.MajorVersion == 2 && fgState.MinorVersion <= 1);
  76 }
  77
  78 int fghIsLegacyContextRequested( void )
  79 {
  80   return fghIsLegacyContextVersionRequested() &&
  81          fgState.ContextFlags == 0 &&
  82          fgState.ContextProfile == 0;
  83 }
  84
  85 int fghNumberOfAuxBuffersRequested( void )
  86 {
  87   if ( fgState.DisplayMode & GLUT_AUX4 ) {
  88     return 4;
  89   }
  90   if ( fgState.DisplayMode & GLUT_AUX3 ) {
  91     return 3;
  92   }
  93   if ( fgState.DisplayMode & GLUT_AUX2 ) {
  94     return 2;
  95   }
  96   if ( fgState.DisplayMode & GLUT_AUX1 ) { /* NOTE: Same as GLUT_AUX! */
  97     return fgState.AuxiliaryBufferNumber;
  98   }
  99   return 0;
 100 }
 101
 102 int fghMapBit( int mask, int from, int to )
 103 {
 104   return ( mask & from ) ? to : 0;
 105
 106 }
 107
 108 void fghContextCreationError( void )
 109 {
 110     fgError( "Unable to create OpenGL %d.%d context (flags %x, profile %x)",
 111              fgState.MajorVersion, fgState.MinorVersion, fgState.ContextFlags,
 112              fgState.ContextProfile );
 113 }
 114
 115
 116 /* -- SYSTEM-DEPENDENT PRIVATE FUNCTIONS ------------------------------------ */
 117
 118 /*
 119  * Sets the OpenGL context and the fgStructure "Current Window" pointer to
 120  * the window structure passed in.
 121  */
 122 void fgSetWindow ( SFG_Window *window )
 123 {
 124         fgPlatformSetWindow ( window );
 125
 126     fgStructure.CurrentWindow = window;
 127 }
 128
 129 /*
 130  * Opens a window. Requires a SFG_Window object created and attached
 131  * to the freeglut structure. OpenGL context is created here.
 132  */
 133 void fgOpenWindow( SFG_Window* window, const char* title,
 134                    GLboolean positionUse, int x, int y,
 135                    GLboolean sizeUse, int w, int h,
 136                    GLboolean gameMode, GLboolean isSubWindow )
 137 {
 138         fgPlatformOpenWindow( window, title,
 139                    positionUse, x, y,
 140                    sizeUse, w, h,
 141                    gameMode, isSubWindow );
 142
 143     fgSetWindow( window );
 144
 145     window->Window.DoubleBuffered =
 146         ( fgState.DisplayMode & GLUT_DOUBLE ) ? 1 : 0;
 147
 148 #ifndef EGL_VERSION_1_0  /* No glDrawBuffer/glReadBuffer in GLES */
 149     if ( ! window->Window.DoubleBuffered )
 150     {
 151         glDrawBuffer ( GL_FRONT );
 152         glReadBuffer ( GL_FRONT );
 153     }
 154 #endif
 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     fgStructure.CurrentWindow->State.Visible   = GL_FALSE;
 330
 331         fgPlatformGlutIconifyWindow ();
 332
 333     fgStructure.CurrentWindow->State.Redisplay = GL_FALSE;
 334 }
 335
 336 /*
 337  * Set the current window's title
 338  */
 339 void FGAPIENTRY glutSetWindowTitle( const char* title )
 340 {
 341     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowTitle" );
 342     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowTitle" );
 343     if( ! fgStructure.CurrentWindow->Parent )
 344     {
 345                 fgPlatformGlutSetWindowTitle ( title );
 346     }
 347 }
 348
 349 /*
 350  * Set the current window's iconified title
 351  */
 352 void FGAPIENTRY glutSetIconTitle( const char* title )
 353 {
 354     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetIconTitle" );
 355     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetIconTitle" );
 356
 357     if( ! fgStructure.CurrentWindow->Parent )
 358     {
 359                 fgPlatformGlutSetIconTitle ( title );
 360     }
 361 }
 362
 363 /*
 364  * Change the current window's size
 365  */
 366 void FGAPIENTRY glutReshapeWindow( int width, int height )
 367 {
 368     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutReshapeWindow" );
 369     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutReshapeWindow" );
 370
 371     if (glutGet(GLUT_FULL_SCREEN))
 372     {
 373       /*  Leave full screen state before resizing. */
 374       glutLeaveFullScreen();
 375     }
 376
 377     fgStructure.CurrentWindow->State.NeedToResize = GL_TRUE;
 378     fgStructure.CurrentWindow->State.Width  = width ;
 379     fgStructure.CurrentWindow->State.Height = height;
 380 }
 381
 382 /*
 383  * Change the current window's position
 384  */
 385 void FGAPIENTRY glutPositionWindow( int x, int y )
 386 {
 387     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPositionWindow" );
 388     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPositionWindow" );
 389
 390     if (glutGet(GLUT_FULL_SCREEN))
 391     {
 392       /*  Leave full screen state before moving. */
 393       glutLeaveFullScreen();
 394     }
 395
 396         fgPlatformGlutPositionWindow ( x, y );
 397 }
 398
 399 /*
 400  * Lowers the current window (by Z order change)
 401  */
 402 void FGAPIENTRY glutPushWindow( void )
 403 {
 404     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPushWindow" );
 405     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPushWindow" );
 406
 407         fgPlatformGlutPushWindow ();
 408 }
 409
 410 /*
 411  * Raises the current window (by Z order change)
 412  */
 413 void FGAPIENTRY glutPopWindow( void )
 414 {
 415     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPopWindow" );
 416     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPopWindow" );
 417
 418         fgPlatformGlutPopWindow ();
 419 }
 420
 421 /*
 422  * Resize the current window so that it fits the whole screen
 423  */
 424 void FGAPIENTRY glutFullScreen( void )
 425 {
 426     SFG_Window *win;
 427
 428     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreen" );
 429     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreen" );
 430
 431     win = fgStructure.CurrentWindow;
 432
 433     if (win->Parent)
 434     {
 435         /* Child windows cannot be made fullscreen, consistent with GLUT's behavior
 436          * Also, what would it mean for a child window to be fullscreen, given that it
 437          * is confined to its parent?
 438          */
 439         fgWarning("glutFullScreen called on a child window, ignoring...");
 440         return;
 441     }
 442     else if (fgStructure.GameModeWindow != NULL && fgStructure.GameModeWindow->ID==win->ID)
 443     {
 444         /* Ignore fullscreen call on GameMode window, those are always fullscreen already */
 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 ***/