Adding support for the multisampling query per bug report 1274193
[freeglut] / src / freeglut_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 #include <GL/freeglut.h>
29 #include "freeglut_internal.h"
30
31 #if defined(_WIN32_WCE)
32 #include <aygshell.h>
33 #pragma comment( lib, "Aygshell.lib" ) /* library pragmas are bad */
34
35 static wchar_t* fghWstrFromStr(const char* str)
36 {
37     int i,len=strlen(str);
38     wchar_t* wstr = (wchar_t*)malloc(2*len+2);
39     for(i=0; i<len; i++)
40         wstr[i] = str[i];
41     wstr[len] = 0;
42     return wstr;
43 }
44
45
46 #endif /* defined(_WIN32_WCE) */
47
48 /*
49  * TODO BEFORE THE STABLE RELEASE:
50  *
51  *  fgChooseVisual()        -- OK, but what about glutInitDisplayString()?
52  *  fgSetupPixelFormat      -- ignores the display mode settings
53  *  fgOpenWindow()          -- check the Win32 version, -iconic handling!
54  *  fgCloseWindow()         -- check the Win32 version
55  *  glutCreateWindow()      -- Check when default position and size is {-1,-1}
56  *  glutCreateSubWindow()   -- Check when default position and size is {-1,-1}
57  *  glutDestroyWindow()     -- check the Win32 version
58  *  glutSetWindow()         -- check the Win32 version
59  *  glutGetWindow()         -- OK
60  *  glutSetWindowTitle()    -- check the Win32 version
61  *  glutSetIconTitle()      -- check the Win32 version
62  *  glutShowWindow()        -- check the Win32 version
63  *  glutHideWindow()        -- check the Win32 version
64  *  glutIconifyWindow()     -- check the Win32 version
65  *  glutReshapeWindow()     -- check the Win32 version
66  *  glutPositionWindow()    -- check the Win32 version
67  *  glutPushWindow()        -- check the Win32 version
68  *  glutPopWindow()         -- check the Win32 version
69  */
70
71 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
72
73 /*
74  * Chooses a visual basing on the current display mode settings
75  */
76 #if TARGET_HOST_POSIX_X11
77
78 XVisualInfo* fgChooseVisual( void )
79 {
80 #define BUFFER_SIZES 6
81     int bufferSize[BUFFER_SIZES] = { 16, 12, 8, 4, 2, 1 };
82     GLboolean wantIndexedMode = GL_FALSE;
83     int attributes[ 32 ];
84     int where = 0;
85
86     /* First we have to process the display mode settings... */
87 /*
88  * XXX Why is there a semi-colon in this #define?  The code
89  * XXX that uses the macro seems to always add more semicolons...
90  */
91 #define ATTRIB(a) attributes[where++]=a;
92 #define ATTRIB_VAL(a,v) {ATTRIB(a); ATTRIB(v);}
93
94     if( fgState.DisplayMode & GLUT_INDEX )
95     {
96         ATTRIB_VAL( GLX_BUFFER_SIZE, 8 );
97         wantIndexedMode = GL_TRUE;
98     }
99     else
100     {
101         ATTRIB( GLX_RGBA );
102         ATTRIB_VAL( GLX_RED_SIZE,   1 );
103         ATTRIB_VAL( GLX_GREEN_SIZE, 1 );
104         ATTRIB_VAL( GLX_BLUE_SIZE,  1 );
105         if( fgState.DisplayMode & GLUT_ALPHA )
106             ATTRIB_VAL( GLX_ALPHA_SIZE, 1 );
107     }
108
109     if( fgState.DisplayMode & GLUT_DOUBLE )
110         ATTRIB( GLX_DOUBLEBUFFER );
111
112     if( fgState.DisplayMode & GLUT_STEREO )
113         ATTRIB( GLX_STEREO );
114
115     if( fgState.DisplayMode & GLUT_DEPTH )
116         ATTRIB_VAL( GLX_DEPTH_SIZE, 1 );
117
118     if( fgState.DisplayMode & GLUT_STENCIL )
119         ATTRIB_VAL( GLX_STENCIL_SIZE, 1 );
120
121     if( fgState.DisplayMode & GLUT_ACCUM )
122     {
123         ATTRIB_VAL( GLX_ACCUM_RED_SIZE,   1 );
124         ATTRIB_VAL( GLX_ACCUM_GREEN_SIZE, 1 );
125         ATTRIB_VAL( GLX_ACCUM_BLUE_SIZE,  1 );
126         if( fgState.DisplayMode & GLUT_ALPHA )
127             ATTRIB_VAL( GLX_ACCUM_ALPHA_SIZE, 1 );
128     }
129
130     if( fgState.DisplayMode & GLUT_AUX1 )
131         ATTRIB_VAL( GLX_AUX_BUFFERS, 1 );
132     if( fgState.DisplayMode & GLUT_AUX2 )
133         ATTRIB_VAL( GLX_AUX_BUFFERS, 2 );
134     if( fgState.DisplayMode & GLUT_AUX3 )
135         ATTRIB_VAL( GLX_AUX_BUFFERS, 3 );
136     if( fgState.DisplayMode & GLUT_AUX4 )
137         ATTRIB_VAL( GLX_AUX_BUFFERS, 4 );
138     if ( fgState.DisplayMode & GLUT_MULTISAMPLE )
139         ATTRIB_VAL( GLX_SAMPLES_SGIS, 4 );
140
141
142     /* Push a null at the end of the list */
143     ATTRIB( None );
144
145     if( ! wantIndexedMode )
146         return glXChooseVisual( fgDisplay.Display, fgDisplay.Screen,
147                                 attributes );
148     else
149     {
150         XVisualInfo* visualInfo;
151         int i;
152
153         /*
154          * In indexed mode, we need to check how many bits of depth can we
155          * achieve.  We do this by trying each possibility from the list
156          * given in the {bufferSize} array.  If we match, we return to caller.
157          */
158         for( i=0; i<BUFFER_SIZES; i++ )
159         {
160             attributes[ 1 ] = bufferSize[ i ];
161             visualInfo = glXChooseVisual( fgDisplay.Display, fgDisplay.Screen,
162                                           attributes );
163             if( visualInfo != NULL )
164                 return visualInfo;
165         }
166         return NULL;
167     }
168 }
169 #endif
170
171 /*
172  * Setup the pixel format for a Win32 window
173  */
174 #if TARGET_HOST_MS_WINDOWS
175 /* WRONG-- FIXME */
176 /* The following include file is available from SGI but is not standard:
177  *   #include <GL/wglext.h>
178  * So we copy the necessary parts out of it.
179  */
180 typedef const char * (WINAPI * PFNWGLGETEXTENSIONSSTRINGARBPROC) (HDC hdc);
181
182 typedef BOOL (WINAPI * PFNWGLCHOOSEPIXELFORMATARBPROC) (HDC hdc, const int *piAttribIList, const FLOAT *pfAttribFList, UINT nMaxFormats, int *piFormats, UINT *nNumFormats);
183
184 #define WGL_DRAW_TO_WINDOW_ARB         0x2001
185 #define WGL_ACCELERATION_ARB           0x2003
186 #define WGL_SUPPORT_OPENGL_ARB         0x2010
187 #define WGL_DOUBLE_BUFFER_ARB          0x2011
188 #define WGL_COLOR_BITS_ARB             0x2014
189 #define WGL_ALPHA_BITS_ARB             0x201B
190 #define WGL_DEPTH_BITS_ARB             0x2022
191 #define WGL_STENCIL_BITS_ARB           0x2023
192 #define WGL_FULL_ACCELERATION_ARB      0x2027
193
194 #define WGL_SAMPLE_BUFFERS_ARB         0x2041
195 #define WGL_SAMPLES_ARB                0x2042
196
197
198 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
199                               unsigned char layer_type )
200 {
201 #if defined(_WIN32_WCE)
202     return GL_TRUE;
203 #else
204     PIXELFORMATDESCRIPTOR* ppfd, pfd;
205     int flags, pixelformat;
206
207     freeglut_return_val_if_fail( window != NULL, 0 );
208     flags = PFD_DRAW_TO_WINDOW | PFD_SUPPORT_OPENGL;
209     if( fgState.DisplayMode & GLUT_DOUBLE )
210         flags |= PFD_DOUBLEBUFFER;
211
212     if( fgState.DisplayMode & GLUT_STEREO )
213         flags |= PFD_STEREO;
214
215 #if defined(_MSC_VER)
216 #pragma message( "fgSetupPixelFormat(): there is still some work to do here!" )
217 #endif
218
219     /* Specify which pixel format do we opt for... */
220     pfd.nSize           = sizeof(PIXELFORMATDESCRIPTOR);
221     pfd.nVersion        = 1;
222     pfd.dwFlags         = flags;
223
224     if( fgState.DisplayMode & GLUT_INDEX )
225     {
226         pfd.iPixelType = PFD_TYPE_COLORINDEX;
227         pfd.cRedBits                = 0;
228         pfd.cGreenBits            = 0;
229         pfd.cBlueBits             = 0;
230         pfd.cAlphaBits            = 0;
231     }
232     else
233     {
234         pfd.iPixelType      = PFD_TYPE_RGBA;
235         pfd.cRedBits                = 8;
236         pfd.cGreenBits            = 8;
237         pfd.cBlueBits             = 8;
238         if ( fgState.DisplayMode & GLUT_ALPHA )
239             pfd.cAlphaBits            = 8;
240         else
241             pfd.cAlphaBits            = 0;
242     }
243
244     pfd.cColorBits      = 24;
245     pfd.cRedShift       = 0;
246     pfd.cGreenShift     = 0;
247     pfd.cBlueShift      = 0;
248     pfd.cAlphaShift     = 0;
249     pfd.cAccumBits      = 0;
250     pfd.cAccumRedBits   = 0;
251     pfd.cAccumGreenBits = 0;
252     pfd.cAccumBlueBits  = 0;
253     pfd.cAccumAlphaBits = 0;
254 #if 0
255     pfd.cDepthBits      = 32;
256     pfd.cStencilBits    = 0;
257 #else
258     pfd.cDepthBits      = 24;
259     pfd.cStencilBits    = 8;
260 #endif
261     if( fgState.DisplayMode & GLUT_AUX4 )
262         pfd.cAuxBuffers = 4;
263     else if( fgState.DisplayMode & GLUT_AUX3 )
264         pfd.cAuxBuffers = 3;
265     else if( fgState.DisplayMode & GLUT_AUX2 )
266         pfd.cAuxBuffers = 2;
267     else if( fgState.DisplayMode & GLUT_AUX1 )
268         pfd.cAuxBuffers = 1;
269     else
270         pfd.cAuxBuffers = 0;
271
272     pfd.iLayerType      = layer_type;
273     pfd.bReserved       = 0;
274     pfd.dwLayerMask     = 0;
275     pfd.dwVisibleMask   = 0;
276     pfd.dwDamageMask    = 0;
277
278     pfd.cColorBits = (BYTE) GetDeviceCaps( window->Window.Device, BITSPIXEL );
279     ppfd = &pfd;
280
281     pixelformat = ChoosePixelFormat( window->Window.Device, ppfd );
282
283     /* windows hack for multismapling */
284     if (fgState.DisplayMode&GLUT_MULTISAMPLE)
285     {        
286         PFNWGLGETEXTENSIONSSTRINGARBPROC wglGetEntensionsStringARB=NULL;
287         HGLRC rc, rc_before=wglGetCurrentContext();
288         HWND hWnd;
289         HDC hDC, hDC_before=wglGetCurrentDC();
290         WNDCLASS wndCls;
291         ATOM atom;
292
293         /* create a dummy window */
294         ZeroMemory(&wndCls, sizeof(wndCls));
295                 wndCls.lpfnWndProc        = DefWindowProc;
296                 wndCls.hInstance            = fgDisplay.Instance;
297                 wndCls.style                    = CS_OWNDC | CS_HREDRAW | CS_VREDRAW;
298                 wndCls.lpszClassName    = _T("FREEGLUT_dummy");
299         atom = RegisterClass( &wndCls );
300
301         hWnd=CreateWindow((LPCSTR)atom, _T(""), WS_CLIPSIBLINGS | WS_CLIPCHILDREN | WS_OVERLAPPEDWINDOW , 0,0,0,0, 0, 0, fgDisplay.Instance, 0 );
302         hDC=GetDC(hWnd);
303         SetPixelFormat( hDC, pixelformat, ppfd );
304         
305         rc = wglCreateContext( hDC );
306         wglMakeCurrent(hDC, rc);
307         
308         wglGetEntensionsStringARB=(PFNWGLGETEXTENSIONSSTRINGARBPROC)wglGetProcAddress("wglGetExtensionsStringARB");
309         if (wglGetEntensionsStringARB)
310         {
311             const char * pWglExtString=wglGetEntensionsStringARB(hDC);
312             if (pWglExtString)
313             {
314                 if (strstr(pWglExtString, "WGL_ARB_multisample"))
315                 {
316                     int pAttributes[100];
317                     int iCounter=0;
318                     int iPixelFormat;
319                     BOOL bValid;
320                     float fAttributes[] = {0,0};
321                     UINT numFormats;
322                     PFNWGLCHOOSEPIXELFORMATARBPROC wglChoosePixelFormatARBProc=NULL;
323
324                     wglChoosePixelFormatARBProc=(PFNWGLCHOOSEPIXELFORMATARBPROC)wglGetProcAddress("wglChoosePixelFormatARB");
325                     if ( wglChoosePixelFormatARBProc )
326                     {
327                         pAttributes[iCounter++]=WGL_DRAW_TO_WINDOW_ARB;        pAttributes[iCounter++]=GL_TRUE;
328                         pAttributes[iCounter++]=WGL_SUPPORT_OPENGL_ARB;        pAttributes[iCounter++]=GL_TRUE;
329                         pAttributes[iCounter++]=WGL_ACCELERATION_ARB;        pAttributes[iCounter++]=WGL_FULL_ACCELERATION_ARB;
330
331                         pAttributes[iCounter++]=WGL_COLOR_BITS_ARB;            pAttributes[iCounter++]=pfd.cColorBits ;
332                         pAttributes[iCounter++]=WGL_ALPHA_BITS_ARB;            pAttributes[iCounter++]=pfd.cAlphaBits;
333                         pAttributes[iCounter++]=WGL_DEPTH_BITS_ARB;            pAttributes[iCounter++]=pfd.cDepthBits;
334                         pAttributes[iCounter++]=WGL_STENCIL_BITS_ARB;        pAttributes[iCounter++]=pfd.cStencilBits;
335
336                         pAttributes[iCounter++]=WGL_DOUBLE_BUFFER_ARB;        pAttributes[iCounter++]=(fgState.DisplayMode & GLUT_DOUBLE)!=0;
337                         pAttributes[iCounter++]=WGL_SAMPLE_BUFFERS_ARB;        pAttributes[iCounter++]=GL_TRUE;
338                         pAttributes[iCounter++]=WGL_SAMPLES_ARB;            pAttributes[iCounter++]=4;
339                         pAttributes[iCounter++]=0;                            pAttributes[iCounter++]=0;    /* terminator */
340
341                         bValid = wglChoosePixelFormatARBProc(window->Window.Device,pAttributes,fAttributes,1,&iPixelFormat,&numFormats);
342
343                         if (bValid && numFormats>0)
344                             pixelformat=iPixelFormat;
345                     }
346                 }
347                 wglMakeCurrent( hDC_before, rc_before);
348                 wglDeleteContext(rc);
349                 ReleaseDC(hWnd, hDC);
350                 DestroyWindow(hWnd);
351                 UnregisterClass(_T("FREEGLUT_dummy"), fgDisplay.Instance);
352             }
353         }
354     }
355
356     if( pixelformat == 0 )
357         return GL_FALSE;
358
359     if( checkOnly )
360         return GL_TRUE;
361     return SetPixelFormat( window->Window.Device, pixelformat, ppfd );
362 #endif /* defined(_WIN32_WCE) */
363 }
364 #endif /* TARGET_HOST_MS_WINDOWS */
365
366 /*
367  * Sets the OpenGL context and the fgStructure "Current Window" pointer to
368  * the window structure passed in.
369  */
370 void fgSetWindow ( SFG_Window *window )
371 {
372 #if TARGET_HOST_POSIX_X11
373     if ( window )
374         glXMakeCurrent(
375             fgDisplay.Display,
376             window->Window.Handle,
377             window->Window.Context
378         );
379 #elif TARGET_HOST_MS_WINDOWS
380     if( fgStructure.CurrentWindow )
381         ReleaseDC( fgStructure.CurrentWindow->Window.Handle,
382                    fgStructure.CurrentWindow->Window.Device );
383
384     if ( window )
385     {
386         window->Window.Device = GetDC( window->Window.Handle );
387         wglMakeCurrent(
388             window->Window.Device,
389             window->Window.Context
390         );
391     }
392 #endif
393     fgStructure.CurrentWindow = window;
394 }
395
396
397 /*
398  * Opens a window. Requires a SFG_Window object created and attached
399  * to the freeglut structure. OpenGL context is created here.
400  */
401 void fgOpenWindow( SFG_Window* window, const char* title,
402                    int x, int y, int w, int h,
403                    GLboolean gameMode, GLboolean isSubWindow )
404 {
405 #if TARGET_HOST_POSIX_X11
406     XSetWindowAttributes winAttr;
407     XTextProperty textProperty;
408     XSizeHints sizeHints;
409     XWMHints wmHints;
410     unsigned long mask;
411     unsigned int current_DisplayMode = fgState.DisplayMode ;
412
413     /* Save the display mode if we are creating a menu window */
414     if( window->IsMenu && ( ! fgStructure.MenuContext ) )
415         fgState.DisplayMode = GLUT_DOUBLE | GLUT_RGB ;
416
417     window->Window.VisualInfo = fgChooseVisual( );
418
419     if( window->IsMenu && ( ! fgStructure.MenuContext ) )
420         fgState.DisplayMode = current_DisplayMode ;
421
422     if( ! window->Window.VisualInfo )
423     {
424         /*
425          * The "fgChooseVisual" returned a null meaning that the visual
426          * context is not available.
427          * Try a couple of variations to see if they will work.
428          */
429         if( !( fgState.DisplayMode & GLUT_DOUBLE ) )
430         {
431             fgState.DisplayMode |= GLUT_DOUBLE ;
432             window->Window.VisualInfo = fgChooseVisual( );
433             fgState.DisplayMode &= ~GLUT_DOUBLE;
434         }
435
436         if( fgState.DisplayMode & GLUT_MULTISAMPLE )
437         {
438             fgState.DisplayMode &= ~GLUT_MULTISAMPLE ;
439             window->Window.VisualInfo = fgChooseVisual( );
440             fgState.DisplayMode &= GLUT_MULTISAMPLE;
441         }
442     }
443
444     FREEGLUT_INTERNAL_ERROR_EXIT( window->Window.VisualInfo != NULL,
445                                   "Visual with necessary capabilities not found", "fgOpenWindow" );
446
447     /*
448      * XXX HINT: the masks should be updated when adding/removing callbacks.
449      * XXX       This might speed up message processing. Is that true?
450      * XXX
451      * XXX A: Not appreciably, but it WILL make it easier to debug.
452      * XXX    Try tracing old GLUT and try tracing freeglut.  Old GLUT
453      * XXX    turns off events that it doesn't need and is a whole lot
454      * XXX    more pleasant to trace.  (Think mouse-motion!  Tons of
455      * XXX    ``bonus'' GUI events stream in.)
456      */
457     winAttr.event_mask        =
458         StructureNotifyMask | SubstructureNotifyMask | ExposureMask |
459         ButtonPressMask | ButtonReleaseMask | KeyPressMask | KeyReleaseMask |
460         VisibilityChangeMask | EnterWindowMask | LeaveWindowMask |
461         PointerMotionMask | ButtonMotionMask;
462     winAttr.background_pixmap = None;
463     winAttr.background_pixel  = 0;
464     winAttr.border_pixel      = 0;
465
466     winAttr.colormap = XCreateColormap(
467         fgDisplay.Display, fgDisplay.RootWindow,
468         window->Window.VisualInfo->visual, AllocNone
469     );
470
471     mask = CWBackPixmap | CWBorderPixel | CWColormap | CWEventMask;
472
473     if( window->IsMenu || ( gameMode == GL_TRUE ) )
474     {
475         winAttr.override_redirect = True;
476         mask |= CWOverrideRedirect;
477     }
478
479     window->Window.Handle = XCreateWindow(
480         fgDisplay.Display,
481         window->Parent == NULL ? fgDisplay.RootWindow :
482         window->Parent->Window.Handle,
483         x, y, w, h, 0,
484         window->Window.VisualInfo->depth, InputOutput,
485         window->Window.VisualInfo->visual, mask,
486         &winAttr
487     );
488
489     /*
490      * The GLX context creation, possibly trying the direct context rendering
491      *  or else use the current context if the user has so specified
492      */
493     if( window->IsMenu )
494     {
495         /*
496          * If there isn't already an OpenGL rendering context for menu
497          * windows, make one
498          */
499         if( !fgStructure.MenuContext )
500         {
501             fgStructure.MenuContext =
502                 (SFG_MenuContext *)malloc( sizeof(SFG_MenuContext) );
503             fgStructure.MenuContext->MVisualInfo = window->Window.VisualInfo;
504             fgStructure.MenuContext->MContext = glXCreateContext(
505                 fgDisplay.Display, fgStructure.MenuContext->MVisualInfo,
506                 NULL, ( fgState.DirectContext != GLUT_FORCE_INDIRECT_CONTEXT )
507             );
508         }
509
510         /* window->Window.Context = fgStructure.MenuContext->MContext; */
511         window->Window.Context = glXCreateContext(
512             fgDisplay.Display, window->Window.VisualInfo,
513             NULL, ( fgState.DirectContext != GLUT_FORCE_INDIRECT_CONTEXT )
514         );
515     }
516     else if( fgState.UseCurrentContext )
517     {
518         window->Window.Context = glXGetCurrentContext( );
519
520         if( ! window->Window.Context )
521             window->Window.Context = glXCreateContext(
522                 fgDisplay.Display, window->Window.VisualInfo,
523                 NULL, ( fgState.DirectContext != GLUT_FORCE_INDIRECT_CONTEXT )
524             );
525     }
526     else
527         window->Window.Context = glXCreateContext(
528             fgDisplay.Display, window->Window.VisualInfo,
529             NULL, ( fgState.DirectContext != GLUT_FORCE_INDIRECT_CONTEXT )
530         );
531
532 #if !defined( __FreeBSD__ ) && !defined( __NetBSD__ )
533     if(  !glXIsDirect( fgDisplay.Display, window->Window.Context ) )
534     {
535       if( fgState.DirectContext == GLUT_FORCE_DIRECT_CONTEXT )
536         fgError( "Unable to force direct context rendering for window '%s'",
537                  title );
538       else if( fgState.DirectContext == GLUT_TRY_DIRECT_CONTEXT )
539         fgWarning( "Unable to create direct context rendering for window '%s'\nThis may hurt performance.",
540                  title );
541     }
542 #endif
543
544     /*
545      * XXX Assume the new window is visible by default
546      * XXX Is this a  safe assumption?
547      */
548     window->State.Visible = GL_TRUE;
549
550     sizeHints.flags = 0;
551     if ( fgState.Position.Use )
552         sizeHints.flags |= USPosition;
553     if ( fgState.Size.Use )
554         sizeHints.flags |= USSize;
555
556     /*
557      * Fill in the size hints values now (the x, y, width and height
558      * settings are obsolete, are there any more WMs that support them?)
559      * Unless the X servers actually stop supporting these, we should
560      * continue to fill them in.  It is *not* our place to tell the user
561      * that they should replace a window manager that they like, and which
562      * works, just because *we* think that it's not "modern" enough.
563      */
564     sizeHints.x      = x;
565     sizeHints.y      = y;
566     sizeHints.width  = w;
567     sizeHints.height = h;
568
569     wmHints.flags = StateHint;
570     wmHints.initial_state = fgState.ForceIconic ? IconicState : NormalState;
571     /* Prepare the window and iconified window names... */
572     XStringListToTextProperty( (char **) &title, 1, &textProperty );
573
574     XSetWMProperties(
575         fgDisplay.Display,
576         window->Window.Handle,
577         &textProperty,
578         &textProperty,
579         0,
580         0,
581         &sizeHints,
582         &wmHints,
583         NULL
584     );
585     XFree( textProperty.value );
586
587     XSetWMProtocols( fgDisplay.Display, window->Window.Handle,
588                      &fgDisplay.DeleteWindow, 1 );
589
590     glXMakeCurrent(
591         fgDisplay.Display,
592         window->Window.Handle,
593         window->Window.Context
594     );
595
596     XMapWindow( fgDisplay.Display, window->Window.Handle );
597
598 #elif TARGET_HOST_MS_WINDOWS
599
600     WNDCLASS wc;
601     DWORD flags;
602     DWORD exFlags = 0;
603     ATOM atom;
604
605     /* Grab the window class we have registered on glutInit(): */
606     atom = GetClassInfo( fgDisplay.Instance, _T("FREEGLUT"), &wc );
607     FREEGLUT_INTERNAL_ERROR_EXIT ( atom, "Window Class Info Not Found",
608                                    "fgOpenWindow" );
609
610     if( gameMode )
611     {
612         FREEGLUT_INTERNAL_ERROR_EXIT ( window->Parent == NULL,
613                                        "Game mode being invoked on a subwindow",
614                                        "fgOpenWindow" );
615
616         /*
617          * Set the window creation flags appropriately to make the window
618          * entirely visible:
619          */
620         flags = WS_POPUP | WS_CLIPSIBLINGS | WS_CLIPCHILDREN | WS_VISIBLE;
621     }
622     else
623     {
624 #if !defined(_WIN32_WCE)
625         if ( ( ! isSubWindow ) && ( ! window->IsMenu ) )
626         {
627             /*
628              * Update the window dimensions, taking account of window
629              * decorations.  "freeglut" is to create the window with the
630              * outside of its border at (x,y) and with dimensions (w,h).
631              */
632             w += (GetSystemMetrics( SM_CXSIZEFRAME ) )*2;
633             h += (GetSystemMetrics( SM_CYSIZEFRAME ) )*2 +
634                 GetSystemMetrics( SM_CYCAPTION );
635         }
636 #endif /* defined(_WIN32_WCE) */
637
638         if( ! fgState.Position.Use )
639         {
640             x = CW_USEDEFAULT;
641             y = CW_USEDEFAULT;
642         }
643         if( ! fgState.Size.Use )
644         {
645             w = CW_USEDEFAULT;
646             h = CW_USEDEFAULT;
647         }
648
649         /*
650          * There's a small difference between creating the top, child and
651          * game mode windows
652          */
653         flags = WS_CLIPSIBLINGS | WS_CLIPCHILDREN | WS_VISIBLE;
654
655         if ( window->IsMenu )
656         {
657             flags |= WS_POPUP;
658             exFlags |= WS_EX_TOOLWINDOW;
659         }
660 #if !defined(_WIN32_WCE)
661         else if( window->Parent == NULL )
662             flags |= WS_OVERLAPPEDWINDOW;
663 #endif
664         else
665             flags |= WS_CHILD;
666     }
667
668 #if defined(_WIN32_WCE)
669     {
670         wchar_t* wstr = fghWstrFromStr(title);
671
672         window->Window.Handle = CreateWindow(
673             _T("FREEGLUT"),
674             wstr,
675             WS_VISIBLE | WS_POPUP,
676             0,0, 240,320,
677             NULL,
678             NULL,
679             fgDisplay.Instance,
680             (LPVOID) window
681         );
682
683         free(wstr);
684
685         SHFullScreen(window->Window.Handle, SHFS_HIDESTARTICON);
686         SHFullScreen(window->Window.Handle, SHFS_HIDESIPBUTTON);
687         SHFullScreen(window->Window.Handle, SHFS_HIDETASKBAR);
688         MoveWindow(window->Window.Handle, 0, 0, 240, 320, TRUE);
689         ShowWindow(window->Window.Handle, SW_SHOW);
690         UpdateWindow(window->Window.Handle);
691     }
692 #else
693     window->Window.Handle = CreateWindowEx(
694         exFlags,
695         "FREEGLUT",
696         title,
697         flags,
698         x, y, w, h,
699         (HWND) window->Parent == NULL ? NULL : window->Parent->Window.Handle,
700         (HMENU) NULL,
701         fgDisplay.Instance,
702         (LPVOID) window
703     );
704 #endif /* defined(_WIN32_WCE) */
705
706     if( !( window->Window.Handle ) )
707         fgError( "Failed to create a window (%s)!", title );
708
709 #if defined(_WIN32_WCE)
710     ShowWindow( window->Window.Handle, SW_SHOW );
711 #else
712     ShowWindow( window->Window.Handle,
713                 fgState.ForceIconic ? SW_SHOWMINIMIZED : SW_SHOW );
714 #endif /* defined(_WIN32_WCE) */
715
716     UpdateWindow( window->Window.Handle );
717     ShowCursor( TRUE );  /* XXX Old comments say "hide cursor"! */
718
719 #endif
720
721     fgSetWindow( window );
722
723     window->Window.DoubleBuffered =
724         ( fgState.DisplayMode & GLUT_DOUBLE ) ? 1 : 0;
725
726     if ( ! window->Window.DoubleBuffered )
727     {
728         glDrawBuffer ( GL_FRONT );
729         glReadBuffer ( GL_FRONT );
730     }
731 }
732
733 /*
734  * Closes a window, destroying the frame and OpenGL context
735  */
736 void fgCloseWindow( SFG_Window* window )
737 {
738 #if TARGET_HOST_POSIX_X11
739
740     glXDestroyContext( fgDisplay.Display, window->Window.Context );
741     XFree( window->Window.VisualInfo );
742     XDestroyWindow( fgDisplay.Display, window->Window.Handle );
743     XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
744
745 #elif TARGET_HOST_MS_WINDOWS
746
747     /* Make sure we don't close a window with current context active */
748     if( fgStructure.CurrentWindow == window )
749         wglMakeCurrent( NULL, NULL );
750
751     /*
752      * Step through the list of windows.  If the rendering context
753      * is not being used by another window, then we delete it.
754      */
755     {
756         int used = FALSE ;
757         SFG_Window *iter ;
758
759         for( iter = (SFG_Window *)fgStructure.Windows.First;
760              iter;
761              iter = (SFG_Window *)iter->Node.Next )
762         {
763             if( ( iter->Window.Context == window->Window.Context ) &&
764                 ( iter != window ) )
765                 used = TRUE;
766         }
767
768         if( ! used )
769             wglDeleteContext( window->Window.Context );
770     }
771
772     DestroyWindow( window->Window.Handle );
773 #endif
774 }
775
776
777 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
778
779 /*
780  * Creates a new top-level freeglut window
781  */
782 int FGAPIENTRY glutCreateWindow( const char* title )
783 {
784     /* XXX GLUT does not exit; it simply calls "glutInit" quietly if the
785      * XXX application has not already done so.  The "freeglut" community
786      * XXX decided not to go this route (freeglut-developer e-mail from
787      * XXX Steve Baker, 12/16/04, 4:22 PM CST, "Re: [Freeglut-developer]
788      * XXX Desired 'freeglut' behaviour when there is no current window"
789      */
790     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateWindow" );
791
792     return fgCreateWindow( NULL, title, fgState.Position.X, fgState.Position.Y,
793                            fgState.Size.X, fgState.Size.Y, GL_FALSE,
794                            GL_FALSE )->ID;
795 }
796
797 /*
798  * This function creates a sub window.
799  */
800 int FGAPIENTRY glutCreateSubWindow( int parentID, int x, int y, int w, int h )
801 {
802     int ret = 0;
803     SFG_Window* window = NULL;
804     SFG_Window* parent = NULL;
805
806     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateSubWindow" );
807     parent = fgWindowByID( parentID );
808     freeglut_return_val_if_fail( parent != NULL, 0 );
809     if ( x < 0 )
810     {
811         x = parent->State.Width + x ;
812         if ( w >= 0 ) x -= w ;
813     }
814
815     if ( w < 0 ) w = parent->State.Width - x + w ;
816     if ( w < 0 )
817     {
818         x += w ;
819         w = -w ;
820     }
821
822     if ( y < 0 )
823     {
824         y = parent->State.Height + y ;
825         if ( h >= 0 ) y -= h ;
826     }
827
828     if ( h < 0 ) h = parent->State.Height - y + h ;
829     if ( h < 0 )
830     {
831         y += h ;
832         h = -h ;
833     }
834
835     window = fgCreateWindow( parent, "", x, y, w, h, GL_FALSE, GL_FALSE );
836     ret = window->ID;
837
838     return ret;
839 }
840
841 /*
842  * Destroys a window and all of its subwindows
843  */
844 void FGAPIENTRY glutDestroyWindow( int windowID )
845 {
846     SFG_Window* window;
847     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDestroyWindow" );
848     window = fgWindowByID( windowID );
849     freeglut_return_if_fail( window != NULL );
850     {
851         fgExecutionState ExecState = fgState.ExecState;
852         fgAddToWindowDestroyList( window );
853         fgState.ExecState = ExecState;
854     }
855 }
856
857 /*
858  * This function selects the current window
859  */
860 void FGAPIENTRY glutSetWindow( int ID )
861 {
862     SFG_Window* window = NULL;
863
864     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindow" );
865     if( fgStructure.CurrentWindow != NULL )
866         if( fgStructure.CurrentWindow->ID == ID )
867             return;
868
869     window = fgWindowByID( ID );
870     if( window == NULL )
871     {
872         fgWarning( "glutSetWindow(): window ID %d not found!", ID );
873         return;
874     }
875
876     fgSetWindow( window );
877 }
878
879 /*
880  * This function returns the ID number of the current window, 0 if none exists
881  */
882 int FGAPIENTRY glutGetWindow( void )
883 {
884     SFG_Window *win = fgStructure.CurrentWindow;
885     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetWindow" );
886     while ( win && win->IsMenu )
887         win = win->Parent;
888     return win ? win->ID : 0;
889 }
890
891 /*
892  * This function makes the current window visible
893  */
894 void FGAPIENTRY glutShowWindow( void )
895 {
896     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutShowWindow" );
897     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutShowWindow" );
898
899 #if TARGET_HOST_POSIX_X11
900
901     XMapWindow( fgDisplay.Display, fgStructure.CurrentWindow->Window.Handle );
902     XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
903
904 #elif TARGET_HOST_MS_WINDOWS
905
906     ShowWindow( fgStructure.CurrentWindow->Window.Handle, SW_SHOW );
907
908 #endif
909
910     fgStructure.CurrentWindow->State.Redisplay = GL_TRUE;
911 }
912
913 /*
914  * This function hides the current window
915  */
916 void FGAPIENTRY glutHideWindow( void )
917 {
918     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutHideWindow" );
919     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutHideWindow" );
920
921 #if TARGET_HOST_POSIX_X11
922
923     if( fgStructure.CurrentWindow->Parent == NULL )
924         XWithdrawWindow( fgDisplay.Display,
925                          fgStructure.CurrentWindow->Window.Handle,
926                          fgDisplay.Screen );
927     else
928         XUnmapWindow( fgDisplay.Display,
929                       fgStructure.CurrentWindow->Window.Handle );
930     XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
931
932 #elif TARGET_HOST_MS_WINDOWS
933
934     ShowWindow( fgStructure.CurrentWindow->Window.Handle, SW_HIDE );
935
936 #endif
937
938     fgStructure.CurrentWindow->State.Redisplay = GL_FALSE;
939 }
940
941 /*
942  * Iconify the current window (top-level windows only)
943  */
944 void FGAPIENTRY glutIconifyWindow( void )
945 {
946     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutIconifyWindow" );
947     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutIconifyWindow" );
948
949     fgStructure.CurrentWindow->State.Visible   = GL_FALSE;
950 #if TARGET_HOST_POSIX_X11
951
952     XIconifyWindow( fgDisplay.Display, fgStructure.CurrentWindow->Window.Handle,
953                     fgDisplay.Screen );
954     XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
955
956 #elif TARGET_HOST_MS_WINDOWS
957
958     ShowWindow( fgStructure.CurrentWindow->Window.Handle, SW_MINIMIZE );
959
960 #endif
961
962     fgStructure.CurrentWindow->State.Redisplay = GL_FALSE;
963 }
964
965 /*
966  * Set the current window's title
967  */
968 void FGAPIENTRY glutSetWindowTitle( const char* title )
969 {
970     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowTitle" );
971     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowTitle" );
972     if( ! fgStructure.CurrentWindow->Parent )
973     {
974 #if TARGET_HOST_POSIX_X11
975
976         XTextProperty text;
977
978         text.value = (unsigned char *) title;
979         text.encoding = XA_STRING;
980         text.format = 8;
981         text.nitems = strlen( title );
982
983         XSetWMName(
984             fgDisplay.Display,
985             fgStructure.CurrentWindow->Window.Handle,
986             &text
987         );
988
989         XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
990
991 #elif TARGET_HOST_MS_WINDOWS
992 #    ifdef _WIN32_WCE
993         {
994             wchar_t* wstr = fghWstrFromStr(title);
995             SetWindowText( fgStructure.CurrentWindow->Window.Handle, wstr );
996             free(wstr);
997         }
998 #    else
999         SetWindowText( fgStructure.CurrentWindow->Window.Handle, title );
1000 #    endif
1001
1002 #endif
1003     }
1004 }
1005
1006 /*
1007  * Set the current window's iconified title
1008  */
1009 void FGAPIENTRY glutSetIconTitle( const char* title )
1010 {
1011     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetIconTitle" );
1012     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetIconTitle" );
1013
1014     if( ! fgStructure.CurrentWindow->Parent )
1015     {
1016 #if TARGET_HOST_POSIX_X11
1017
1018         XTextProperty text;
1019
1020         text.value = (unsigned char *) title;
1021         text.encoding = XA_STRING;
1022         text.format = 8;
1023         text.nitems = strlen( title );
1024
1025         XSetWMIconName(
1026             fgDisplay.Display,
1027             fgStructure.CurrentWindow->Window.Handle,
1028             &text
1029         );
1030
1031         XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
1032
1033 #elif TARGET_HOST_MS_WINDOWS
1034 #    ifdef _WIN32_WCE
1035         {
1036             wchar_t* wstr = fghWstrFromStr(title);
1037             SetWindowText( fgStructure.CurrentWindow->Window.Handle, wstr );
1038             free(wstr);
1039         }
1040 #    else
1041         SetWindowText( fgStructure.CurrentWindow->Window.Handle, title );
1042 #    endif
1043
1044 #endif
1045     }
1046 }
1047
1048 /*
1049  * Change the current window's size
1050  */
1051 void FGAPIENTRY glutReshapeWindow( int width, int height )
1052 {
1053     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutReshapeWindow" );
1054     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutReshapeWindow" );
1055
1056     fgStructure.CurrentWindow->State.NeedToResize = GL_TRUE;
1057     fgStructure.CurrentWindow->State.Width  = width ;
1058     fgStructure.CurrentWindow->State.Height = height;
1059 }
1060
1061 /*
1062  * Change the current window's position
1063  */
1064 void FGAPIENTRY glutPositionWindow( int x, int y )
1065 {
1066     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPositionWindow" );
1067     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPositionWindow" );
1068
1069 #if TARGET_HOST_POSIX_X11
1070
1071     XMoveWindow( fgDisplay.Display, fgStructure.CurrentWindow->Window.Handle,
1072                  x, y );
1073     XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
1074
1075 #elif TARGET_HOST_MS_WINDOWS
1076
1077     {
1078         RECT winRect;
1079
1080         /* "GetWindowRect" returns the pixel coordinates of the outside of the window */
1081         GetWindowRect( fgStructure.CurrentWindow->Window.Handle, &winRect );
1082         MoveWindow(
1083             fgStructure.CurrentWindow->Window.Handle,
1084             x,
1085             y,
1086             winRect.right - winRect.left,
1087             winRect.bottom - winRect.top,
1088             TRUE
1089         );
1090     }
1091
1092 #endif
1093 }
1094
1095 /*
1096  * Lowers the current window (by Z order change)
1097  */
1098 void FGAPIENTRY glutPushWindow( void )
1099 {
1100     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPushWindow" );
1101     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPushWindow" );
1102
1103 #if TARGET_HOST_POSIX_X11
1104
1105     XLowerWindow( fgDisplay.Display, fgStructure.CurrentWindow->Window.Handle );
1106
1107 #elif TARGET_HOST_MS_WINDOWS
1108
1109     SetWindowPos(
1110         fgStructure.CurrentWindow->Window.Handle,
1111         HWND_BOTTOM,
1112         0, 0, 0, 0,
1113         SWP_NOSIZE | SWP_NOMOVE
1114     );
1115
1116 #endif
1117 }
1118
1119 /*
1120  * Raises the current window (by Z order change)
1121  */
1122 void FGAPIENTRY glutPopWindow( void )
1123 {
1124     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPopWindow" );
1125     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPopWindow" );
1126
1127 #if TARGET_HOST_POSIX_X11
1128
1129     XRaiseWindow( fgDisplay.Display, fgStructure.CurrentWindow->Window.Handle );
1130
1131 #elif TARGET_HOST_MS_WINDOWS
1132
1133     SetWindowPos(
1134         fgStructure.CurrentWindow->Window.Handle,
1135         HWND_TOP,
1136         0, 0, 0, 0,
1137         SWP_NOSIZE | SWP_NOMOVE
1138     );
1139
1140 #endif
1141 }
1142
1143 /*
1144  * Resize the current window so that it fits the whole screen
1145  */
1146 void FGAPIENTRY glutFullScreen( void )
1147 {
1148     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreen" );
1149     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreen" );
1150
1151     {
1152 #if TARGET_HOST_POSIX_X11
1153         int x, y;
1154         Window w;
1155
1156         XMoveResizeWindow(
1157             fgDisplay.Display,
1158             fgStructure.CurrentWindow->Window.Handle,
1159             0, 0,
1160             fgDisplay.ScreenWidth,
1161             fgDisplay.ScreenHeight
1162         );
1163
1164         XFlush( fgDisplay.Display ); /* This is needed */
1165
1166         XTranslateCoordinates(
1167             fgDisplay.Display,
1168             fgStructure.CurrentWindow->Window.Handle,
1169             fgDisplay.RootWindow,
1170             0, 0, &x, &y, &w
1171         );
1172
1173         if (x || y)
1174         {
1175             XMoveWindow(
1176                 fgDisplay.Display,
1177                 fgStructure.CurrentWindow->Window.Handle,
1178                 -x, -y
1179             );
1180             XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
1181         }
1182 #elif TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: what about WinCE */
1183         RECT rect;
1184
1185         /* For fullscreen mode, force the top-left corner to 0,0
1186          * and adjust the window rectangle so that the client area
1187          * covers the whole screen.
1188          */
1189
1190         rect.left   = 0;
1191         rect.top    = 0;
1192         rect.right  = fgDisplay.ScreenWidth;
1193         rect.bottom = fgDisplay.ScreenHeight;
1194
1195         AdjustWindowRect ( &rect, WS_OVERLAPPEDWINDOW | WS_CLIPSIBLINGS |
1196                                   WS_CLIPCHILDREN, FALSE );
1197
1198         /*
1199          * SWP_NOACTIVATE     Do not activate the window
1200          * SWP_NOOWNERZORDER  Do not change position in z-order
1201          * SWP_NOSENDCHANGING Supress WM_WINDOWPOSCHANGING message
1202          * SWP_NOZORDER       Retains the current Z order (ignore 2nd param)
1203          */
1204
1205         SetWindowPos( fgStructure.CurrentWindow->Window.Handle,
1206                       HWND_TOP,
1207                       rect.left,
1208                       rect.top,
1209                       rect.right  - rect.left,
1210                       rect.bottom - rect.top,
1211                       SWP_NOACTIVATE | SWP_NOOWNERZORDER | SWP_NOSENDCHANGING |
1212                       SWP_NOZORDER
1213                     );
1214 #endif
1215     }
1216 }
1217
1218 /*
1219  * A.Donev: Set and retrieve the window's user data
1220  */
1221 void* FGAPIENTRY glutGetWindowData( void )
1222 {
1223     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetWindowData" );
1224     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutGetWindowData" );
1225     return fgStructure.CurrentWindow->UserData;
1226 }
1227
1228 void FGAPIENTRY glutSetWindowData(void* data)
1229 {
1230     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowData" );
1231     FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowData" );
1232     fgStructure.CurrentWindow->UserData = data;
1233 }
1234
1235 /*** END OF FILE ***/