4 * Freeglut state query methods.
6 * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
7 * Written by Pawel W. Olszta, <olszta@sourceforge.net>
8 * Creation date: Thu Dec 16 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.
32 #include "../include/GL/freeglut.h"
33 #include "freeglut_internal.h"
36 * TODO BEFORE THE STABLE RELEASE:
38 * glutGet() -- X11 tests passed, but check if all enums
39 * handled (what about Win32?)
40 * glutDeviceGet() -- X11 tests passed, but check if all enums
41 * handled (what about Win32?)
42 * glutGetModifiers() -- OK, but could also remove the limitation
43 * glutLayerGet() -- what about GLUT_NORMAL_DAMAGED?
45 * The fail-on-call policy will help adding the most needed things imho.
48 /* -- LOCAL DEFINITIONS ---------------------------------------------------- */
50 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
52 #if TARGET_HOST_UNIX_X11
54 * Queries the GL context about some attributes
56 static int fghGetConfig( int attribute )
60 if( fgStructure.Window )
61 glXGetConfig( fgDisplay.Display, fgStructure.Window->Window.VisualInfo,
62 attribute, &returnValue );
68 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
71 * General settings assignment method
73 void FGAPIENTRY glutSetOption( GLenum eWhat, int value )
75 freeglut_assert_ready;
78 * XXX In chronological code add order. (WHY in that order?)
82 case GLUT_INIT_WINDOW_X:
83 fgState.Position.X = (GLint)value;
86 case GLUT_INIT_WINDOW_Y:
87 fgState.Position.Y = (GLint)value;
90 case GLUT_INIT_WINDOW_WIDTH:
91 fgState.Size.X = (GLint)value;
94 case GLUT_INIT_WINDOW_HEIGHT:
95 fgState.Size.Y = (GLint)value;
98 case GLUT_INIT_DISPLAY_MODE:
99 fgState.DisplayMode = (unsigned int)value;
102 case GLUT_ACTION_ON_WINDOW_CLOSE:
103 fgState.ActionOnWindowClose = value;
106 case GLUT_RENDERING_CONTEXT:
107 fgState.UseCurrentContext =
108 ( value == GLUT_USE_CURRENT_CONTEXT ) ? TRUE : FALSE;
111 case GLUT_WINDOW_CURSOR:
112 if( fgStructure.Window != NULL )
113 fgStructure.Window->State.Cursor = value;
117 fgWarning( "glutSetOption(): missing enum handle %i\n", eWhat );
123 * General settings query method
125 int FGAPIENTRY glutGet( GLenum eWhat )
128 GLboolean boolValue ;
130 if ( eWhat == GLUT_INIT_STATE )
131 return ( fgState.Time.Set ) ;
133 freeglut_assert_ready;
136 * XXX In chronological code add order. (WHY in that order?)
140 case GLUT_ELAPSED_TIME:
141 return( fgElapsedTime() );
144 * Following values are stored in fgState and fgDisplay global structures
146 case GLUT_SCREEN_WIDTH: return( fgDisplay.ScreenWidth );
147 case GLUT_SCREEN_HEIGHT: return( fgDisplay.ScreenHeight );
148 case GLUT_SCREEN_WIDTH_MM: return( fgDisplay.ScreenWidthMM );
149 case GLUT_SCREEN_HEIGHT_MM: return( fgDisplay.ScreenHeightMM );
150 case GLUT_INIT_WINDOW_X: return( fgState.Position.X );
151 case GLUT_INIT_WINDOW_Y: return( fgState.Position.Y );
152 case GLUT_INIT_WINDOW_WIDTH: return( fgState.Size.X );
153 case GLUT_INIT_WINDOW_HEIGHT: return( fgState.Size.Y );
154 case GLUT_INIT_DISPLAY_MODE: return( fgState.DisplayMode );
157 * The window/context specific queries are handled mostly by
160 case GLUT_WINDOW_NUM_SAMPLES:
162 * XXX Multisampling. Return what I know about multisampling.
166 #if TARGET_HOST_UNIX_X11
168 * The rest of GLX queries under X are general enough to use a macro to
171 # define GLX_QUERY(a,b) case a: return( fghGetConfig( b ) );
173 GLX_QUERY( GLUT_WINDOW_RGBA, GLX_RGBA );
174 GLX_QUERY( GLUT_WINDOW_DOUBLEBUFFER, GLX_DOUBLEBUFFER );
175 GLX_QUERY( GLUT_WINDOW_BUFFER_SIZE, GLX_BUFFER_SIZE );
176 GLX_QUERY( GLUT_WINDOW_STENCIL_SIZE, GLX_STENCIL_SIZE );
177 GLX_QUERY( GLUT_WINDOW_DEPTH_SIZE, GLX_DEPTH_SIZE );
178 GLX_QUERY( GLUT_WINDOW_RED_SIZE, GLX_RED_SIZE );
179 GLX_QUERY( GLUT_WINDOW_GREEN_SIZE, GLX_GREEN_SIZE );
180 GLX_QUERY( GLUT_WINDOW_BLUE_SIZE, GLX_BLUE_SIZE );
181 GLX_QUERY( GLUT_WINDOW_ALPHA_SIZE, GLX_ALPHA_SIZE );
182 GLX_QUERY( GLUT_WINDOW_ACCUM_RED_SIZE, GLX_ACCUM_RED_SIZE );
183 GLX_QUERY( GLUT_WINDOW_ACCUM_GREEN_SIZE, GLX_ACCUM_GREEN_SIZE );
184 GLX_QUERY( GLUT_WINDOW_ACCUM_BLUE_SIZE, GLX_ACCUM_BLUE_SIZE );
185 GLX_QUERY( GLUT_WINDOW_ACCUM_ALPHA_SIZE, GLX_ACCUM_ALPHA_SIZE );
186 GLX_QUERY( GLUT_WINDOW_STEREO, GLX_STEREO );
191 * Colormap size is handled in a bit different way than all the rest
193 case GLUT_WINDOW_COLORMAP_SIZE:
194 if( (fghGetConfig( GLX_RGBA )) || (fgStructure.Window == NULL) )
197 * We've got a RGBA visual, so there is no colormap at all.
198 * The other possibility is that we have no current window set.
202 return( fgStructure.Window->Window.VisualInfo->visual->map_entries );
205 * Those calls are somewhat similiar, as they use XGetWindowAttributes()
210 case GLUT_WINDOW_BORDER_WIDTH:
211 case GLUT_WINDOW_HEADER_HEIGHT:
216 if( fgStructure.Window == NULL )
219 XTranslateCoordinates(
221 fgStructure.Window->Window.Handle,
222 fgDisplay.RootWindow,
227 case GLUT_WINDOW_X: return x;
228 case GLUT_WINDOW_Y: return y;
233 XTranslateCoordinates(
235 fgStructure.Window->Window.Handle,
236 w, 0, 0, &x, &y, &w);
240 case GLUT_WINDOW_BORDER_WIDTH: return x;
241 case GLUT_WINDOW_HEADER_HEIGHT: return y;
245 case GLUT_WINDOW_WIDTH:
246 case GLUT_WINDOW_HEIGHT:
248 XWindowAttributes winAttributes;
250 if( fgStructure.Window == NULL )
252 XGetWindowAttributes(
254 fgStructure.Window->Window.Handle,
259 case GLUT_WINDOW_WIDTH: return winAttributes.width ;
260 case GLUT_WINDOW_HEIGHT: return winAttributes.height ;
265 * I do not know yet if there will be a fgChooseVisual() function for Win32
267 case GLUT_DISPLAY_MODE_POSSIBLE:
268 return( fgChooseVisual() == NULL ? 0 : 1 );
271 * This is system-dependant
273 case GLUT_WINDOW_FORMAT_ID:
274 if( fgStructure.Window == NULL )
277 return( fgStructure.Window->Window.VisualInfo->visualid );
279 #elif TARGET_HOST_WIN32
282 * Handle the OpenGL inquiries
284 case GLUT_WINDOW_RGBA:
285 glGetBooleanv ( GL_RGBA_MODE, &boolValue ) ;
286 returnValue = boolValue ? 1 : 0 ;
287 return ( returnValue ) ;
288 case GLUT_WINDOW_DOUBLEBUFFER:
289 glGetBooleanv ( GL_DOUBLEBUFFER, &boolValue ) ;
290 returnValue = boolValue ? 1 : 0 ;
291 return ( returnValue ) ;
292 case GLUT_WINDOW_STEREO:
293 glGetBooleanv ( GL_STEREO, &boolValue ) ;
294 returnValue = boolValue ? 1 : 0 ;
295 return ( returnValue ) ;
297 case GLUT_WINDOW_RED_SIZE:
298 glGetIntegerv ( GL_RED_BITS, &returnValue ) ;
299 return ( returnValue ) ;
300 case GLUT_WINDOW_GREEN_SIZE:
301 glGetIntegerv ( GL_GREEN_BITS, &returnValue ) ;
302 return ( returnValue ) ;
303 case GLUT_WINDOW_BLUE_SIZE:
304 glGetIntegerv ( GL_BLUE_BITS, &returnValue ) ;
305 return ( returnValue ) ;
306 case GLUT_WINDOW_ALPHA_SIZE:
307 glGetIntegerv ( GL_ALPHA_BITS, &returnValue ) ;
308 return ( returnValue ) ;
309 case GLUT_WINDOW_ACCUM_RED_SIZE:
310 glGetIntegerv ( GL_ACCUM_RED_BITS, &returnValue ) ;
311 return ( returnValue ) ;
312 case GLUT_WINDOW_ACCUM_GREEN_SIZE:
313 glGetIntegerv ( GL_ACCUM_GREEN_BITS, &returnValue ) ;
314 return ( returnValue ) ;
315 case GLUT_WINDOW_ACCUM_BLUE_SIZE:
316 glGetIntegerv ( GL_ACCUM_BLUE_BITS, &returnValue ) ;
317 return ( returnValue ) ;
318 case GLUT_WINDOW_ACCUM_ALPHA_SIZE:
319 glGetIntegerv ( GL_ACCUM_ALPHA_BITS, &returnValue ) ;
320 return ( returnValue ) ;
321 case GLUT_WINDOW_DEPTH_SIZE:
322 glGetIntegerv ( GL_DEPTH_BITS, &returnValue ) ;
323 return ( returnValue ) ;
325 case GLUT_WINDOW_BUFFER_SIZE:
326 returnValue = 1 ; /* ????? */
327 return ( returnValue ) ;
328 case GLUT_WINDOW_STENCIL_SIZE:
329 returnValue = 0 ; /* ????? */
330 return ( returnValue ) ;
334 case GLUT_WINDOW_WIDTH:
335 case GLUT_WINDOW_HEIGHT:
338 * There is considerable confusion about the "right thing to
339 * do" concerning window size and position. GLUT itself is
340 * not consistent between Windows and UNIX/X11; since
341 * platform independence is a virtue for "freeglut", we
342 * decided to break with GLUT's behaviour.
344 * Under UNIX/X11, it is apparently not possible to get the
345 * window border sizes in order to subtract them off the
346 * window's initial position until some time after the window
347 * has been created. Therefore we decided on the following
348 * behaviour, both under Windows and under UNIX/X11:
349 * - When you create a window with position (x,y) and size
350 * (w,h), the upper left hand corner of the outside of the
351 * window is at (x,y) and the size of the drawable area is
353 * - When you query the size and position of the window--as
354 * is happening here for Windows--"freeglut" will return
355 * the size of the drawable area--the (w,h) that you
356 * specified when you created the window--and the coordinates
357 * of the upper left hand corner of the drawable
358 * area--which is NOT the (x,y) you specified.
363 freeglut_return_val_if_fail( fgStructure.Window != NULL, 0 );
366 * We need to call GetWindowRect() first...
367 * (this returns the pixel coordinates of the outside of the window)
369 GetWindowRect( fgStructure.Window->Window.Handle, &winRect );
372 * ...then we've got to correct the results we've just received...
374 if ( ( fgStructure.GameMode != fgStructure.Window ) && ( fgStructure.Window->Parent == NULL ) &&
375 ( ! fgStructure.Window->IsMenu ) )
377 winRect.left += GetSystemMetrics( SM_CXSIZEFRAME );
378 winRect.right -= GetSystemMetrics( SM_CXSIZEFRAME );
379 winRect.top += GetSystemMetrics( SM_CYSIZEFRAME ) + GetSystemMetrics( SM_CYCAPTION );
380 winRect.bottom -= GetSystemMetrics( SM_CYSIZEFRAME );
385 case GLUT_WINDOW_X: return( winRect.left );
386 case GLUT_WINDOW_Y: return( winRect.top );
387 case GLUT_WINDOW_WIDTH: return( winRect.right - winRect.left );
388 case GLUT_WINDOW_HEIGHT: return( winRect.bottom - winRect.top );
393 case GLUT_WINDOW_BORDER_WIDTH :
394 return ( GetSystemMetrics( SM_CXSIZEFRAME ) ) ;
396 case GLUT_WINDOW_HEADER_HEIGHT :
397 return ( GetSystemMetrics( SM_CYCAPTION ) ) ;
399 case GLUT_DISPLAY_MODE_POSSIBLE:
400 return( fgSetupPixelFormat( fgStructure.Window, TRUE, PFD_MAIN_PLANE ) );
402 case GLUT_WINDOW_FORMAT_ID:
403 if( fgStructure.Window != NULL )
404 return( GetPixelFormat( fgStructure.Window->Window.Device ) );
410 * The window structure queries
412 case GLUT_WINDOW_PARENT:
413 if( fgStructure.Window == NULL ) return( 0 );
414 if( fgStructure.Window->Parent == NULL ) return( 0 );
415 return( fgStructure.Window->Parent->ID );
417 case GLUT_WINDOW_NUM_CHILDREN:
418 if( fgStructure.Window == NULL )
420 return( fgListLength( &fgStructure.Window->Children ) );
422 case GLUT_WINDOW_CURSOR:
423 if( fgStructure.Window == NULL )
425 return( fgStructure.Window->State.Cursor );
427 case GLUT_MENU_NUM_ITEMS:
428 if( fgStructure.Menu == NULL )
430 return( fgListLength( &fgStructure.Menu->Entries ) );
432 case GLUT_ACTION_ON_WINDOW_CLOSE:
433 return fgState.ActionOnWindowClose ;
436 return VERSION_MAJOR * 10000 + VERSION_MINOR * 100 + VERSION_PATCH ;
438 case GLUT_RENDERING_CONTEXT:
439 return ( fgState.UseCurrentContext ? GLUT_USE_CURRENT_CONTEXT : GLUT_CREATE_NEW_CONTEXT ) ;
442 fgWarning( "glutGet(): missing enum handle %i\n", eWhat );
449 * Returns various device information.
451 int FGAPIENTRY glutDeviceGet( GLenum eWhat )
453 freeglut_assert_ready;
456 * XXX WARNING: we are mostly lying in this function.
460 case GLUT_HAS_KEYBOARD:
462 * We always have a keyboard present on PC machines...
464 * XXX I think that some of my PCs will boot without a keyboard.
465 * XXX Also, who says that we are running on a PC? UNIX/X11
466 * XXX is much more generic, and X11 can go over a network.
467 * XXX Though in actuality, we can probably assume BOTH a
468 * XXX mouse and keyboard for most/all of our users.
472 #if TARGET_HOST_UNIX_X11
477 case GLUT_NUM_MOUSE_BUTTONS:
479 * Return the number of mouse buttons available. This is a big guess.
481 * XXX We can probe /var/run/dmesg.boot which is world-readable.
482 * XXX This would be somewhat system-dependant, but is doable.
483 * XXX E.g., on NetBSD, my USB mouse registers:
484 * XXX ums0 at uhidev0: 3 buttons and Z dir.
485 * XXX We can also probe /var/log/XFree86\..*\.log to get
487 * XXX (**) Option "Buttons" "5"
488 * XXX (**) Option "ZAxisMapping" "4 5"
489 * XXX (**) Mouse0: ZAxisMapping: buttons 4 and 5
490 * XXX (**) Mouse0: Buttons: 5
491 * XXX ...which tells us even more, and is a bit less
492 * XXX system-dependant. (Other than MS-WINDOWS, all
493 * XXX target hosts with actual users are probably running
494 * XXX XFree86...) It is at least worth taking a look at
499 #elif TARGET_HOST_WIN32
503 * The Windows can be booted without a mouse.
504 * It would be nice to have this reported.
506 return( GetSystemMetrics( SM_MOUSEPRESENT ) );
508 case GLUT_NUM_MOUSE_BUTTONS:
510 * We are much more fortunate under Win32 about this...
512 return( GetSystemMetrics( SM_CMOUSEBUTTONS ) );
516 case GLUT_JOYSTICK_POLL_RATE:
517 case GLUT_HAS_JOYSTICK:
518 case GLUT_JOYSTICK_BUTTONS:
519 case GLUT_JOYSTICK_AXES:
521 * XXX WARNING: THIS IS A BIG LIE!
525 case GLUT_HAS_SPACEBALL:
526 case GLUT_HAS_DIAL_AND_BUTTON_BOX:
527 case GLUT_HAS_TABLET:
530 case GLUT_NUM_SPACEBALL_BUTTONS:
531 case GLUT_NUM_BUTTON_BOX_BUTTONS:
533 case GLUT_NUM_TABLET_BUTTONS:
536 case GLUT_DEVICE_IGNORE_KEY_REPEAT:
537 return( fgState.IgnoreKeyRepeat );
539 case GLUT_DEVICE_KEY_REPEAT:
541 * XXX WARNING: THIS IS A BIG LIE!
543 return( GLUT_KEY_REPEAT_DEFAULT );
546 fgWarning( "glutDeviceGet(): missing enum handle %i\n", eWhat );
551 * And now -- the failure.
557 * This should return the current state of ALT, SHIFT and CTRL keys.
559 int FGAPIENTRY glutGetModifiers( void )
561 if( fgStructure.Window == NULL )
564 if( fgStructure.Window->State.Modifiers == 0xffffffff )
566 fgWarning( "glutGetModifiers() called outside an input callback" );
570 return( fgStructure.Window->State.Modifiers );
574 * Return the state of the GLUT API overlay subsystem. A misery ;-)
576 int FGAPIENTRY glutLayerGet( GLenum eWhat )
578 freeglut_assert_ready;
581 * This is easy as layers are not implemented ;-)
583 * XXX Can we merge the UNIX/X11 and WIN32 sections? Or
584 * XXX is overlay support planned?
589 #if TARGET_HOST_UNIX_X11
591 case GLUT_OVERLAY_POSSIBLE:
594 case GLUT_LAYER_IN_USE:
595 return( GLUT_NORMAL );
597 case GLUT_HAS_OVERLAY:
600 case GLUT_TRANSPARENT_INDEX:
602 * Return just anything, which is always defined as zero
608 case GLUT_NORMAL_DAMAGED:
610 * XXX Actually I do not know. Maybe.
614 case GLUT_OVERLAY_DAMAGED:
617 #elif TARGET_HOST_WIN32
619 case GLUT_OVERLAY_POSSIBLE:
620 /* return( fgSetupPixelFormat( fgStructure.Window, TRUE, PFD_OVERLAY_PLANE ) ); */
623 case GLUT_LAYER_IN_USE:
624 return( GLUT_NORMAL );
626 case GLUT_HAS_OVERLAY:
629 case GLUT_TRANSPARENT_INDEX:
631 * Return just anything, which is always defined as zero
637 case GLUT_NORMAL_DAMAGED:
639 * XXX Actually I do not know. Maybe.
643 case GLUT_OVERLAY_DAMAGED:
648 fgWarning( "glutLayerGet(): missing enum handle %i\n", eWhat );
653 * And fail. That's good. Programs do love failing.
658 /*** END OF FILE ***/