SDL  2.0
SDL_timer.h File Reference
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_timer.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define SDL_TICKS_PASSED(A, B)   ((Sint32)((B) - (A)) <= 0)
 Compare SDL ticks values, and return true if A has passed B. More...
 

Typedefs

typedef Uint32(* SDL_TimerCallback) (Uint32 interval, void *param)
 
typedef int SDL_TimerID
 

Functions

Uint32 SDL_GetTicks (void)
 Get the number of milliseconds since the SDL library initialization. More...
 
Uint64 SDL_GetPerformanceCounter (void)
 Get the current value of the high resolution counter. More...
 
Uint64 SDL_GetPerformanceFrequency (void)
 Get the count per second of the high resolution counter. More...
 
void SDL_Delay (Uint32 ms)
 Wait a specified number of milliseconds before returning. More...
 
SDL_TimerID SDL_AddTimer (Uint32 interval, SDL_TimerCallback callback, void *param)
 Add a new timer to the pool of timers already running. More...
 
SDL_bool SDL_RemoveTimer (SDL_TimerID id)
 Remove a timer knowing its ID. More...
 

Detailed Description

Header for the SDL time management routines.

Definition in file SDL_timer.h.

Macro Definition Documentation

◆ SDL_TICKS_PASSED

#define SDL_TICKS_PASSED (   A,
 
)    ((Sint32)((B) - (A)) <= 0)

Compare SDL ticks values, and return true if A has passed B.

e.g. if you want to wait 100 ms, you could do this: Uint32 timeout = SDL_GetTicks() + 100; while (!SDL_TICKS_PASSED(SDL_GetTicks(), timeout)) { ... do work until timeout has elapsed }

Definition at line 56 of file SDL_timer.h.

Typedef Documentation

◆ SDL_TimerCallback

typedef Uint32( * SDL_TimerCallback) (Uint32 interval, void *param)

Function prototype for the timer callback function.

The callback function is passed the current timer interval and returns the next timer interval. If the returned value is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled. If the callback returns 0, the periodic alarm is cancelled.

Definition at line 81 of file SDL_timer.h.

◆ SDL_TimerID

typedef int SDL_TimerID

Definition of the timer ID type.

Definition at line 86 of file SDL_timer.h.

Function Documentation

◆ SDL_AddTimer()

SDL_TimerID SDL_AddTimer ( Uint32  interval,
SDL_TimerCallback  callback,
void *  param 
)

Add a new timer to the pool of timers already running.

Returns
A timer ID, or 0 when an error occurs.

◆ SDL_Delay()

void SDL_Delay ( Uint32  ms)

Wait a specified number of milliseconds before returning.

◆ SDL_GetPerformanceCounter()

Uint64 SDL_GetPerformanceCounter ( void  )

Get the current value of the high resolution counter.

◆ SDL_GetPerformanceFrequency()

Uint64 SDL_GetPerformanceFrequency ( void  )

Get the count per second of the high resolution counter.

◆ SDL_GetTicks()

Uint32 SDL_GetTicks ( void  )

Get the number of milliseconds since the SDL library initialization.

Note
This value wraps if the program runs for more than ~49 days.

◆ SDL_RemoveTimer()

SDL_bool SDL_RemoveTimer ( SDL_TimerID  id)

Remove a timer knowing its ID.

Returns
A boolean value indicating success or failure.
Warning
It is not safe to remove a timer multiple times.