include/SDL_timer.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 06 Oct 2002 20:31:34 +0000
changeset 515 230b156829ed
parent 337 9154ec9ca3d2
child 769 b8d311d90021
permissions -rw-r--r--
*** empty log message ***
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@297
     3
    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002  Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@0
     6
    modify it under the terms of the GNU Library General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@0
     8
    version 2 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@0
    13
    Library General Public License for more details.
slouken@0
    14
slouken@0
    15
    You should have received a copy of the GNU Library General Public
slouken@0
    16
    License along with this library; if not, write to the Free
slouken@0
    17
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
#ifdef SAVE_RCSID
slouken@0
    24
static char rcsid =
slouken@0
    25
 "@(#) $Id$";
slouken@0
    26
#endif
slouken@0
    27
slouken@0
    28
#ifndef _SDL_timer_h
slouken@0
    29
#define _SDL_timer_h
slouken@0
    30
slouken@0
    31
/* Header for the SDL time management routines */
slouken@0
    32
slouken@0
    33
#include "SDL_main.h"
slouken@0
    34
#include "SDL_types.h"
slouken@0
    35
slouken@0
    36
#include "begin_code.h"
slouken@0
    37
/* Set up for C function definitions, even when using C++ */
slouken@0
    38
#ifdef __cplusplus
slouken@0
    39
extern "C" {
slouken@0
    40
#endif
slouken@0
    41
slouken@0
    42
/* This is the OS scheduler timeslice, in milliseconds */
slouken@0
    43
#define SDL_TIMESLICE		10
slouken@0
    44
slouken@0
    45
/* This is the maximum resolution of the SDL timer on all platforms */
slouken@0
    46
#define TIMER_RESOLUTION	10	/* Experimentally determined */
slouken@0
    47
slouken@0
    48
/* Get the number of milliseconds since the SDL library initialization.
slouken@0
    49
 * Note that this value wraps if the program runs for more than ~49 days.
slouken@0
    50
 */ 
slouken@337
    51
extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void);
slouken@0
    52
slouken@0
    53
/* Wait a specified number of milliseconds before returning */
slouken@337
    54
extern DECLSPEC void SDLCALL SDL_Delay(Uint32 ms);
slouken@0
    55
slouken@0
    56
/* Function prototype for the timer callback function */
slouken@337
    57
typedef Uint32 (SDLCALL *SDL_TimerCallback)(Uint32 interval);
slouken@0
    58
slouken@0
    59
/* Set a callback to run after the specified number of milliseconds has
slouken@0
    60
 * elapsed. The callback function is passed the current timer interval
slouken@0
    61
 * and returns the next timer interval.  If the returned value is the 
slouken@0
    62
 * same as the one passed in, the periodic alarm continues, otherwise a
slouken@0
    63
 * new alarm is scheduled.  If the callback returns 0, the periodic alarm
slouken@0
    64
 * is cancelled.
slouken@0
    65
 *
slouken@0
    66
 * To cancel a currently running timer, call SDL_SetTimer(0, NULL);
slouken@0
    67
 *
slouken@0
    68
 * The timer callback function may run in a different thread than your
slouken@0
    69
 * main code, and so shouldn't call any functions from within itself.
slouken@0
    70
 *
slouken@0
    71
 * The maximum resolution of this timer is 10 ms, which means that if
slouken@0
    72
 * you request a 16 ms timer, your callback will run approximately 20 ms
slouken@0
    73
 * later on an unloaded system.  If you wanted to set a flag signaling
slouken@0
    74
 * a frame update at 30 frames per second (every 33 ms), you might set a 
slouken@0
    75
 * timer for 30 ms:
slouken@0
    76
 *   SDL_SetTimer((33/10)*10, flag_update);
slouken@0
    77
 *
slouken@0
    78
 * If you use this function, you need to pass SDL_INIT_TIMER to SDL_Init().
slouken@0
    79
 *
slouken@0
    80
 * Under UNIX, you should not use raise or use SIGALRM and this function
slouken@0
    81
 * in the same program, as it is implemented using setitimer().  You also
slouken@0
    82
 * should not use this function in multi-threaded applications as signals
slouken@0
    83
 * to multi-threaded apps have undefined behavior in some implementations.
slouken@0
    84
 */
slouken@337
    85
extern DECLSPEC int SDLCALL SDL_SetTimer(Uint32 interval, SDL_TimerCallback callback);
slouken@0
    86
slouken@0
    87
/* New timer API, supports multiple timers
slouken@0
    88
 * Written by Stephane Peter <megastep@lokigames.com>
slouken@0
    89
 */
slouken@0
    90
slouken@0
    91
/* Function prototype for the new timer callback function.
slouken@0
    92
 * The callback function is passed the current timer interval and returns
slouken@0
    93
 * the next timer interval.  If the returned value is the same as the one
slouken@0
    94
 * passed in, the periodic alarm continues, otherwise a new alarm is
slouken@0
    95
 * scheduled.  If the callback returns 0, the periodic alarm is cancelled.
slouken@0
    96
 */
slouken@337
    97
typedef Uint32 (SDLCALL *SDL_NewTimerCallback)(Uint32 interval, void *param);
slouken@0
    98
slouken@0
    99
/* Definition of the timer ID type */
slouken@0
   100
typedef struct _SDL_TimerID *SDL_TimerID;
slouken@0
   101
slouken@0
   102
/* Add a new timer to the pool of timers already running.
slouken@0
   103
   Returns a timer ID, or NULL when an error occurs.
slouken@0
   104
 */
slouken@337
   105
extern DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, SDL_NewTimerCallback callback, void *param);
slouken@0
   106
slouken@0
   107
/* Remove one of the multiple timers knowing its ID.
slouken@0
   108
 * Returns a boolean value indicating success.
slouken@0
   109
 */
slouken@337
   110
extern DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer(SDL_TimerID t);
slouken@0
   111
slouken@0
   112
/* Ends C function definitions when using C++ */
slouken@0
   113
#ifdef __cplusplus
slouken@0
   114
}
slouken@0
   115
#endif
slouken@0
   116
#include "close_code.h"
slouken@0
   117
slouken@0
   118
#endif /* _SDL_timer_h */