Miguel Ruiz / SDL_lib2

SDL Library

Dependents:   H261_decoder

SDL_timer.h@0:7fb6877b5d7c, 2016-09-22 (annotated)

Committer:
miruga27
Date:
Thu Sep 22 00:03:09 2016 +0000
Revision:
0:7fb6877b5d7c
SDL

Who changed what in which revision?

UserRevisionLine numberNew contents of line
miruga27 0:7fb6877b5d7c 1 /*
miruga27 0:7fb6877b5d7c 2 Simple DirectMedia Layer
miruga27 0:7fb6877b5d7c 3 Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
miruga27 0:7fb6877b5d7c 4
miruga27 0:7fb6877b5d7c 5 This software is provided 'as-is', without any express or implied
miruga27 0:7fb6877b5d7c 6 warranty. In no event will the authors be held liable for any damages
miruga27 0:7fb6877b5d7c 7 arising from the use of this software.
miruga27 0:7fb6877b5d7c 8
miruga27 0:7fb6877b5d7c 9 Permission is granted to anyone to use this software for any purpose,
miruga27 0:7fb6877b5d7c 10 including commercial applications, and to alter it and redistribute it
miruga27 0:7fb6877b5d7c 11 freely, subject to the following restrictions:
miruga27 0:7fb6877b5d7c 12
miruga27 0:7fb6877b5d7c 13 1. The origin of this software must not be misrepresented; you must not
miruga27 0:7fb6877b5d7c 14 claim that you wrote the original software. If you use this software
miruga27 0:7fb6877b5d7c 15 in a product, an acknowledgment in the product documentation would be
miruga27 0:7fb6877b5d7c 16 appreciated but is not required.
miruga27 0:7fb6877b5d7c 17 2. Altered source versions must be plainly marked as such, and must not be
miruga27 0:7fb6877b5d7c 18 misrepresented as being the original software.
miruga27 0:7fb6877b5d7c 19 3. This notice may not be removed or altered from any source distribution.
miruga27 0:7fb6877b5d7c 20 */
miruga27 0:7fb6877b5d7c 21
miruga27 0:7fb6877b5d7c 22 #ifndef _SDL_timer_h
miruga27 0:7fb6877b5d7c 23 #define _SDL_timer_h
miruga27 0:7fb6877b5d7c 24
miruga27 0:7fb6877b5d7c 25 /**
miruga27 0:7fb6877b5d7c 26 * \file SDL_timer.h
miruga27 0:7fb6877b5d7c 27 *
miruga27 0:7fb6877b5d7c 28 * Header for the SDL time management routines.
miruga27 0:7fb6877b5d7c 29 */
miruga27 0:7fb6877b5d7c 30
miruga27 0:7fb6877b5d7c 31 #include "SDL_stdinc.h"
miruga27 0:7fb6877b5d7c 32 #include "SDL_error.h"
miruga27 0:7fb6877b5d7c 33
miruga27 0:7fb6877b5d7c 34 #include "begin_code.h"
miruga27 0:7fb6877b5d7c 35 /* Set up for C function definitions, even when using C++ */
miruga27 0:7fb6877b5d7c 36 #ifdef __cplusplus
miruga27 0:7fb6877b5d7c 37 extern "C" {
miruga27 0:7fb6877b5d7c 38 #endif
miruga27 0:7fb6877b5d7c 39
miruga27 0:7fb6877b5d7c 40 /**
miruga27 0:7fb6877b5d7c 41 * \brief Get the number of milliseconds since the SDL library initialization.
miruga27 0:7fb6877b5d7c 42 *
miruga27 0:7fb6877b5d7c 43 * \note This value wraps if the program runs for more than ~49 days.
miruga27 0:7fb6877b5d7c 44 */
miruga27 0:7fb6877b5d7c 45 extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void);
miruga27 0:7fb6877b5d7c 46
miruga27 0:7fb6877b5d7c 47 /**
miruga27 0:7fb6877b5d7c 48 * \brief Compare SDL ticks values, and return true if A has passed B
miruga27 0:7fb6877b5d7c 49 *
miruga27 0:7fb6877b5d7c 50 * e.g. if you want to wait 100 ms, you could do this:
miruga27 0:7fb6877b5d7c 51 * Uint32 timeout = SDL_GetTicks() + 100;
miruga27 0:7fb6877b5d7c 52 * while (!SDL_TICKS_PASSED(SDL_GetTicks(), timeout)) {
miruga27 0:7fb6877b5d7c 53 * ... do work until timeout has elapsed
miruga27 0:7fb6877b5d7c 54 * }
miruga27 0:7fb6877b5d7c 55 */
miruga27 0:7fb6877b5d7c 56 #define SDL_TICKS_PASSED(A, B) ((Sint32)((B) - (A)) <= 0)
miruga27 0:7fb6877b5d7c 57
miruga27 0:7fb6877b5d7c 58 /**
miruga27 0:7fb6877b5d7c 59 * \brief Get the current value of the high resolution counter
miruga27 0:7fb6877b5d7c 60 */
miruga27 0:7fb6877b5d7c 61 extern DECLSPEC Uint64 SDLCALL SDL_GetPerformanceCounter(void);
miruga27 0:7fb6877b5d7c 62
miruga27 0:7fb6877b5d7c 63 /**
miruga27 0:7fb6877b5d7c 64 * \brief Get the count per second of the high resolution counter
miruga27 0:7fb6877b5d7c 65 */
miruga27 0:7fb6877b5d7c 66 extern DECLSPEC Uint64 SDLCALL SDL_GetPerformanceFrequency(void);
miruga27 0:7fb6877b5d7c 67
miruga27 0:7fb6877b5d7c 68 /**
miruga27 0:7fb6877b5d7c 69 * \brief Wait a specified number of milliseconds before returning.
miruga27 0:7fb6877b5d7c 70 */
miruga27 0:7fb6877b5d7c 71 extern DECLSPEC void SDLCALL SDL_Delay(Uint32 ms);
miruga27 0:7fb6877b5d7c 72
miruga27 0:7fb6877b5d7c 73 /**
miruga27 0:7fb6877b5d7c 74 * Function prototype for the timer callback function.
miruga27 0:7fb6877b5d7c 75 *
miruga27 0:7fb6877b5d7c 76 * The callback function is passed the current timer interval and returns
miruga27 0:7fb6877b5d7c 77 * the next timer interval. If the returned value is the same as the one
miruga27 0:7fb6877b5d7c 78 * passed in, the periodic alarm continues, otherwise a new alarm is
miruga27 0:7fb6877b5d7c 79 * scheduled. If the callback returns 0, the periodic alarm is cancelled.
miruga27 0:7fb6877b5d7c 80 */
miruga27 0:7fb6877b5d7c 81 typedef Uint32 (SDLCALL * SDL_TimerCallback) (Uint32 interval, void *param);
miruga27 0:7fb6877b5d7c 82
miruga27 0:7fb6877b5d7c 83 /**
miruga27 0:7fb6877b5d7c 84 * Definition of the timer ID type.
miruga27 0:7fb6877b5d7c 85 */
miruga27 0:7fb6877b5d7c 86 typedef int SDL_TimerID;
miruga27 0:7fb6877b5d7c 87
miruga27 0:7fb6877b5d7c 88 /**
miruga27 0:7fb6877b5d7c 89 * \brief Add a new timer to the pool of timers already running.
miruga27 0:7fb6877b5d7c 90 *
miruga27 0:7fb6877b5d7c 91 * \return A timer ID, or NULL when an error occurs.
miruga27 0:7fb6877b5d7c 92 */
miruga27 0:7fb6877b5d7c 93 extern DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval,
miruga27 0:7fb6877b5d7c 94 SDL_TimerCallback callback,
miruga27 0:7fb6877b5d7c 95 void *param);
miruga27 0:7fb6877b5d7c 96
miruga27 0:7fb6877b5d7c 97 /**
miruga27 0:7fb6877b5d7c 98 * \brief Remove a timer knowing its ID.
miruga27 0:7fb6877b5d7c 99 *
miruga27 0:7fb6877b5d7c 100 * \return A boolean value indicating success or failure.
miruga27 0:7fb6877b5d7c 101 *
miruga27 0:7fb6877b5d7c 102 * \warning It is not safe to remove a timer multiple times.
miruga27 0:7fb6877b5d7c 103 */
miruga27 0:7fb6877b5d7c 104 extern DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer(SDL_TimerID id);
miruga27 0:7fb6877b5d7c 105
miruga27 0:7fb6877b5d7c 106
miruga27 0:7fb6877b5d7c 107 /* Ends C function definitions when using C++ */
miruga27 0:7fb6877b5d7c 108 #ifdef __cplusplus
miruga27 0:7fb6877b5d7c 109 }
miruga27 0:7fb6877b5d7c 110 #endif
miruga27 0:7fb6877b5d7c 111 #include "close_code.h"
miruga27 0:7fb6877b5d7c 112
miruga27 0:7fb6877b5d7c 113 #endif /* _SDL_timer_h */
miruga27 0:7fb6877b5d7c 114
miruga27 0:7fb6877b5d7c 115 /* vi: set ts=4 sw=4 expandtab: */