SDL_timer.h
上传用户:sun1608
上传日期:2007-02-02
资源大小:6116k
文件大小:4k
源码类别:

流媒体/Mpeg4/MP4

开发平台:

Visual C++

  1. /*
  2.     SDL - Simple DirectMedia Layer
  3.     Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002  Sam Lantinga
  4.     This library is free software; you can redistribute it and/or
  5.     modify it under the terms of the GNU Library General Public
  6.     License as published by the Free Software Foundation; either
  7.     version 2 of the License, or (at your option) any later version.
  8.     This library is distributed in the hope that it will be useful,
  9.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  10.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11.     Library General Public License for more details.
  12.     You should have received a copy of the GNU Library General Public
  13.     License along with this library; if not, write to the Free
  14.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  15.     Sam Lantinga
  16.     slouken@libsdl.org
  17. */
  18. #ifdef SAVE_RCSID
  19. static char rcsid =
  20.  "@(#) $Id: SDL_timer.h,v 1.4 2002/04/22 21:38:01 wmay Exp $";
  21. #endif
  22. #ifndef _SDL_timer_h
  23. #define _SDL_timer_h
  24. /* Header for the SDL time management routines */
  25. #include "SDL_main.h"
  26. #include "SDL_types.h"
  27. #include "begin_code.h"
  28. /* Set up for C function definitions, even when using C++ */
  29. #ifdef __cplusplus
  30. extern "C" {
  31. #endif
  32. /* This is the OS scheduler timeslice, in milliseconds */
  33. #define SDL_TIMESLICE 10
  34. /* This is the maximum resolution of the SDL timer on all platforms */
  35. #define TIMER_RESOLUTION 10 /* Experimentally determined */
  36. /* Get the number of milliseconds since the SDL library initialization.
  37.  * Note that this value wraps if the program runs for more than ~49 days.
  38.  */ 
  39. extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void);
  40. /* Wait a specified number of milliseconds before returning */
  41. extern DECLSPEC void SDLCALL SDL_Delay(Uint32 ms);
  42. /* Function prototype for the timer callback function */
  43. typedef Uint32 (SDLCALL *SDL_TimerCallback)(Uint32 interval);
  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. extern DECLSPEC int SDLCALL SDL_SetTimer(Uint32 interval, SDL_TimerCallback callback);
  71. /* New timer API, supports multiple timers
  72.  * Written by Stephane Peter <megastep@lokigames.com>
  73.  */
  74. /* Function prototype for the new timer callback function.
  75.  * The callback function is passed the current timer interval and returns
  76.  * the next timer interval.  If the returned value is the same as the one
  77.  * passed in, the periodic alarm continues, otherwise a new alarm is
  78.  * scheduled.  If the callback returns 0, the periodic alarm is cancelled.
  79.  */
  80. typedef Uint32 (SDLCALL *SDL_NewTimerCallback)(Uint32 interval, void *param);
  81. /* Definition of the timer ID type */
  82. typedef struct _SDL_TimerID *SDL_TimerID;
  83. /* Add a new timer to the pool of timers already running.
  84.    Returns a timer ID, or NULL when an error occurs.
  85.  */
  86. extern DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, SDL_NewTimerCallback callback, void *param);
  87. /* Remove one of the multiple timers knowing its ID.
  88.  * Returns a boolean value indicating success.
  89.  */
  90. extern DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer(SDL_TimerID t);
  91. /* Ends C function definitions when using C++ */
  92. #ifdef __cplusplus
  93. }
  94. #endif
  95. #include "close_code.h"
  96. #endif /* _SDL_timer_h */