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 #define G_LOG_DOMAIN "freeglut-state"
34 #include "../include/GL/freeglut.h"
35 #include "../include/GL/freeglut_internal.h"
38 * TODO BEFORE THE STABLE RELEASE:
40 * glutGet() -- X11 tests passed, but check if all enums handled (what about Win32?)
41 * glutDeviceGet() -- X11 tests passed, but check if all enums 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 )
61 * Return nothing if there is no current window set
63 if( fgStructure.Window == NULL )
67 * glXGetConfig should work fine
69 glXGetConfig( fgDisplay.Display, fgStructure.Window->Window.VisualInfo, attribute, &returnValue );
73 * Have the query results returned
75 return ( returnValue ) ;
79 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
82 * General settings assignment method
84 void FGAPIENTRY glutSetOption( GLenum eWhat, int value )
86 freeglut_assert_ready;
89 * Check what is the caller querying for. In chronological code add order.
93 case GLUT_INIT_WINDOW_X: fgState.Position.X = (GLint)value ;
95 case GLUT_INIT_WINDOW_Y: fgState.Position.Y = (GLint)value ;
97 case GLUT_INIT_WINDOW_WIDTH: fgState.Size.X = (GLint)value ;
99 case GLUT_INIT_WINDOW_HEIGHT: fgState.Size.Y = (GLint)value ;
101 case GLUT_INIT_DISPLAY_MODE: fgState.DisplayMode = (unsigned int)value ;
104 case GLUT_ACTION_ON_WINDOW_CLOSE: fgState.ActionOnWindowClose = value ;
107 case GLUT_WINDOW_CURSOR:
108 if( fgStructure.Window != NULL ) fgStructure.Window->State.Cursor = value ;
113 * Just have it reported, so that we can see what needs to be implemented
115 fgWarning( "glutSetOption(): missing enum handle %i\n", eWhat );
121 * General settings query method
123 int FGAPIENTRY glutGet( GLenum eWhat )
126 GLboolean boolValue ;
127 freeglut_assert_ready;
130 * Check what is the caller querying for. In chronological code add order.
134 case GLUT_ELAPSED_TIME:
136 * This is easy and nicely portable, as we are using GLib...
138 return( fgElapsedTime() );
141 * Following values are stored in fgState and fgDisplay global structures
143 case GLUT_SCREEN_WIDTH: return( fgDisplay.ScreenWidth );
144 case GLUT_SCREEN_HEIGHT: return( fgDisplay.ScreenHeight );
145 case GLUT_SCREEN_WIDTH_MM: return( fgDisplay.ScreenWidthMM );
146 case GLUT_SCREEN_HEIGHT_MM: return( fgDisplay.ScreenHeightMM );
147 case GLUT_INIT_WINDOW_X: return( fgState.Position.X );
148 case GLUT_INIT_WINDOW_Y: return( fgState.Position.Y );
149 case GLUT_INIT_WINDOW_WIDTH: return( fgState.Size.X );
150 case GLUT_INIT_WINDOW_HEIGHT: return( fgState.Size.Y );
151 case GLUT_INIT_DISPLAY_MODE: return( fgState.DisplayMode );
154 * The window/context specific queries are handled mostly by fghGetConfig().
156 case GLUT_WINDOW_NUM_SAMPLES:
158 * Multisampling. Return what I know about multisampling.
162 #if TARGET_HOST_UNIX_X11
164 * The rest of GLX queries under X are general enough to use a macro to check them
166 # define GLX_QUERY(a,b) case a: return( fghGetConfig( b ) );
168 GLX_QUERY( GLUT_WINDOW_RGBA, GLX_RGBA );
169 GLX_QUERY( GLUT_WINDOW_DOUBLEBUFFER, GLX_DOUBLEBUFFER );
170 GLX_QUERY( GLUT_WINDOW_BUFFER_SIZE, GLX_BUFFER_SIZE );
171 GLX_QUERY( GLUT_WINDOW_STENCIL_SIZE, GLX_STENCIL_SIZE );
172 GLX_QUERY( GLUT_WINDOW_DEPTH_SIZE, GLX_DEPTH_SIZE );
173 GLX_QUERY( GLUT_WINDOW_RED_SIZE, GLX_RED_SIZE );
174 GLX_QUERY( GLUT_WINDOW_GREEN_SIZE, GLX_GREEN_SIZE );
175 GLX_QUERY( GLUT_WINDOW_BLUE_SIZE, GLX_BLUE_SIZE );
176 GLX_QUERY( GLUT_WINDOW_ALPHA_SIZE, GLX_ALPHA_SIZE );
177 GLX_QUERY( GLUT_WINDOW_ACCUM_RED_SIZE, GLX_ACCUM_RED_SIZE );
178 GLX_QUERY( GLUT_WINDOW_ACCUM_GREEN_SIZE, GLX_ACCUM_GREEN_SIZE );
179 GLX_QUERY( GLUT_WINDOW_ACCUM_BLUE_SIZE, GLX_ACCUM_BLUE_SIZE );
180 GLX_QUERY( GLUT_WINDOW_ACCUM_ALPHA_SIZE, GLX_ACCUM_ALPHA_SIZE );
181 GLX_QUERY( GLUT_WINDOW_STEREO, GLX_STEREO );
186 * Colormap size is handled in a bit different way than all the rest
188 case GLUT_WINDOW_COLORMAP_SIZE:
190 * Check for the visual type
192 if( (fghGetConfig( GLX_RGBA )) || (fgStructure.Window == NULL) )
195 * We've got a RGBA visual, so there is no colormap at all.
196 * The other possibility is that we have no current window set.
202 * Otherwise return the number of entries in the colormap
204 return( fgStructure.Window->Window.VisualInfo->visual->map_entries );
207 * Those calls are somewhat similiar, as they use XGetWindowAttributes() function
212 XWindowAttributes winAttributes;
213 Window another, window;
217 * Return zero if there is no current window set
219 if( fgStructure.Window == NULL )
223 * So, grab the current window's position
225 window = fgStructure.Window->Window.Handle;
228 * Grab the current window's attributes now
230 XGetWindowAttributes(
237 * Correct the results for the parental relation and border size
239 XTranslateCoordinates(
243 -winAttributes.border_width,
244 -winAttributes.border_width,
250 * See if we have to return the X or Y coordinate
252 return( eWhat == GLUT_WINDOW_X ? x : y );
255 case GLUT_WINDOW_WIDTH:
256 case GLUT_WINDOW_HEIGHT:
258 XWindowAttributes winAttributes;
261 * Return zero if there is no current window set
263 if( fgStructure.Window == NULL )
267 * Checking for window's size is much easier:
269 XGetWindowAttributes(
271 fgStructure.Window->Window.Handle,
276 * See if to return the window's width or height
278 return( eWhat == GLUT_WINDOW_WIDTH ? winAttributes.width : winAttributes.height );
282 * I do not know yet if there will be a fgChooseVisual() function for Win32
284 case GLUT_DISPLAY_MODE_POSSIBLE:
286 * Check if the current display mode is possible
288 return( fgChooseVisual() == NULL ? 0 : 1 );
291 * This is system-dependant
293 case GLUT_WINDOW_FORMAT_ID:
295 * Return the visual ID, if there is a current window naturally:
297 if( fgStructure.Window == NULL )
300 return( fgStructure.Window->Window.VisualInfo->visualid );
302 #elif TARGET_HOST_WIN32
305 * Handle the OpenGL inquiries
307 case GLUT_WINDOW_RGBA:
308 glGetBooleanv ( GL_RGBA_MODE, &boolValue ) ; /* True if color buffers store RGBA */
309 returnValue = boolValue ? 1 : 0 ;
310 return ( returnValue ) ;
311 case GLUT_WINDOW_DOUBLEBUFFER:
312 glGetBooleanv ( GL_DOUBLEBUFFER, &boolValue ) ; /* True if front and back buffers exist */
313 returnValue = boolValue ? 1 : 0 ;
314 return ( returnValue ) ;
315 case GLUT_WINDOW_STEREO:
316 glGetBooleanv ( GL_STEREO, &boolValue ) ; /* True if left and right buffers exist */
317 returnValue = boolValue ? 1 : 0 ;
318 return ( returnValue ) ;
320 case GLUT_WINDOW_RED_SIZE:
321 glGetIntegerv ( GL_RED_BITS, &returnValue ) ; /* Number of bits per red component in color buffers */
322 return ( returnValue ) ;
323 case GLUT_WINDOW_GREEN_SIZE:
324 glGetIntegerv ( GL_GREEN_BITS, &returnValue ) ; /* Number of bits per green component in color buffers */
325 return ( returnValue ) ;
326 case GLUT_WINDOW_BLUE_SIZE:
327 glGetIntegerv ( GL_BLUE_BITS, &returnValue ) ; /* Number of bits per blue component in color buffers */
328 return ( returnValue ) ;
329 case GLUT_WINDOW_ALPHA_SIZE:
330 glGetIntegerv ( GL_ALPHA_BITS, &returnValue ) ; /* Number of bits per alpha component in color buffers */
331 return ( returnValue ) ;
332 case GLUT_WINDOW_ACCUM_RED_SIZE:
333 glGetIntegerv ( GL_ACCUM_RED_BITS, &returnValue ) ; /* Number of bits per red component in the accumulation buffer */
334 return ( returnValue ) ;
335 case GLUT_WINDOW_ACCUM_GREEN_SIZE:
336 glGetIntegerv ( GL_ACCUM_GREEN_BITS, &returnValue ) ; /* Number of bits per green component in the accumulation buffer */
337 return ( returnValue ) ;
338 case GLUT_WINDOW_ACCUM_BLUE_SIZE:
339 glGetIntegerv ( GL_ACCUM_BLUE_BITS, &returnValue ) ; /* Number of bits per blue component in the accumulation buffer */
340 return ( returnValue ) ;
341 case GLUT_WINDOW_ACCUM_ALPHA_SIZE:
342 glGetIntegerv ( GL_ACCUM_ALPHA_BITS, &returnValue ) ; /* Number of bits per alpha component in the accumulation buffer */
343 return ( returnValue ) ;
344 case GLUT_WINDOW_DEPTH_SIZE:
345 glGetIntegerv ( GL_DEPTH_BITS, &returnValue ) ; /* Number of depth-buffer bitplanes */
346 return ( returnValue ) ;
348 case GLUT_WINDOW_BUFFER_SIZE:
349 returnValue = 1 ; /* ????? */
350 return ( returnValue ) ;
351 case GLUT_WINDOW_STENCIL_SIZE:
352 returnValue = 0 ; /* ????? */
353 return ( returnValue ) ;
356 * Window position and size
360 case GLUT_WINDOW_WIDTH:
361 case GLUT_WINDOW_HEIGHT:
366 * Check if there is a window to be queried for dimensions:
368 freeglut_return_val_if_fail( fgStructure.Window != NULL, 0 );
371 * We need to call GetWindowRect() first...
373 GetWindowRect( fgStructure.Window->Window.Handle, &winRect );
376 * ...then we've got to correct the results we've just received...
378 winRect.left += GetSystemMetrics( SM_CXSIZEFRAME ) - 1;
379 winRect.right -= GetSystemMetrics( SM_CXSIZEFRAME ) - 1;
380 winRect.top += GetSystemMetrics( SM_CYSIZEFRAME ) - 1 + GetSystemMetrics( SM_CYCAPTION );
381 winRect.bottom -= GetSystemMetrics( SM_CYSIZEFRAME ) + 1;
384 * ...and finally return the caller the desired value:
388 case GLUT_WINDOW_X: return( winRect.left );
389 case GLUT_WINDOW_Y: return( winRect.top );
390 case GLUT_WINDOW_WIDTH: return( winRect.right - winRect.left );
391 case GLUT_WINDOW_HEIGHT: return( winRect.bottom - winRect.top );
396 case GLUT_DISPLAY_MODE_POSSIBLE:
398 * Check if the current display mode is possible
400 return( fgSetupPixelFormat( fgStructure.Window, TRUE ) );
402 case GLUT_WINDOW_FORMAT_ID:
404 * Return the pixel format of the current window
406 if( fgStructure.Window != NULL )
407 return( GetPixelFormat( fgStructure.Window->Window.Device ) );
410 * If the current window does not exist, fail:
417 * The window structure queries
419 case GLUT_WINDOW_PARENT:
421 * Return the ID number of current window's parent, if any
423 if( fgStructure.Window == NULL ) return( 0 );
424 if( fgStructure.Window->Parent == NULL ) return( 0 );
426 return( fgStructure.Window->Parent->ID );
428 case GLUT_WINDOW_NUM_CHILDREN:
430 * Return the number of children attached to the current window
432 if( fgStructure.Window == NULL )
435 return( fgListLength( &fgStructure.Window->Children ) );
437 case GLUT_WINDOW_CURSOR:
439 * Return the currently selected window cursor
441 if( fgStructure.Window == NULL )
444 return( fgStructure.Window->State.Cursor );
446 case GLUT_MENU_NUM_ITEMS:
448 * Return the number of menu entries in the current menu
450 if( fgStructure.Menu == NULL )
453 return( fgListLength( &fgStructure.Menu->Entries ) );
455 case GLUT_ACTION_ON_WINDOW_CLOSE: return ( fgState.ActionOnWindowClose ) ;
459 * Just have it reported, so that we can see what needs to be implemented
461 fgWarning( "glutGet(): missing enum handle %i\n", eWhat );
466 * If nothing happens, then we are in deep trouble...
472 * Returns various device information.
474 int FGAPIENTRY glutDeviceGet( GLenum eWhat )
476 freeglut_assert_ready;
479 * See why are we bothered...
481 * WARNING: we are mostly lying in this function.
485 case GLUT_HAS_KEYBOARD:
487 * We always have a keyboard present on PC machines...
491 #if TARGET_HOST_UNIX_X11
495 * Hey, my Atari 65XE hasn't had a mouse!
499 case GLUT_NUM_MOUSE_BUTTONS:
501 * Return the number of mouse buttons available. This is a big guess.
505 #elif TARGET_HOST_WIN32
509 * The Windows can be booted without a mouse.
510 * It would be nice to have this reported.
512 return( GetSystemMetrics( SM_MOUSEPRESENT ) );
514 case GLUT_NUM_MOUSE_BUTTONS:
516 * We are much more fortunate under Win32 about this...
518 return( GetSystemMetrics( SM_CMOUSEBUTTONS ) );
522 case GLUT_JOYSTICK_POLL_RATE:
523 case GLUT_HAS_JOYSTICK:
524 case GLUT_JOYSTICK_BUTTONS:
525 case GLUT_JOYSTICK_AXES:
527 * WARNING: THIS IS A BIG LIE!
531 case GLUT_HAS_SPACEBALL:
532 case GLUT_HAS_DIAL_AND_BUTTON_BOX:
533 case GLUT_HAS_TABLET:
535 * Sounds cool. And unuseful.
539 case GLUT_NUM_SPACEBALL_BUTTONS:
540 case GLUT_NUM_BUTTON_BOX_BUTTONS:
542 case GLUT_NUM_TABLET_BUTTONS:
544 * Zero is not the answer. Zero is the question. Continuum is the answer.
548 case GLUT_DEVICE_IGNORE_KEY_REPEAT:
550 * Return what we think about the key auto repeat settings
552 return( fgState.IgnoreKeyRepeat );
554 case GLUT_DEVICE_KEY_REPEAT:
556 * WARNING: THIS IS A BIG LIE!
558 return( GLUT_KEY_REPEAT_DEFAULT );
564 fgWarning( "glutDeviceGet(): missing enum handle %i\n", eWhat );
569 * And now -- the failure.
575 * This should return the current state of ALT, SHIFT and CTRL keys.
577 int FGAPIENTRY glutGetModifiers( void )
580 * Fail if there is no current window or called outside an input callback
582 if( fgStructure.Window == NULL )
585 if( fgStructure.Window->State.Modifiers == 0xffffffff )
587 fgWarning( "glutGetModifiers() called outside an input callback" );
592 * Return the current modifiers state otherwise
594 return( fgStructure.Window->State.Modifiers );
598 * Return the state of the GLUT API overlay subsystem. A misery ;-)
600 int FGAPIENTRY glutLayerGet( GLenum eWhat )
602 freeglut_assert_ready;
605 * This is easy as layers are not implemented ;-)
609 case GLUT_OVERLAY_POSSIBLE:
611 * Nope, overlays are not possible.
615 case GLUT_LAYER_IN_USE:
617 * The normal plane is always in use
619 return( GLUT_NORMAL );
621 case GLUT_HAS_OVERLAY:
623 * No window is allowed to have an overlay
627 case GLUT_TRANSPARENT_INDEX:
629 * Return just anything, which is always defined as zero
633 case GLUT_NORMAL_DAMAGED:
635 * Actually I do not know. Maybe.
639 case GLUT_OVERLAY_DAMAGED:
641 * Return minus one to mark that no layer is in use
647 * Complain to the user about the obvious bug
649 fgWarning( "glutLayerGet(): missing enum handle %i\n", eWhat );
654 * And fail. That's good. Programs do love failing.
659 /*** END OF FILE ***/