4 * The callbacks setting methods.
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
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-callbacks"
34 #include "../include/GL/freeglut.h"
35 #include "freeglut_internal.h"
38 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
41 * All of the callbacks setting methods can be generalized to this:
43 #define SET_CALLBACK(a) if( fgStructure.Window == NULL ) return;\
44 fgStructure.Window->Callbacks.a = callback;
47 * Sets the Display callback for the current window
49 void FGAPIENTRY glutDisplayFunc( void (* callback)( void ) )
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 );
57 * Force a redisplay with the new callback
59 fgStructure.Window->State.Redisplay = TRUE;
64 * Sets the Reshape callback for the current window
66 void FGAPIENTRY glutReshapeFunc( void (* callback)( int, int ) )
68 SET_CALLBACK( Reshape );
72 * Sets the Keyboard callback for the current window
74 void FGAPIENTRY glutKeyboardFunc( void (* callback)( unsigned char, int, int ) )
76 SET_CALLBACK( Keyboard );
80 * Sets the Special callback for the current window
82 void FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) )
84 SET_CALLBACK( Special );
88 * Sets the global idle callback
90 void FGAPIENTRY glutIdleFunc( void (* callback)( void ) )
92 freeglut_assert_ready;
95 * The global idle callback pointer is stored in fgState structure
97 fgState.IdleCallback = callback;
101 * Sets the Timer callback for the current window
103 void FGAPIENTRY glutTimerFunc( unsigned int timeOut, void (* callback)( int ), int timerID )
107 freeglut_assert_ready;
110 * Create a new freeglut timer hook structure
112 timer = (SFG_Timer *)calloc( sizeof(SFG_Timer), 1 );
115 * Remember the callback address and timer hook's ID
117 timer->Callback = callback;
121 * When will the time out happen (in terms of window's timer)
123 timer->TriggerTime = fgElapsedTime() + timeOut;
126 * Have the new hook attached to the current window
128 fgListAppend( &fgState.Timers, &timer->Node );
132 * Sets the Visibility callback for the current window.
134 * I had to peer to GLUT sources to clean up the mess.
135 * Can anyone please explain me what is going on here?!?
137 static void fghVisibility( int status )
139 freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Window != NULL );
140 freeglut_return_if_fail( fgStructure.Window->Callbacks.Visibility != NULL );
142 if( status == GLUT_HIDDEN || status == GLUT_FULLY_COVERED )
143 fgStructure.Window->Callbacks.Visibility( GLUT_NOT_VISIBLE );
145 fgStructure.Window->Callbacks.Visibility( GLUT_VISIBLE );
148 void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
150 SET_CALLBACK( Visibility );
153 glutWindowStatusFunc( fghVisibility );
155 glutWindowStatusFunc( NULL );
159 * Sets the keyboard key release callback for the current window
161 void FGAPIENTRY glutKeyboardUpFunc( void (* callback)( unsigned char, int, int ) )
163 SET_CALLBACK( KeyboardUp );
167 * Sets the special key release callback for the current window
169 void FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) )
171 SET_CALLBACK( SpecialUp );
175 * Sets the joystick callback and polling rate for the current window
177 void FGAPIENTRY glutJoystickFunc( void (* callback)( unsigned int, int, int, int ), int pollInterval )
179 SET_CALLBACK( Joystick );
181 freeglut_return_if_fail( fgStructure.Window != NULL );
184 * Do not forget setting the joystick poll rate
186 fgStructure.Window->State.JoystickPollRate = pollInterval;
189 * Make sure the joystick polling routine gets called as early as possible:
191 fgStructure.Window->State.JoystickLastPoll =
192 fgElapsedTime() - fgStructure.Window->State.JoystickPollRate;
194 if( fgStructure.Window->State.JoystickLastPoll < 0 )
195 fgStructure.Window->State.JoystickLastPoll = 0;
199 * Sets the mouse callback for the current window
201 void FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) )
203 SET_CALLBACK( Mouse );
207 * Sets the mouse motion callback for the current window (one or more buttons are pressed)
209 void FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) )
211 SET_CALLBACK( Motion );
215 * Sets the passive mouse motion callback for the current window (no mouse buttons are pressed)
217 void FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) )
219 SET_CALLBACK( Passive );
223 * Window mouse entry/leave callback
225 void FGAPIENTRY glutEntryFunc( void (* callback)( int ) )
227 SET_CALLBACK( Entry );
231 * Window destruction callbacks
233 void FGAPIENTRY glutCloseFunc( void (* callback)( void ) )
235 SET_CALLBACK( Destroy );
238 void FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) )
240 glutCloseFunc( callback );
243 /* A. Donev: Destruction callback for menus */
244 void FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) )
246 if( fgStructure.Menu == NULL ) return;
247 fgStructure.Menu->Destroy = callback;
251 * Deprecated version of glutMenuStatusFunc callback setting method
253 void FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) )
255 freeglut_assert_ready;
257 fgState.MenuStateCallback = callback;
261 * Sets the global menu status callback for the current window
263 void FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) )
265 freeglut_assert_ready;
267 fgState.MenuStatusCallback = callback;
271 * Sets the overlay display callback for the current window
273 void FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) )
275 SET_CALLBACK( OverlayDisplay );
279 * Sets the window status callback for the current window
281 void FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) )
283 SET_CALLBACK( WindowStatus );
287 * Sets the spaceball motion callback for the current window
289 void FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) )
291 SET_CALLBACK( SpaceMotion );
295 * Sets the spaceball rotate callback for the current window
297 void FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) )
299 SET_CALLBACK( SpaceRotation );
303 * Sets the spaceball button callback for the current window
305 void FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) )
307 SET_CALLBACK( SpaceButton );
311 * Sets the button box callback for the current window
313 void FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) )
315 SET_CALLBACK( ButtonBox );
319 * Sets the dials box callback for the current window
321 void FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) )
323 SET_CALLBACK( Dials );
327 * Sets the tablet motion callback for the current window
329 void FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) )
331 SET_CALLBACK( TabletMotion );
335 * Sets the tablet buttons callback for the current window
337 void FGAPIENTRY glutTabletButtonFunc( void (* callback)( int, int, int, int ) )
339 SET_CALLBACK( TabletButton );
342 /*** END OF FILE ***/