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