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

   1 /*
   2  * freeglut_callbacks.c
   3  *
   4  * The callbacks setting 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: Fri Dec 3 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 #ifdef HAVE_CONFIG_H
  29 #include "config.h"
  30 #endif
  31
  32 #include "../include/GL/freeglut.h"
  33 #include "freeglut_internal.h"
  34
  35
  36 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
  37
  38 /*
  39  * All of the callbacks setting methods can be generalized to this:
  40  */
  41 #define SET_CALLBACK(a)              \
  42     if( fgStructure.Window == NULL ) \
  43         return;                      \
  44     FETCH_WCB( ( *( fgStructure.Window ) ), a ) = callback;
  45
  46 /*
  47  * Sets the Display callback for the current window
  48  */
  49 void FGAPIENTRY glutDisplayFunc( void (* callback)( void ) )
  50 {
  51     if( !callback )
  52         fgError( "Fatal error in program.  NULL display callback not "
  53                  "permitted in GLUT 3.0+ or freeglut 2.0.1+\n" );
  54     SET_CALLBACK( Display );
  55     fgStructure.Window->State.Redisplay = GL_TRUE;
  56 }
  57
  58 /*
  59  * Sets the Reshape callback for the current window
  60  */
  61 void FGAPIENTRY glutReshapeFunc( void (* callback)( int, int ) )
  62 {
  63     SET_CALLBACK( Reshape );
  64 }
  65
  66 /*
  67  * Sets the Keyboard callback for the current window
  68  */
  69 void FGAPIENTRY glutKeyboardFunc( void (* callback)
  70                                   ( unsigned char, int, int ) )
  71 {
  72     SET_CALLBACK( Keyboard );
  73 }
  74
  75 /*
  76  * Sets the Special callback for the current window
  77  */
  78 void FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) )
  79 {
  80     SET_CALLBACK( Special );
  81 }
  82
  83 /*
  84  * Sets the global idle callback
  85  */
  86 void FGAPIENTRY glutIdleFunc( void (* callback)( void ) )
  87 {
  88     freeglut_assert_ready;
  89     fgState.IdleCallback = callback;
  90 }
  91
  92 /*
  93  * Sets the Timer callback for the current window
  94  */
  95 void FGAPIENTRY glutTimerFunc( unsigned int timeOut, void (* callback)( int ),
  96                                int timerID )
  97 {
  98     SFG_Timer *timer, *node;
  99
 100     freeglut_assert_ready;
 101
 102     if( (timer = fgState.FreeTimers.Last) )
 103     {
 104         fgListRemove( &fgState.FreeTimers, &timer->Node );
 105     }
 106     else
 107     {
 108         if( ! (timer = malloc(sizeof(SFG_Timer))) )
 109             fgError( "Fatal error: "
 110                      "Memory allocation failure in glutTimerFunc()\n" );
 111     }
 112
 113     timer->Callback  = callback;
 114     timer->ID        = timerID;
 115     timer->TriggerTime = fgElapsedTime() + timeOut;
 116
 117     for( node = fgState.Timers.First; node; node = node->Node.Next )
 118     {
 119         if( node->TriggerTime > timer->TriggerTime )
 120             break;
 121     }
 122
 123     fgListInsert( &fgState.Timers, &node->Node, &timer->Node );
 124 }
 125
 126 /*
 127  * Sets the Visibility callback for the current window.
 128  */
 129 static void fghVisibility( int status )
 130 {
 131     int glut_status = GLUT_VISIBLE;
 132
 133     freeglut_assert_ready;
 134     freeglut_return_if_fail( fgStructure.Window );
 135
 136     if( ( GLUT_HIDDEN == status )  || ( GLUT_FULLY_COVERED == status ) )
 137         glut_status = GLUT_NOT_VISIBLE;
 138     INVOKE_WCB( *( fgStructure.Window ), Visibility, ( glut_status ) );
 139 }
 140
 141 void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
 142 {
 143     SET_CALLBACK( Visibility );
 144
 145     if( callback )
 146         glutWindowStatusFunc( fghVisibility );
 147     else
 148         glutWindowStatusFunc( NULL );
 149 }
 150
 151 /*
 152  * Sets the keyboard key release callback for the current window
 153  */
 154 void FGAPIENTRY glutKeyboardUpFunc( void (* callback)
 155                                     ( unsigned char, int, int ) )
 156 {
 157     SET_CALLBACK( KeyboardUp );
 158 }
 159
 160 /*
 161  * Sets the special key release callback for the current window
 162  */
 163 void FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) )
 164 {
 165     SET_CALLBACK( SpecialUp );
 166 }
 167
 168 /*
 169  * Sets the joystick callback and polling rate for the current window
 170  */
 171 void FGAPIENTRY glutJoystickFunc( void (* callback)
 172                                   ( unsigned int, int, int, int ),
 173                                   int pollInterval )
 174 {
 175     SET_CALLBACK( Joystick );
 176     fgStructure.Window->State.JoystickPollRate = pollInterval;
 177
 178     fgStructure.Window->State.JoystickLastPoll =
 179         fgElapsedTime() - fgStructure.Window->State.JoystickPollRate;
 180
 181     if( fgStructure.Window->State.JoystickLastPoll < 0 )
 182         fgStructure.Window->State.JoystickLastPoll = 0;
 183 }
 184
 185 /*
 186  * Sets the mouse callback for the current window
 187  */
 188 void FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) )
 189 {
 190     SET_CALLBACK( Mouse );
 191 }
 192
 193 /*
 194  * Sets the mouse wheel callback for the current window
 195  */
 196 void FGAPIENTRY glutMouseWheelFunc( void (* callback)( int, int, int, int ) )
 197 {
 198     SET_CALLBACK( MouseWheel );
 199 }
 200
 201 /*
 202  * Sets the mouse motion callback for the current window (one or more buttons
 203  * are pressed)
 204  */
 205 void FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) )
 206 {
 207     SET_CALLBACK( Motion );
 208 }
 209
 210 /*
 211  * Sets the passive mouse motion callback for the current window (no mouse
 212  * buttons are pressed)
 213  */
 214 void FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) )
 215 {
 216     SET_CALLBACK( Passive );
 217 }
 218
 219 /*
 220  * Window mouse entry/leave callback
 221  */
 222 void FGAPIENTRY glutEntryFunc( void (* callback)( int ) )
 223 {
 224     SET_CALLBACK( Entry );
 225 }
 226
 227 /*
 228  * Window destruction callbacks
 229  */
 230 void FGAPIENTRY glutCloseFunc( void (* callback)( void ) )
 231 {
 232     SET_CALLBACK( Destroy );
 233 }
 234
 235 void FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) )
 236 {
 237     glutCloseFunc( callback );
 238 }
 239
 240 /* A. Donev: Destruction callback for menus */
 241 void FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) )
 242 {
 243     if( fgStructure.Menu )
 244         fgStructure.Menu->Destroy = callback;
 245 }
 246
 247 /*
 248  * Deprecated version of glutMenuStatusFunc callback setting method
 249  */
 250 void FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) )
 251 {
 252     freeglut_assert_ready;
 253     fgState.MenuStateCallback = callback;
 254 }
 255
 256 /*
 257  * Sets the global menu status callback for the current window
 258  */
 259 void FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) )
 260 {
 261     freeglut_assert_ready;
 262     fgState.MenuStatusCallback = callback;
 263 }
 264
 265 /*
 266  * Sets the overlay display callback for the current window
 267  */
 268 void FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) )
 269 {
 270     SET_CALLBACK( OverlayDisplay );
 271 }
 272
 273 /*
 274  * Sets the window status callback for the current window
 275  */
 276 void FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) )
 277 {
 278     SET_CALLBACK( WindowStatus );
 279 }
 280
 281 /*
 282  * Sets the spaceball motion callback for the current window
 283  */
 284 void FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) )
 285 {
 286     SET_CALLBACK( SpaceMotion );
 287 }
 288
 289 /*
 290  * Sets the spaceball rotate callback for the current window
 291  */
 292 void FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) )
 293 {
 294     SET_CALLBACK( SpaceRotation );
 295 }
 296
 297 /*
 298  * Sets the spaceball button callback for the current window
 299  */
 300 void FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) )
 301 {
 302     SET_CALLBACK( SpaceButton );
 303 }
 304
 305 /*
 306  * Sets the button box callback for the current window
 307  */
 308 void FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) )
 309 {
 310     SET_CALLBACK( ButtonBox );
 311 }
 312
 313 /*
 314  * Sets the dials box callback for the current window
 315  */
 316 void FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) )
 317 {
 318     SET_CALLBACK( Dials );
 319 }
 320
 321 /*
 322  * Sets the tablet motion callback for the current window
 323  */
 324 void FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) )
 325 {
 326     SET_CALLBACK( TabletMotion );
 327 }
 328
 329 /*
 330  * Sets the tablet buttons callback for the current window
 331  */
 332 void FGAPIENTRY glutTabletButtonFunc( void (* callback)( int, int, int, int ) )
 333 {
 334     SET_CALLBACK( TabletButton );
 335 }
 336
 337 /*** END OF FILE ***/