git.mutantstargoat.com Git - freeglut/blob - src/fg_state.c

   1 /*
   2  * freeglut_state.c
   3  *
   4  * Freeglut state query 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: Thu Dec 16 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 "fg_internal.h"
  30
  31 /*
  32  * TODO BEFORE THE STABLE RELEASE:
  33  *
  34  *  glutGet()               -- X11 tests passed, but check if all enums
  35  *                             handled (what about Win32?)
  36  *  glutDeviceGet()         -- X11 tests passed, but check if all enums
  37  *                             handled (what about Win32?)
  38  *  glutGetModifiers()      -- OK, but could also remove the limitation
  39  *  glutLayerGet()          -- what about GLUT_NORMAL_DAMAGED?
  40  *
  41  * The fail-on-call policy will help adding the most needed things imho.
  42  */
  43
  44 extern int fgPlatformGlutGet ( GLenum eWhat );
  45 extern int fgPlatformGlutDeviceGet ( GLenum eWhat );
  46 extern int *fgPlatformGlutGetModeValues(GLenum eWhat, int *size);
  47 extern SFG_Font* fghFontByID( void* font );
  48
  49
  50 /* -- LOCAL DEFINITIONS ---------------------------------------------------- */
  51
  52 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
  53
  54
  55 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
  56
  57 /*
  58  * General settings assignment method
  59  */
  60 void FGAPIENTRY glutSetOption( GLenum eWhat, int value )
  61 {
  62     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetOption" );
  63
  64     switch( eWhat )
  65     {
  66     case GLUT_INIT_WINDOW_X:
  67         fgState.Position.X = (GLint)value;
  68         break;
  69
  70     case GLUT_INIT_WINDOW_Y:
  71         fgState.Position.Y = (GLint)value;
  72         break;
  73
  74     case GLUT_INIT_WINDOW_WIDTH:
  75         fgState.Size.X = (GLint)value;
  76         break;
  77
  78     case GLUT_INIT_WINDOW_HEIGHT:
  79         fgState.Size.Y = (GLint)value;
  80         break;
  81
  82     case GLUT_INIT_DISPLAY_MODE:
  83         fgState.DisplayMode = (unsigned int)value;
  84         break;
  85
  86     case GLUT_ACTION_ON_WINDOW_CLOSE:
  87         fgState.ActionOnWindowClose = value;
  88         break;
  89
  90     case GLUT_RENDERING_CONTEXT:
  91         fgState.UseCurrentContext =
  92             ( value == GLUT_USE_CURRENT_CONTEXT ) ? GL_TRUE : GL_FALSE;
  93         break;
  94
  95     case GLUT_DIRECT_RENDERING:
  96         fgState.DirectContext = value;
  97         break;
  98
  99     case GLUT_WINDOW_CURSOR:
 100         if( fgStructure.CurrentWindow != NULL )
 101             fgStructure.CurrentWindow->State.Cursor = value;
 102         break;
 103
 104     case GLUT_AUX:
 105       fgState.AuxiliaryBufferNumber = value;
 106       break;
 107
 108     case GLUT_MULTISAMPLE:
 109       fgState.SampleNumber = value;
 110       break;
 111
 112     case GLUT_SKIP_STALE_MOTION_EVENTS:
 113       fgState.SkipStaleMotion = value;
 114       break;
 115
 116     case GLUT_GEOMETRY_VISUALIZE_NORMALS:
 117       if( fgStructure.CurrentWindow != NULL )
 118         fgStructure.CurrentWindow->State.VisualizeNormals = value;
 119       break;
 120
 121     default:
 122         fgWarning( "glutSetOption(): missing enum handle %d", eWhat );
 123         break;
 124     }
 125 }
 126
 127 /*
 128  * General settings query method
 129  */
 130 int FGAPIENTRY glutGet( GLenum eWhat )
 131 {
 132     switch (eWhat)
 133     {
 134     case GLUT_INIT_STATE:
 135         return fgState.Initialised;
 136
 137     /* Although internally the time store is 64bits wide, the return value
 138      * here still wraps every 49.7 days. Integer overflows cancel however
 139      * when subtracting an initial start time, unless the total time exceeds
 140      * 32-bit, so you can still work with this.
 141      * XXX: a glutGet64 to return the time might be an idea...
 142      */
 143     case GLUT_ELAPSED_TIME:
 144         return (int) fgElapsedTime();
 145     }
 146
 147     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGet" );
 148
 149     switch( eWhat )
 150     {
 151     /* Following values are stored in fgState and fgDisplay global structures */
 152     case GLUT_SCREEN_WIDTH:         return fgDisplay.ScreenWidth   ;
 153     case GLUT_SCREEN_HEIGHT:        return fgDisplay.ScreenHeight  ;
 154     case GLUT_SCREEN_WIDTH_MM:      return fgDisplay.ScreenWidthMM ;
 155     case GLUT_SCREEN_HEIGHT_MM:     return fgDisplay.ScreenHeightMM;
 156     case GLUT_INIT_WINDOW_X:        return fgState.Position.Use ?
 157                                            fgState.Position.X : -1 ;
 158     case GLUT_INIT_WINDOW_Y:        return fgState.Position.Use ?
 159                                            fgState.Position.Y : -1 ;
 160     case GLUT_INIT_WINDOW_WIDTH:    return fgState.Size.Use ?
 161                                            fgState.Size.X : -1     ;
 162     case GLUT_INIT_WINDOW_HEIGHT:   return fgState.Size.Use ?
 163                                            fgState.Size.Y : -1     ;
 164     case GLUT_INIT_DISPLAY_MODE:    return fgState.DisplayMode     ;
 165     case GLUT_INIT_MAJOR_VERSION:   return fgState.MajorVersion    ;
 166     case GLUT_INIT_MINOR_VERSION:   return fgState.MinorVersion    ;
 167     case GLUT_INIT_FLAGS:           return fgState.ContextFlags    ;
 168     case GLUT_INIT_PROFILE:         return fgState.ContextProfile  ;
 169
 170     /* The window structure queries */
 171     case GLUT_WINDOW_PARENT:
 172         if( fgStructure.CurrentWindow         == NULL ) return 0;
 173         if( fgStructure.CurrentWindow->Parent == NULL ) return 0;
 174         return fgStructure.CurrentWindow->Parent->ID;
 175
 176     case GLUT_WINDOW_NUM_CHILDREN:
 177         if( fgStructure.CurrentWindow == NULL )
 178             return 0;
 179         return fgListLength( &fgStructure.CurrentWindow->Children );
 180
 181     case GLUT_WINDOW_CURSOR:
 182         if( fgStructure.CurrentWindow == NULL )
 183             return 0;
 184         return fgStructure.CurrentWindow->State.Cursor;
 185
 186     case GLUT_MENU_NUM_ITEMS:
 187         if( fgStructure.CurrentMenu == NULL )
 188             return 0;
 189         return fgListLength( &fgStructure.CurrentMenu->Entries );
 190
 191     case GLUT_ACTION_ON_WINDOW_CLOSE:
 192         return fgState.ActionOnWindowClose;
 193
 194     case GLUT_VERSION :
 195         return VERSION_MAJOR * 10000 + VERSION_MINOR * 100 + VERSION_PATCH;
 196
 197     case GLUT_RENDERING_CONTEXT:
 198         return fgState.UseCurrentContext ? GLUT_USE_CURRENT_CONTEXT
 199                                          : GLUT_CREATE_NEW_CONTEXT;
 200
 201     case GLUT_DIRECT_RENDERING:
 202         return fgState.DirectContext;
 203
 204     case GLUT_FULL_SCREEN:
 205         return fgStructure.CurrentWindow->State.IsFullscreen;
 206
 207     case GLUT_AUX:
 208       return fgState.AuxiliaryBufferNumber;
 209
 210     case GLUT_MULTISAMPLE:
 211       return fgState.SampleNumber;
 212
 213     case GLUT_SKIP_STALE_MOTION_EVENTS:
 214       return fgState.SkipStaleMotion;
 215
 216     case GLUT_GEOMETRY_VISUALIZE_NORMALS:
 217       if( fgStructure.CurrentWindow == NULL )
 218         return GL_FALSE;
 219       return fgStructure.CurrentWindow->State.VisualizeNormals;
 220
 221     default:
 222         return fgPlatformGlutGet ( eWhat );
 223         break;
 224     }
 225     return -1;
 226 }
 227
 228 /*
 229  * Returns various device information.
 230  */
 231 int FGAPIENTRY glutDeviceGet( GLenum eWhat )
 232 {
 233     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDeviceGet" );
 234
 235     /* XXX WARNING: we are mostly lying in this function. */
 236     switch( eWhat )
 237     {
 238     case GLUT_HAS_JOYSTICK:
 239         return fgJoystickDetect ();
 240
 241     case GLUT_OWNS_JOYSTICK:
 242         return fgState.JoysticksInitialised;
 243
 244     case GLUT_JOYSTICK_POLL_RATE:
 245         return fgStructure.CurrentWindow ? fgStructure.CurrentWindow->State.JoystickPollRate : 0;
 246
 247     /* XXX The following two are only for Joystick 0 but this is an improvement */
 248     case GLUT_JOYSTICK_BUTTONS:
 249         return glutJoystickGetNumButtons ( 0 );
 250
 251     case GLUT_JOYSTICK_AXES:
 252         return glutJoystickGetNumAxes ( 0 );
 253
 254     case GLUT_HAS_DIAL_AND_BUTTON_BOX:
 255         return fgInputDeviceDetect ();
 256
 257     case GLUT_NUM_DIALS:
 258         if ( fgState.InputDevsInitialised ) return 8;
 259         return 0;
 260
 261     case GLUT_NUM_BUTTON_BOX_BUTTONS:
 262         return 0;
 263
 264     case GLUT_HAS_SPACEBALL:
 265         return fgHasSpaceball();
 266
 267     case GLUT_HAS_TABLET:
 268         return 0;
 269
 270     case GLUT_NUM_SPACEBALL_BUTTONS:
 271         return fgSpaceballNumButtons();
 272
 273     case GLUT_NUM_TABLET_BUTTONS:
 274         return 0;
 275
 276     case GLUT_DEVICE_IGNORE_KEY_REPEAT:
 277         return fgStructure.CurrentWindow ? fgStructure.CurrentWindow->State.IgnoreKeyRepeat : 0;
 278
 279     case GLUT_DEVICE_KEY_REPEAT:
 280         return fgState.KeyRepeat;
 281
 282     default:
 283                 return fgPlatformGlutDeviceGet ( eWhat );
 284     }
 285
 286     /* And now -- the failure. */
 287     return -1;
 288 }
 289
 290 /*
 291  * This should return the current state of ALT, SHIFT and CTRL keys.
 292  */
 293 int FGAPIENTRY glutGetModifiers( void )
 294 {
 295     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetModifiers" );
 296     if( fgState.Modifiers == INVALID_MODIFIERS )
 297     {
 298         fgWarning( "glutGetModifiers() called outside an input callback" );
 299         return 0;
 300     }
 301
 302     return fgState.Modifiers;
 303 }
 304
 305 /*
 306  * Return the state of the GLUT API overlay subsystem. A misery ;-)
 307  */
 308 int FGAPIENTRY glutLayerGet( GLenum eWhat )
 309 {
 310     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutLayerGet" );
 311
 312     /*
 313      * This is easy as layers are not implemented and
 314      * overlay support is not planned. E.g. on Windows,
 315      * overlay requests in PFDs are ignored
 316      * (see iLayerType at http://msdn.microsoft.com/en-us/library/dd368826(v=vs.85).aspx)
 317      */
 318     switch( eWhat )
 319     {
 320
 321     case GLUT_OVERLAY_POSSIBLE:
 322         return 0 ;
 323
 324     case GLUT_LAYER_IN_USE:
 325         return GLUT_NORMAL;
 326
 327     case GLUT_HAS_OVERLAY:
 328         return 0;
 329
 330     case GLUT_TRANSPARENT_INDEX:
 331         /*
 332         * Return just anything, which is always defined as zero
 333         *
 334         * XXX HUH?
 335         */
 336         return 0;
 337
 338     case GLUT_NORMAL_DAMAGED:
 339         /* XXX Actually I do not know. Maybe. */
 340         return 0;
 341
 342     case GLUT_OVERLAY_DAMAGED:
 343         return -1;
 344
 345     default:
 346         fgWarning( "glutLayerGet(): missing enum handle %d", eWhat );
 347         break;
 348     }
 349
 350     /* And fail. That's good. Programs do love failing. */
 351     return -1;
 352 }
 353
 354 int * FGAPIENTRY glutGetModeValues(GLenum eWhat, int *size)
 355 {
 356   int *array;
 357
 358   FREEGLUT_EXIT_IF_NOT_INITIALISED("glutGetModeValues");
 359
 360   *size = 0;
 361   array = fgPlatformGlutGetModeValues ( eWhat, size );
 362
 363   return array;
 364 }
 365
 366 /*** END OF FILE ***/