home *** CD-ROM | disk | FTP | other *** search
/ GameStar Special 2004 August / GSSH0804.iso / Action / Parsec47 / Parsec47.exe / p47 / import / SDL_timer.d < prev    next >
Text File  |  2003-11-29  |  4KB  |  96 lines
  1. /*
  2.     SDL - Simple DirectMedia Layer
  3.     Copyright (C) 1997, 1998, 1999, 2000, 2001  Sam Lantinga
  4.  
  5.     This library is free software; you can redistribute it and/or
  6.     modify it under the terms of the GNU Library General Public
  7.     License as published by the Free Software Foundation; either
  8.     version 2 of the License, or (at your option) any later version.
  9.  
  10.     This library is distributed in the hope that it will be useful,
  11.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13.     Library General Public License for more details.
  14.  
  15.     You should have received a copy of the GNU Library General Public
  16.     License along with this library; if not, write to the Free
  17.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18.  
  19.     Sam Lantinga
  20.     slouken@devolution.com
  21. */
  22.  
  23. import SDL_types;
  24.  
  25. extern(C):
  26.  
  27. /* This is the OS scheduler timeslice, in milliseconds */
  28. const uint SDL_TIMESLICE    = 10;
  29.  
  30. /* This is the maximum resolution of the SDL timer on all platforms */
  31. const uint TIMER_RESOLUTION    = 10;    /* Experimentally determined */
  32.  
  33. /* Get the number of milliseconds since the SDL library initialization.
  34.  * Note that this value wraps if the program runs for more than ~49 days.
  35.  */ 
  36. Uint32 SDL_GetTicks();
  37.  
  38. /* Wait a specified number of milliseconds before returning */
  39. void SDL_Delay(Uint32 ms);
  40.  
  41. /* Function prototype for the timer callback function */
  42. alias Uint32 (*SDL_TimerCallback)(Uint32 interval);
  43.  
  44. /* Set a callback to run after the specified number of milliseconds has
  45.  * elapsed. The callback function is passed the current timer interval
  46.  * and returns the next timer interval.  If the returned value is the 
  47.  * same as the one passed in, the periodic alarm continues, otherwise a
  48.  * new alarm is scheduled.  If the callback returns 0, the periodic alarm
  49.  * is cancelled.
  50.  * 
  51.  * To cancel a currently running timer, call SDL_SetTimer(0, NULL);
  52.  * 
  53.  * The timer callback function may run in a different thread than your
  54.  * main code, and so shouldn't call any functions from within itself.
  55.  * 
  56.  * The maximum resolution of this timer is 10 ms, which means that if
  57.  * you request a 16 ms timer, your callback will run approximately 20 ms
  58.  * later on an unloaded system.  If you wanted to set a flag signaling
  59.  * a frame update at 30 frames per second (every 33 ms), you might set a 
  60.  * timer for 30 ms:
  61.  *   SDL_SetTimer((33/10)*10, flag_update);
  62.  * 
  63.  * If you use this function, you need to pass SDL_INIT_TIMER to SDL_Init().
  64.  * 
  65.  * Under UNIX, you should not use raise or use SIGALRM and this function
  66.  * in the same program, as it is implemented using setitimer().  You also
  67.  * should not use this function in multi-threaded applications as signals
  68.  * to multi-threaded apps have undefined behavior in some implementations.
  69.  */
  70. int SDL_SetTimer(Uint32 interval, SDL_TimerCallback callback);
  71.  
  72. /* New timer API, supports multiple timers
  73.  * Written by Stephane Peter <megastep@lokigames.com>
  74.  */
  75.  
  76. /* Function prototype for the new timer callback function.
  77.  * The callback function is passed the current timer interval and returns
  78.  * the next timer interval.  If the returned value is the same as the one
  79.  * passed in, the periodic alarm continues, otherwise a new alarm is
  80.  * scheduled.  If the callback returns 0, the periodic alarm is cancelled.
  81.  */
  82. alias Uint32 (*SDL_NewTimerCallback)(Uint32 interval, void *param);
  83.  
  84. /* Definition of the timer ID type */
  85. alias void *SDL_TimerID;
  86.  
  87. /* Add a new timer to the pool of timers already running.
  88.    Returns a timer ID, or NULL when an error occurs.
  89.  */
  90. SDL_TimerID SDL_AddTimer(Uint32 interval, SDL_NewTimerCallback callback, void *param);
  91.  
  92. /* Remove one of the multiple timers knowing its ID.
  93.  * Returns a boolean value indicating success.
  94.  */
  95. SDL_bool SDL_RemoveTimer(SDL_TimerID t);
  96.