3
SDL2_framerate.h: framerate manager
5
Copyright (C) 2012 Andreas Schiffler
7
This software is provided 'as-is', without any express or implied
8
warranty. In no event will the authors be held liable for any damages
9
arising from the use of this software.
11
Permission is granted to anyone to use this software for any purpose,
12
including commercial applications, and to alter it and redistribute it
13
freely, subject to the following restrictions:
15
1. The origin of this software must not be misrepresented; you must not
16
claim that you wrote the original software. If you use this software
17
in a product, an acknowledgment in the product documentation would be
18
appreciated but is not required.
20
2. Altered source versions must be plainly marked as such, and must not be
21
misrepresented as being the original software.
23
3. This notice may not be removed or altered from any source
26
Andreas Schiffler -- aschiffler at ferzkopp dot net
30
#ifndef _SDL2_framerate_h
31
#define _SDL2_framerate_h
33
/* Set up for C function definitions, even when using C++ */
42
/* --------- Definitions */
45
\brief Highest possible rate supported by framerate controller in Hz (1/s).
47
#define FPS_UPPER_LIMIT 200
50
\brief Lowest possible rate supported by framerate controller in Hz (1/s).
52
#define FPS_LOWER_LIMIT 1
55
\brief Default rate of framerate controller in Hz (1/s).
57
#define FPS_DEFAULT 30
60
\brief Structure holding the state and timing information of the framerate controller.
71
/* ---- Function Prototypes */
74
# if defined(DLL_EXPORT) && !defined(LIBSDL2_GFX_DLL_IMPORT)
75
# define SDL2_FRAMERATE_SCOPE __declspec(dllexport)
77
# ifdef LIBSDL2_GFX_DLL_IMPORT
78
# define SDL2_FRAMERATE_SCOPE __declspec(dllimport)
82
#ifndef SDL2_FRAMERATE_SCOPE
83
# define SDL2_FRAMERATE_SCOPE extern
86
/* Functions return 0 or value for sucess and -1 for error */
88
SDL2_FRAMERATE_SCOPE void SDL_initFramerate(FPSmanager *const manager);
89
SDL2_FRAMERATE_SCOPE int SDL_setFramerate(FPSmanager *const manager,
91
SDL2_FRAMERATE_SCOPE int SDL_getFramerate(FPSmanager *const manager);
92
SDL2_FRAMERATE_SCOPE int SDL_getFramecount(FPSmanager *const manager);
93
SDL2_FRAMERATE_SCOPE uint32_t SDL_framerateDelay(FPSmanager *const
98
/* Ends C function definitions when using C++ */
103
#endif /* _SDL2_framerate_h */
added
removed
src/sdl2gfx/SDL2_framerate.h
