2 * freeglut_state_mswin.c
4 * The Windows-specific state query methods.
6 * Copyright (c) 2012 Stephen J. Baker. All Rights Reserved.
7 * Written by John F. Fay, <fayjf@sourceforge.net>
8 * Creation date: Sun Jan 22, 2012
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 #include <GL/freeglut.h>
29 #include "../fg_internal.h"
32 extern GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
33 unsigned char layer_type );
36 * Helper functions for getting client area from the window rect
37 * and the window rect from the client area given the style of the window
38 * (or a valid window pointer from which the style can be queried).
40 extern void fghGetClientArea( RECT *clientRect, const SFG_Window *window, BOOL wantPosOutside );
41 extern void fghGetStyleFromWindow( const SFG_Window *window, DWORD *windowStyle, DWORD *windowExStyle );
42 extern void fghComputeWindowRectFromClientArea_UseStyle( RECT *clientRect, const DWORD windowStyle, const DWORD windowExStyle, BOOL posIsOutside );
45 /* The following include file is available from SGI but is not standard:
46 * #include <GL/wglext.h>
47 * So we copy the necessary parts out of it to support the multisampling query
49 #define WGL_SAMPLES_ARB 0x2042
51 #if defined(_WIN32_WCE)
52 # include <Aygshell.h>
53 # ifdef FREEGLUT_LIB_PRAGMAS
54 # pragma comment( lib, "Aygshell.lib" )
56 #endif /* defined(_WIN32_WCE) */
60 int fgPlatformGlutGet ( GLenum eWhat )
69 case GLUT_WINDOW_NUM_SAMPLES:
70 glGetIntegerv(WGL_SAMPLES_ARB, &nsamples);
73 /* Handle the OpenGL inquiries */
74 case GLUT_WINDOW_RGBA:
75 #if defined(_WIN32_WCE)
76 boolValue = (GLboolean)0; /* WinCE doesn't support this feature */
78 glGetBooleanv ( GL_RGBA_MODE, &boolValue );
79 returnValue = boolValue ? 1 : 0;
82 case GLUT_WINDOW_DOUBLEBUFFER:
83 #if defined(_WIN32_WCE)
84 boolValue = (GLboolean)0; /* WinCE doesn't support this feature */
86 glGetBooleanv ( GL_DOUBLEBUFFER, &boolValue );
87 returnValue = boolValue ? 1 : 0;
90 case GLUT_WINDOW_STEREO:
91 #if defined(_WIN32_WCE)
92 boolValue = (GLboolean)0; /* WinCE doesn't support this feature */
94 glGetBooleanv ( GL_STEREO, &boolValue );
95 returnValue = boolValue ? 1 : 0;
99 case GLUT_WINDOW_RED_SIZE:
100 glGetIntegerv ( GL_RED_BITS, &returnValue );
102 case GLUT_WINDOW_GREEN_SIZE:
103 glGetIntegerv ( GL_GREEN_BITS, &returnValue );
105 case GLUT_WINDOW_BLUE_SIZE:
106 glGetIntegerv ( GL_BLUE_BITS, &returnValue );
108 case GLUT_WINDOW_ALPHA_SIZE:
109 glGetIntegerv ( GL_ALPHA_BITS, &returnValue );
111 case GLUT_WINDOW_ACCUM_RED_SIZE:
112 #if defined(_WIN32_WCE)
113 returnValue = 0; /* WinCE doesn't support this feature */
115 glGetIntegerv ( GL_ACCUM_RED_BITS, &returnValue );
118 case GLUT_WINDOW_ACCUM_GREEN_SIZE:
119 #if defined(_WIN32_WCE)
120 returnValue = 0; /* WinCE doesn't support this feature */
122 glGetIntegerv ( GL_ACCUM_GREEN_BITS, &returnValue );
125 case GLUT_WINDOW_ACCUM_BLUE_SIZE:
126 #if defined(_WIN32_WCE)
127 returnValue = 0; /* WinCE doesn't support this feature */
129 glGetIntegerv ( GL_ACCUM_BLUE_BITS, &returnValue );
132 case GLUT_WINDOW_ACCUM_ALPHA_SIZE:
133 #if defined(_WIN32_WCE)
134 returnValue = 0; /* WinCE doesn't support this feature */
136 glGetIntegerv ( GL_ACCUM_ALPHA_BITS, &returnValue );
139 case GLUT_WINDOW_DEPTH_SIZE:
140 glGetIntegerv ( GL_DEPTH_BITS, &returnValue );
143 case GLUT_WINDOW_BUFFER_SIZE:
144 returnValue = 1 ; /* TODO????? */
146 case GLUT_WINDOW_STENCIL_SIZE:
147 returnValue = 0 ; /* TODO????? */
154 * There is considerable confusion about the "right thing to
155 * do" concerning window size and position. GLUT itself is
156 * not consistent between Windows and UNIX/X11; since
157 * platform independence is a virtue for "freeglut", we
158 * decided to break with GLUT's behaviour.
160 * Under UNIX/X11, it is apparently not possible to get the
161 * window border sizes in order to subtract them off the
162 * window's initial position until some time after the window
163 * has been created. Therefore we decided on the following
164 * behaviour, both under Windows and under UNIX/X11:
165 * - When you create a window with position (x,y) and size
166 * (w,h), the upper left hand corner of the outside of the
167 * window is at (x,y) and the size of the drawable area is
169 * - When you query the size and position of the window--as
170 * is happening here for Windows--"freeglut" will return
171 * the size of the drawable area--the (w,h) that you
172 * specified when you created the window--and the coordinates
173 * of the upper left hand corner of the drawable area, i.e.
174 * of the client rect--which is NOT the (x,y) you specified.
178 POINT topLeft = {0,0};
181 #if defined(_WIN32_WCE)
182 GetWindowRect( fgStructure.CurrentWindow->Window.Handle, &winRect);
184 ClientToScreen(fgStructure.CurrentWindow->Window.Handle, &topLeft);
186 if (fgStructure.CurrentWindow->Parent)
187 /* For child window, we should return relative to upper-left
188 * of parent's client area.
190 ScreenToClient(fgStructure.CurrentWindow->Parent->Window.Handle,&topLeft);
192 winRect.left = topLeft.x;
193 winRect.top = topLeft.y;
194 #endif /* defined(_WIN32_WCE) */
198 case GLUT_WINDOW_X: return winRect.left;
199 case GLUT_WINDOW_Y: return winRect.top ;
204 case GLUT_WINDOW_WIDTH:
205 freeglut_return_val_if_fail( fgStructure.CurrentWindow != NULL, 0 );
206 return fgStructure.CurrentWindow->State.Width;
207 case GLUT_WINDOW_HEIGHT:
208 freeglut_return_val_if_fail( fgStructure.CurrentWindow != NULL, 0 );
209 return fgStructure.CurrentWindow->State.Height;
211 case GLUT_WINDOW_BORDER_WIDTH :
212 case GLUT_WINDOW_BORDER_HEIGHT :
213 #if defined(_WIN32_WCE)
217 /* We can't get the border width or header height in the simple way
218 * with some calls to GetSystemMetrics. We'd then have to assume which
219 * elements are present for a given decoration, and such calculations
220 * wouldn't be valid for every version of Windows. The below should be
222 int borderWidth, captionHeight;
223 DWORD windowStyle, windowExStyle;
224 RECT clientRect, winRect;
226 /* Get style of window, or default style */
227 fghGetStyleFromWindow( fgStructure.CurrentWindow, &windowStyle, &windowExStyle );
228 /* Get client area if any window */
229 if (fgStructure.CurrentWindow && fgStructure.CurrentWindow->Window.Handle)
230 fghGetClientArea(&clientRect,fgStructure.CurrentWindow,FALSE);
232 SetRect(&clientRect,0,0,200,200);
234 /* Compute window rect (including non-client area) */
235 CopyRect(&winRect,&clientRect);
236 fghComputeWindowRectFromClientArea_UseStyle(&winRect,windowStyle,windowExStyle,FALSE);
238 /* Calculate border width by taking width of whole window minus width of client area and divide by two
239 * NB: we assume horizontal and vertical borders have the same size, which should always be the case
240 * unless the user bypassed FreeGLUT and messed with the windowstyle himself.
241 * Once borderwidth is known, account for it when comparing height of window to height of client area.
242 * all other extra pixels are assumed to be atop the window, forming the caption.
244 borderWidth = ((winRect.right-winRect.left)-(clientRect.right-clientRect.left))/2;
245 captionHeight = (winRect.bottom-winRect.top)-(clientRect.bottom-clientRect.top)-borderWidth*2;
249 case GLUT_WINDOW_BORDER_WIDTH:
251 case GLUT_WINDOW_BORDER_HEIGHT:
252 return captionHeight;
255 #endif /* defined(_WIN32_WCE) */
257 case GLUT_DISPLAY_MODE_POSSIBLE:
258 #if defined(_WIN32_WCE)
261 return fgSetupPixelFormat( fgStructure.CurrentWindow, GL_TRUE,
263 #endif /* defined(_WIN32_WCE) */
266 case GLUT_WINDOW_FORMAT_ID:
267 #if !defined(_WIN32_WCE)
268 if( fgStructure.CurrentWindow != NULL )
269 return GetPixelFormat( fgStructure.CurrentWindow->Window.pContext.Device );
270 #endif /* defined(_WIN32_WCE) */
274 fgWarning( "glutGet(): missing enum handle %d", eWhat );
282 int fgPlatformGlutDeviceGet ( GLenum eWhat )
286 case GLUT_HAS_KEYBOARD:
288 * Win32 is assumed a keyboard, and this cannot be queried,
289 * except for WindowsCE.
291 #if defined(_WIN32_CE)
292 return ( GetKeyboardStatus() & KBDI_KEYBOARD_PRESENT ) ? 1 : 0;
293 # if FREEGLUT_LIB_PRAGMAS
294 # pragma comment (lib,"Kbdui.lib")
303 * MS Windows can be booted without a mouse.
305 return GetSystemMetrics( SM_MOUSEPRESENT );
307 case GLUT_NUM_MOUSE_BUTTONS:
308 # if defined(_WIN32_WCE)
311 return GetSystemMetrics( SM_CMOUSEBUTTONS );
315 fgWarning( "glutDeviceGet(): missing enum handle %d", eWhat );
319 /* And now -- the failure. */
324 * This is for querying the number of supported auxiliary or multisample
325 * buffers for a (the current?) display mode.
326 * see http://old.nabble.com/-GLX--glutGetModeValues-to13514723.html#a13514723
327 * Not currently implemented, but we should be able to query the relevant
329 * http://www.opengl.org/registry/specs/ARB/wgl_pixel_format.txt
330 * (if supported on the executing machine!)
332 int *fgPlatformGlutGetModeValues(GLenum eWhat, int *size)