4 * Window management methods.
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
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.
28 #define FREEGLUT_BUILDING_LIB
29 #include <GL/freeglut.h>
30 #include "fg_internal.h"
34 * TODO BEFORE THE STABLE RELEASE:
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
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 fgPlatformGlutSetWindowTitle( const char* title );
60 extern void fgPlatformGlutSetIconTitle( const char* title );
63 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
65 int fghIsLegacyContextRequested( void )
67 return fgState.MajorVersion < 2 || (fgState.MajorVersion == 2 && fgState.MinorVersion <= 1);
70 int fghNumberOfAuxBuffersRequested( void )
72 if ( fgState.DisplayMode & GLUT_AUX4 ) {
75 if ( fgState.DisplayMode & GLUT_AUX3 ) {
78 if ( fgState.DisplayMode & GLUT_AUX2 ) {
81 if ( fgState.DisplayMode & GLUT_AUX1 ) { /* NOTE: Same as GLUT_AUX! */
82 return fgState.AuxiliaryBufferNumber;
87 int fghMapBit( int mask, int from, int to )
89 return ( mask & from ) ? to : 0;
93 void fghContextCreationError( void )
95 fgError( "Unable to create OpenGL %d.%d context (flags %x, profile %x)",
96 fgState.MajorVersion, fgState.MinorVersion, fgState.ContextFlags,
97 fgState.ContextProfile );
101 /* -- SYSTEM-DEPENDENT PRIVATE FUNCTIONS ------------------------------------ */
104 * Sets the OpenGL context and the fgStructure "Current Window" pointer to
105 * the window structure passed in.
107 void fgSetWindow ( SFG_Window *window )
109 fgPlatformSetWindow ( window );
111 fgStructure.CurrentWindow = window;
115 * Opens a window. Requires a SFG_Window object created and attached
116 * to the freeglut structure. OpenGL context is created here.
118 void fgOpenWindow( SFG_Window* window, const char* title,
119 GLboolean positionUse, int x, int y,
120 GLboolean sizeUse, int w, int h,
121 GLboolean gameMode, GLboolean isSubWindow )
123 fgPlatformOpenWindow( window, title,
126 gameMode, isSubWindow );
128 fgSetWindow( window );
130 #ifndef EGL_VERSION_1_0
131 window->Window.DoubleBuffered =
132 ( fgState.DisplayMode & GLUT_DOUBLE ) ? 1 : 0;
134 if ( ! window->Window.DoubleBuffered )
136 glDrawBuffer ( GL_FRONT );
137 glReadBuffer ( GL_FRONT );
140 /* - EGL is always double-buffered */
141 /* - No glDrawBuffer/glReadBuffer in GLES */
142 window->Window.DoubleBuffered = 1;
144 window->Window.attribute_v_coord = -1;
145 window->Window.attribute_v_normal = -1;
146 window->Window.attribute_v_texture = -1;
150 window->State.WorkMask |= GLUT_INIT_WORK;
154 * Closes a window, destroying the frame and OpenGL context
156 void fgCloseWindow( SFG_Window* window )
158 /* if we're in gamemode and we're closing the gamemode window,
159 * call glutLeaveGameMode first to make sure the gamemode is
160 * properly closed before closing the window
162 if (fgStructure.GameModeWindow != NULL && fgStructure.GameModeWindow->ID==window->ID)
165 fgPlatformCloseWindow ( window );
169 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
172 * Creates a new top-level freeglut window
174 int FGAPIENTRY glutCreateWindow( const char* title )
176 /* XXX GLUT does not exit; it simply calls "glutInit" quietly if the
177 * XXX application has not already done so. The "freeglut" community
178 * XXX decided not to go this route (freeglut-developer e-mail from
179 * XXX Steve Baker, 12/16/04, 4:22 PM CST, "Re: [Freeglut-developer]
180 * XXX Desired 'freeglut' behaviour when there is no current window"
182 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateWindow" );
184 return fgCreateWindow( NULL, title, fgState.Position.Use,
185 fgState.Position.X, fgState.Position.Y,
186 fgState.Size.Use, fgState.Size.X, fgState.Size.Y,
187 GL_FALSE, GL_FALSE )->ID;
191 * This function creates a sub window.
193 int FGAPIENTRY glutCreateSubWindow( int parentID, int x, int y, int w, int h )
196 SFG_Window* window = NULL;
197 SFG_Window* parent = NULL;
199 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateSubWindow" );
200 parent = fgWindowByID( parentID );
201 freeglut_return_val_if_fail( parent != NULL, 0 );
204 x = parent->State.Width + x ;
205 if ( w >= 0 ) x -= w ;
208 if ( w < 0 ) w = parent->State.Width - x + w ;
217 y = parent->State.Height + y ;
218 if ( h >= 0 ) y -= h ;
221 if ( h < 0 ) h = parent->State.Height - y + h ;
228 window = fgCreateWindow( parent, "", GL_TRUE, x, y, GL_TRUE, w, h, GL_FALSE, GL_FALSE );
235 * Destroys a window and all of its subwindows
237 void FGAPIENTRY glutDestroyWindow( int windowID )
240 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDestroyWindow" );
241 window = fgWindowByID( windowID );
242 freeglut_return_if_fail( window != NULL );
244 fgExecutionState ExecState = fgState.ExecState;
245 fgAddToWindowDestroyList( window );
246 fgState.ExecState = ExecState;
251 * This function selects the specified window as the current window
253 void FGAPIENTRY glutSetWindow( int ID )
255 SFG_Window* window = NULL;
257 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindow" );
258 if( fgStructure.CurrentWindow != NULL )
259 if( fgStructure.CurrentWindow->ID == ID )
262 window = fgWindowByID( ID );
265 fgWarning( "glutSetWindow(): window ID %d not found!", ID );
269 fgSetWindow( window );
273 * This function returns the ID number of the current window, 0 if none exists
275 int FGAPIENTRY glutGetWindow( void )
277 SFG_Window *win = fgStructure.CurrentWindow;
279 * Since GLUT did not throw an error if this function was called without a prior call to
280 * "glutInit", this function shouldn't do so here. Instead let us return a zero.
281 * See Feature Request "[ 1307049 ] glutInit check".
283 if ( ! fgState.Initialised )
286 while ( win && win->IsMenu )
288 return win ? win->ID : 0;
292 * This function makes the current window visible
294 void FGAPIENTRY glutShowWindow( void )
296 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutShowWindow" );
297 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutShowWindow" );
299 fgStructure.CurrentWindow->State.WorkMask |= GLUT_VISIBILITY_WORK;
300 fgStructure.CurrentWindow->State.DesiredVisibility = DesireNormalState;
302 fgStructure.CurrentWindow->State.WorkMask |= GLUT_DISPLAY_WORK;
306 * This function hides the current window
308 void FGAPIENTRY glutHideWindow( void )
310 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutHideWindow" );
311 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutHideWindow" );
313 fgStructure.CurrentWindow->State.WorkMask |= GLUT_VISIBILITY_WORK;
314 fgStructure.CurrentWindow->State.DesiredVisibility = DesireHiddenState;
316 fgStructure.CurrentWindow->State.WorkMask &= ~GLUT_DISPLAY_WORK;
320 * Iconify the current window (top-level windows only)
322 void FGAPIENTRY glutIconifyWindow( void )
324 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutIconifyWindow" );
325 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutIconifyWindow" );
327 fgStructure.CurrentWindow->State.WorkMask |= GLUT_VISIBILITY_WORK;
328 fgStructure.CurrentWindow->State.DesiredVisibility = DesireIconicState;
330 fgStructure.CurrentWindow->State.WorkMask &= ~GLUT_DISPLAY_WORK;
334 * Set the current window's title
336 void FGAPIENTRY glutSetWindowTitle( const char* title )
338 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowTitle" );
339 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowTitle" );
340 if( ! fgStructure.CurrentWindow->Parent )
342 fgPlatformGlutSetWindowTitle ( title );
347 * Set the current window's iconified title
349 void FGAPIENTRY glutSetIconTitle( const char* title )
351 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetIconTitle" );
352 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetIconTitle" );
354 if( ! fgStructure.CurrentWindow->Parent )
356 fgPlatformGlutSetIconTitle ( title );
361 * Change the current window's size
363 void FGAPIENTRY glutReshapeWindow( int width, int height )
365 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutReshapeWindow" );
366 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutReshapeWindow" );
368 if (glutGet(GLUT_FULL_SCREEN))
370 /* Leave full screen state before resizing. */
371 glutLeaveFullScreen();
374 fgStructure.CurrentWindow->State.WorkMask |= GLUT_SIZE_WORK;
375 fgStructure.CurrentWindow->State.DesiredWidth = width ;
376 fgStructure.CurrentWindow->State.DesiredHeight = height;
380 * Change the current window's position
382 void FGAPIENTRY glutPositionWindow( int x, int y )
384 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPositionWindow" );
385 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPositionWindow" );
387 if (glutGet(GLUT_FULL_SCREEN))
389 /* Leave full screen state before moving. */
390 glutLeaveFullScreen();
393 fgStructure.CurrentWindow->State.WorkMask |= GLUT_POSITION_WORK;
394 fgStructure.CurrentWindow->State.DesiredXpos = x;
395 fgStructure.CurrentWindow->State.DesiredYpos = y;
399 * Lowers the current window (by Z order change)
401 void FGAPIENTRY glutPushWindow( void )
403 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPushWindow" );
404 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPushWindow" );
406 fgStructure.CurrentWindow->State.WorkMask |= GLUT_ZORDER_WORK;
407 fgStructure.CurrentWindow->State.DesiredZOrder = -1;
411 * Raises the current window (by Z order change)
413 void FGAPIENTRY glutPopWindow( void )
415 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPopWindow" );
416 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPopWindow" );
418 fgStructure.CurrentWindow->State.WorkMask |= GLUT_ZORDER_WORK;
419 fgStructure.CurrentWindow->State.DesiredZOrder = 1;
423 * Resize the current window so that it fits the whole screen
425 void FGAPIENTRY glutFullScreen( void )
429 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreen" );
430 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreen" );
432 win = fgStructure.CurrentWindow;
436 /* Child windows cannot be made fullscreen, consistent with GLUT's behavior
437 * Also, what would it mean for a child window to be fullscreen, given that it
438 * is confined to its parent?
440 fgWarning("glutFullScreen called on a child window, ignoring...");
443 else if (fgStructure.GameModeWindow != NULL && fgStructure.GameModeWindow->ID==win->ID && win->State.IsFullscreen)
445 /* Ignore fullscreen call on GameMode window, those are always fullscreen already
446 * only exception is when first entering GameMode
451 if (!win->State.IsFullscreen)
452 win->State.WorkMask |= GLUT_FULL_SCREEN_WORK;
456 * If we are fullscreen, resize the current window back to its original size
458 void FGAPIENTRY glutLeaveFullScreen( void )
460 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreen" );
461 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreen" );
463 if (fgStructure.CurrentWindow->State.IsFullscreen)
464 fgStructure.CurrentWindow->State.WorkMask |= GLUT_FULL_SCREEN_WORK;
468 * Toggle the window's full screen state.
470 void FGAPIENTRY glutFullScreenToggle( void )
472 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreenToggle" );
473 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreenToggle" );
475 fgStructure.CurrentWindow->State.WorkMask |= GLUT_FULL_SCREEN_WORK;
479 * A.Donev: Set and retrieve the window's user data
481 void* FGAPIENTRY glutGetWindowData( void )
483 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetWindowData" );
484 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutGetWindowData" );
485 return fgStructure.CurrentWindow->UserData;
488 void FGAPIENTRY glutSetWindowData(void* data)
490 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowData" );
491 FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowData" );
492 fgStructure.CurrentWindow->UserData = data;
495 /*** END OF FILE ***/