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 "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 ;
128 if ( eWhat == GLUT_INIT_STATE )
129 return ( fgState.Time.Set ) ;
131 freeglut_assert_ready;
134 * Check what is the caller querying for. In chronological code add order.
138 case GLUT_ELAPSED_TIME:
140 * This is easy and nicely portable, as we are using GLib...
142 return( fgElapsedTime() );
145 * Following values are stored in fgState and fgDisplay global structures
147 case GLUT_SCREEN_WIDTH: return( fgDisplay.ScreenWidth );
148 case GLUT_SCREEN_HEIGHT: return( fgDisplay.ScreenHeight );
149 case GLUT_SCREEN_WIDTH_MM: return( fgDisplay.ScreenWidthMM );
150 case GLUT_SCREEN_HEIGHT_MM: return( fgDisplay.ScreenHeightMM );
151 case GLUT_INIT_WINDOW_X: return( fgState.Position.X );
152 case GLUT_INIT_WINDOW_Y: return( fgState.Position.Y );
153 case GLUT_INIT_WINDOW_WIDTH: return( fgState.Size.X );
154 case GLUT_INIT_WINDOW_HEIGHT: return( fgState.Size.Y );
155 case GLUT_INIT_DISPLAY_MODE: return( fgState.DisplayMode );
158 * The window/context specific queries are handled mostly by fghGetConfig().
160 case GLUT_WINDOW_NUM_SAMPLES:
162 * 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 check them
170 # define GLX_QUERY(a,b) case a: return( fghGetConfig( b ) );
172 GLX_QUERY( GLUT_WINDOW_RGBA, GLX_RGBA );
173 GLX_QUERY( GLUT_WINDOW_DOUBLEBUFFER, GLX_DOUBLEBUFFER );
174 GLX_QUERY( GLUT_WINDOW_BUFFER_SIZE, GLX_BUFFER_SIZE );
175 GLX_QUERY( GLUT_WINDOW_STENCIL_SIZE, GLX_STENCIL_SIZE );
176 GLX_QUERY( GLUT_WINDOW_DEPTH_SIZE, GLX_DEPTH_SIZE );
177 GLX_QUERY( GLUT_WINDOW_RED_SIZE, GLX_RED_SIZE );
178 GLX_QUERY( GLUT_WINDOW_GREEN_SIZE, GLX_GREEN_SIZE );
179 GLX_QUERY( GLUT_WINDOW_BLUE_SIZE, GLX_BLUE_SIZE );
180 GLX_QUERY( GLUT_WINDOW_ALPHA_SIZE, GLX_ALPHA_SIZE );
181 GLX_QUERY( GLUT_WINDOW_ACCUM_RED_SIZE, GLX_ACCUM_RED_SIZE );
182 GLX_QUERY( GLUT_WINDOW_ACCUM_GREEN_SIZE, GLX_ACCUM_GREEN_SIZE );
183 GLX_QUERY( GLUT_WINDOW_ACCUM_BLUE_SIZE, GLX_ACCUM_BLUE_SIZE );
184 GLX_QUERY( GLUT_WINDOW_ACCUM_ALPHA_SIZE, GLX_ACCUM_ALPHA_SIZE );
185 GLX_QUERY( GLUT_WINDOW_STEREO, GLX_STEREO );
190 * Colormap size is handled in a bit different way than all the rest
192 case GLUT_WINDOW_COLORMAP_SIZE:
194 * Check for the visual type
196 if( (fghGetConfig( GLX_RGBA )) || (fgStructure.Window == NULL) )
199 * We've got a RGBA visual, so there is no colormap at all.
200 * The other possibility is that we have no current window set.
206 * Otherwise return the number of entries in the colormap
208 return( fgStructure.Window->Window.VisualInfo->visual->map_entries );
211 * Those calls are somewhat similiar, as they use XGetWindowAttributes() function
216 XWindowAttributes winAttributes;
217 Window another, window;
221 * Return zero if there is no current window set
223 if( fgStructure.Window == NULL )
227 * So, grab the current window's position
229 window = fgStructure.Window->Window.Handle;
232 * Grab the current window's attributes now
234 XGetWindowAttributes(
241 * Correct the results for the parental relation and border size
243 XTranslateCoordinates(
247 -winAttributes.border_width,
248 -winAttributes.border_width,
254 * See if we have to return the X or Y coordinate
256 return( eWhat == GLUT_WINDOW_X ? x : y );
259 case GLUT_WINDOW_WIDTH:
260 case GLUT_WINDOW_HEIGHT:
262 XWindowAttributes winAttributes;
265 * Return zero if there is no current window set
267 if( fgStructure.Window == NULL )
271 * Checking for window's size is much easier:
273 XGetWindowAttributes(
275 fgStructure.Window->Window.Handle,
280 * See if to return the window's width or height
282 return( eWhat == GLUT_WINDOW_WIDTH ? winAttributes.width : winAttributes.height );
286 * I do not know yet if there will be a fgChooseVisual() function for Win32
288 case GLUT_DISPLAY_MODE_POSSIBLE:
290 * Check if the current display mode is possible
292 return( fgChooseVisual() == NULL ? 0 : 1 );
295 * This is system-dependant
297 case GLUT_WINDOW_FORMAT_ID:
299 * Return the visual ID, if there is a current window naturally:
301 if( fgStructure.Window == NULL )
304 return( fgStructure.Window->Window.VisualInfo->visualid );
306 #elif TARGET_HOST_WIN32
309 * Handle the OpenGL inquiries
311 case GLUT_WINDOW_RGBA:
312 glGetBooleanv ( GL_RGBA_MODE, &boolValue ) ; /* True if color buffers store RGBA */
313 returnValue = boolValue ? 1 : 0 ;
314 return ( returnValue ) ;
315 case GLUT_WINDOW_DOUBLEBUFFER:
316 glGetBooleanv ( GL_DOUBLEBUFFER, &boolValue ) ; /* True if front and back buffers exist */
317 returnValue = boolValue ? 1 : 0 ;
318 return ( returnValue ) ;
319 case GLUT_WINDOW_STEREO:
320 glGetBooleanv ( GL_STEREO, &boolValue ) ; /* True if left and right buffers exist */
321 returnValue = boolValue ? 1 : 0 ;
322 return ( returnValue ) ;
324 case GLUT_WINDOW_RED_SIZE:
325 glGetIntegerv ( GL_RED_BITS, &returnValue ) ; /* Number of bits per red component in color buffers */
326 return ( returnValue ) ;
327 case GLUT_WINDOW_GREEN_SIZE:
328 glGetIntegerv ( GL_GREEN_BITS, &returnValue ) ; /* Number of bits per green component in color buffers */
329 return ( returnValue ) ;
330 case GLUT_WINDOW_BLUE_SIZE:
331 glGetIntegerv ( GL_BLUE_BITS, &returnValue ) ; /* Number of bits per blue component in color buffers */
332 return ( returnValue ) ;
333 case GLUT_WINDOW_ALPHA_SIZE:
334 glGetIntegerv ( GL_ALPHA_BITS, &returnValue ) ; /* Number of bits per alpha component in color buffers */
335 return ( returnValue ) ;
336 case GLUT_WINDOW_ACCUM_RED_SIZE:
337 glGetIntegerv ( GL_ACCUM_RED_BITS, &returnValue ) ; /* Number of bits per red component in the accumulation buffer */
338 return ( returnValue ) ;
339 case GLUT_WINDOW_ACCUM_GREEN_SIZE:
340 glGetIntegerv ( GL_ACCUM_GREEN_BITS, &returnValue ) ; /* Number of bits per green component in the accumulation buffer */
341 return ( returnValue ) ;
342 case GLUT_WINDOW_ACCUM_BLUE_SIZE:
343 glGetIntegerv ( GL_ACCUM_BLUE_BITS, &returnValue ) ; /* Number of bits per blue component in the accumulation buffer */
344 return ( returnValue ) ;
345 case GLUT_WINDOW_ACCUM_ALPHA_SIZE:
346 glGetIntegerv ( GL_ACCUM_ALPHA_BITS, &returnValue ) ; /* Number of bits per alpha component in the accumulation buffer */
347 return ( returnValue ) ;
348 case GLUT_WINDOW_DEPTH_SIZE:
349 glGetIntegerv ( GL_DEPTH_BITS, &returnValue ) ; /* Number of depth-buffer bitplanes */
350 return ( returnValue ) ;
352 case GLUT_WINDOW_BUFFER_SIZE:
353 returnValue = 1 ; /* ????? */
354 return ( returnValue ) ;
355 case GLUT_WINDOW_STENCIL_SIZE:
356 returnValue = 0 ; /* ????? */
357 return ( returnValue ) ;
360 * Window position and size
364 case GLUT_WINDOW_WIDTH:
365 case GLUT_WINDOW_HEIGHT:
370 * Check if there is a window to be queried for dimensions:
372 freeglut_return_val_if_fail( fgStructure.Window != NULL, 0 );
375 * We need to call GetWindowRect() first...
377 GetWindowRect( fgStructure.Window->Window.Handle, &winRect );
380 * ...then we've got to correct the results we've just received...
382 if ( fgStructure.Window->Parent == NULL )
384 winRect.left += GetSystemMetrics( SM_CXSIZEFRAME ) - 1;
385 winRect.right -= GetSystemMetrics( SM_CXSIZEFRAME ) - 1;
386 winRect.top += GetSystemMetrics( SM_CYSIZEFRAME ) - 1 + GetSystemMetrics( SM_CYCAPTION );
387 winRect.bottom -= GetSystemMetrics( SM_CYSIZEFRAME ) + 1;
391 * ...and finally return the caller the desired value:
395 case GLUT_WINDOW_X: return( winRect.left );
396 case GLUT_WINDOW_Y: return( winRect.top );
397 case GLUT_WINDOW_WIDTH: return( winRect.right - winRect.left );
398 case GLUT_WINDOW_HEIGHT: return( winRect.bottom - winRect.top );
403 case GLUT_DISPLAY_MODE_POSSIBLE:
405 * Check if the current display mode is possible
407 return( fgSetupPixelFormat( fgStructure.Window, TRUE, PFD_MAIN_PLANE ) );
409 case GLUT_WINDOW_FORMAT_ID:
411 * Return the pixel format of the current window
413 if( fgStructure.Window != NULL )
414 return( GetPixelFormat( fgStructure.Window->Window.Device ) );
417 * If the current window does not exist, fail:
424 * The window structure queries
426 case GLUT_WINDOW_PARENT:
428 * Return the ID number of current window's parent, if any
430 if( fgStructure.Window == NULL ) return( 0 );
431 if( fgStructure.Window->Parent == NULL ) return( 0 );
433 return( fgStructure.Window->Parent->ID );
435 case GLUT_WINDOW_NUM_CHILDREN:
437 * Return the number of children attached to the current window
439 if( fgStructure.Window == NULL )
442 return( fgListLength( &fgStructure.Window->Children ) );
444 case GLUT_WINDOW_CURSOR:
446 * Return the currently selected window cursor
448 if( fgStructure.Window == NULL )
451 return( fgStructure.Window->State.Cursor );
453 case GLUT_MENU_NUM_ITEMS:
455 * Return the number of menu entries in the current menu
457 if( fgStructure.Menu == NULL )
460 return( fgListLength( &fgStructure.Menu->Entries ) );
462 case GLUT_ACTION_ON_WINDOW_CLOSE: return ( fgState.ActionOnWindowClose ) ;
466 * Just have it reported, so that we can see what needs to be implemented
468 fgWarning( "glutGet(): missing enum handle %i\n", eWhat );
473 * If nothing happens, then we are in deep trouble...
479 * Returns various device information.
481 int FGAPIENTRY glutDeviceGet( GLenum eWhat )
483 freeglut_assert_ready;
486 * See why are we bothered...
488 * WARNING: we are mostly lying in this function.
492 case GLUT_HAS_KEYBOARD:
494 * We always have a keyboard present on PC machines...
498 #if TARGET_HOST_UNIX_X11
502 * Hey, my Atari 65XE hasn't had a mouse!
506 case GLUT_NUM_MOUSE_BUTTONS:
508 * Return the number of mouse buttons available. This is a big guess.
512 #elif TARGET_HOST_WIN32
516 * The Windows can be booted without a mouse.
517 * It would be nice to have this reported.
519 return( GetSystemMetrics( SM_MOUSEPRESENT ) );
521 case GLUT_NUM_MOUSE_BUTTONS:
523 * We are much more fortunate under Win32 about this...
525 return( GetSystemMetrics( SM_CMOUSEBUTTONS ) );
529 case GLUT_JOYSTICK_POLL_RATE:
530 case GLUT_HAS_JOYSTICK:
531 case GLUT_JOYSTICK_BUTTONS:
532 case GLUT_JOYSTICK_AXES:
534 * WARNING: THIS IS A BIG LIE!
538 case GLUT_HAS_SPACEBALL:
539 case GLUT_HAS_DIAL_AND_BUTTON_BOX:
540 case GLUT_HAS_TABLET:
542 * Sounds cool. And unuseful.
546 case GLUT_NUM_SPACEBALL_BUTTONS:
547 case GLUT_NUM_BUTTON_BOX_BUTTONS:
549 case GLUT_NUM_TABLET_BUTTONS:
551 * Zero is not the answer. Zero is the question. Continuum is the answer.
555 case GLUT_DEVICE_IGNORE_KEY_REPEAT:
557 * Return what we think about the key auto repeat settings
559 return( fgState.IgnoreKeyRepeat );
561 case GLUT_DEVICE_KEY_REPEAT:
563 * WARNING: THIS IS A BIG LIE!
565 return( GLUT_KEY_REPEAT_DEFAULT );
571 fgWarning( "glutDeviceGet(): missing enum handle %i\n", eWhat );
576 * And now -- the failure.
582 * This should return the current state of ALT, SHIFT and CTRL keys.
584 int FGAPIENTRY glutGetModifiers( void )
587 * Fail if there is no current window or called outside an input callback
589 if( fgStructure.Window == NULL )
592 if( fgStructure.Window->State.Modifiers == 0xffffffff )
594 fgWarning( "glutGetModifiers() called outside an input callback" );
599 * Return the current modifiers state otherwise
601 return( fgStructure.Window->State.Modifiers );
605 * Return the state of the GLUT API overlay subsystem. A misery ;-)
607 int FGAPIENTRY glutLayerGet( GLenum eWhat )
609 freeglut_assert_ready;
612 * This is easy as layers are not implemented ;-)
617 #if TARGET_HOST_UNIX_X11
619 case GLUT_OVERLAY_POSSIBLE:
621 * Nope, overlays are not possible.
625 case GLUT_LAYER_IN_USE:
627 * The normal plane is always in use
629 return( GLUT_NORMAL );
631 case GLUT_HAS_OVERLAY:
633 * No window is allowed to have an overlay
637 case GLUT_TRANSPARENT_INDEX:
639 * Return just anything, which is always defined as zero
643 case GLUT_NORMAL_DAMAGED:
645 * Actually I do not know. Maybe.
649 case GLUT_OVERLAY_DAMAGED:
651 * Return minus one to mark that no layer is in use
655 #elif TARGET_HOST_WIN32
657 case GLUT_OVERLAY_POSSIBLE:
659 * Check if an overlay display mode is possible
661 return( fgSetupPixelFormat( fgStructure.Window, TRUE, PFD_OVERLAY_PLANE ) );
663 case GLUT_LAYER_IN_USE:
665 * The normal plane is always in use
667 return( GLUT_NORMAL );
669 case GLUT_HAS_OVERLAY:
671 * No window is allowed to have an overlay
675 case GLUT_TRANSPARENT_INDEX:
677 * Return just anything, which is always defined as zero
681 case GLUT_NORMAL_DAMAGED:
683 * Actually I do not know. Maybe.
687 case GLUT_OVERLAY_DAMAGED:
689 * Return minus one to mark that no layer is in use
696 * Complain to the user about the obvious bug
698 fgWarning( "glutLayerGet(): missing enum handle %i\n", eWhat );
703 * And fail. That's good. Programs do love failing.
708 /*** END OF FILE ***/