include/SDL_timer.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 26 Sep 2009 23:17:08 +0000
branchSDL-1.2
changeset 4246 8b8314cc34a6
parent 4217 4c4113c2162c
child 6137 4720145f848b
permissions -rw-r--r--
Fixed bug #810

Lauri Kenttä 2009-09-26 06:42:23 PDT

Support for disabling stdio redirect with environment variables.
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@4159
     3
    Copyright (C) 1997-2009 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 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@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
#ifndef _SDL_timer_h
slouken@0
    24
#define _SDL_timer_h
slouken@0
    25
slouken@4217
    26
/** @file SDL_timer.h
slouken@4217
    27
 *  Header for the SDL time management routines
slouken@4217
    28
 */
slouken@0
    29
slouken@1356
    30
#include "SDL_stdinc.h"
slouken@1358
    31
#include "SDL_error.h"
slouken@0
    32
slouken@0
    33
#include "begin_code.h"
slouken@0
    34
/* Set up for C function definitions, even when using C++ */
slouken@0
    35
#ifdef __cplusplus
slouken@0
    36
extern "C" {
slouken@0
    37
#endif
slouken@0
    38
slouken@4217
    39
/** This is the OS scheduler timeslice, in milliseconds */
slouken@0
    40
#define SDL_TIMESLICE		10
slouken@0
    41
slouken@4217
    42
/** This is the maximum resolution of the SDL timer on all platforms */
slouken@4217
    43
#define TIMER_RESOLUTION	10	/**< Experimentally determined */
slouken@0
    44
slouken@4217
    45
/**
slouken@4217
    46
 * Get the number of milliseconds since the SDL library initialization.
slouken@0
    47
 * Note that this value wraps if the program runs for more than ~49 days.
slouken@0
    48
 */ 
slouken@337
    49
extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void);
slouken@0
    50
slouken@4217
    51
/** Wait a specified number of milliseconds before returning */
slouken@337
    52
extern DECLSPEC void SDLCALL SDL_Delay(Uint32 ms);
slouken@0
    53
slouken@4217
    54
/** Function prototype for the timer callback function */
slouken@337
    55
typedef Uint32 (SDLCALL *SDL_TimerCallback)(Uint32 interval);
slouken@0
    56
slouken@4217
    57
/**
slouken@4217
    58
 * Set a callback to run after the specified number of milliseconds has
slouken@0
    59
 * elapsed. The callback function is passed the current timer interval
slouken@0
    60
 * and returns the next timer interval.  If the returned value is the 
slouken@0
    61
 * same as the one passed in, the periodic alarm continues, otherwise a
slouken@0
    62
 * new alarm is scheduled.  If the callback returns 0, the periodic alarm
slouken@0
    63
 * is cancelled.
slouken@0
    64
 *
slouken@0
    65
 * To cancel a currently running timer, call SDL_SetTimer(0, NULL);
slouken@0
    66
 *
slouken@0
    67
 * The timer callback function may run in a different thread than your
slouken@0
    68
 * main code, and so shouldn't call any functions from within itself.
slouken@0
    69
 *
slouken@0
    70
 * The maximum resolution of this timer is 10 ms, which means that if
slouken@0
    71
 * you request a 16 ms timer, your callback will run approximately 20 ms
slouken@0
    72
 * later on an unloaded system.  If you wanted to set a flag signaling
slouken@0
    73
 * a frame update at 30 frames per second (every 33 ms), you might set a 
slouken@0
    74
 * timer for 30 ms:
slouken@4217
    75
 *   @code SDL_SetTimer((33/10)*10, flag_update); @endcode
slouken@0
    76
 *
slouken@0
    77
 * If you use this function, you need to pass SDL_INIT_TIMER to SDL_Init().
slouken@0
    78
 *
slouken@0
    79
 * Under UNIX, you should not use raise or use SIGALRM and this function
slouken@0
    80
 * in the same program, as it is implemented using setitimer().  You also
slouken@0
    81
 * should not use this function in multi-threaded applications as signals
slouken@0
    82
 * to multi-threaded apps have undefined behavior in some implementations.
slouken@1028
    83
 *
slouken@1028
    84
 * This function returns 0 if successful, or -1 if there was an error.
slouken@0
    85
 */
slouken@337
    86
extern DECLSPEC int SDLCALL SDL_SetTimer(Uint32 interval, SDL_TimerCallback callback);
slouken@0
    87
slouken@4217
    88
/** @name New timer API
slouken@4217
    89
 * New timer API, supports multiple timers
slouken@0
    90
 * Written by Stephane Peter <megastep@lokigames.com>
slouken@0
    91
 */
slouken@4217
    92
/*@{*/
slouken@0
    93
slouken@4217
    94
/**
slouken@4217
    95
 * Function prototype for the new timer callback function.
slouken@0
    96
 * The callback function is passed the current timer interval and returns
slouken@0
    97
 * the next timer interval.  If the returned value is the same as the one
slouken@0
    98
 * passed in, the periodic alarm continues, otherwise a new alarm is
slouken@0
    99
 * scheduled.  If the callback returns 0, the periodic alarm is cancelled.
slouken@0
   100
 */
slouken@337
   101
typedef Uint32 (SDLCALL *SDL_NewTimerCallback)(Uint32 interval, void *param);
slouken@0
   102
slouken@4217
   103
/** Definition of the timer ID type */
slouken@0
   104
typedef struct _SDL_TimerID *SDL_TimerID;
slouken@0
   105
slouken@4217
   106
/** Add a new timer to the pool of timers already running.
slouken@4217
   107
 *  Returns a timer ID, or NULL when an error occurs.
slouken@0
   108
 */
slouken@337
   109
extern DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, SDL_NewTimerCallback callback, void *param);
slouken@0
   110
slouken@4217
   111
/**
slouken@4217
   112
 * Remove one of the multiple timers knowing its ID.
slouken@0
   113
 * Returns a boolean value indicating success.
slouken@0
   114
 */
slouken@337
   115
extern DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer(SDL_TimerID t);
slouken@0
   116
slouken@4217
   117
/*@}*/
slouken@4217
   118
slouken@0
   119
/* Ends C function definitions when using C++ */
slouken@0
   120
#ifdef __cplusplus
slouken@0
   121
}
slouken@0
   122
#endif
slouken@0
   123
#include "close_code.h"
slouken@0
   124
slouken@0
   125
#endif /* _SDL_timer_h */