Btk
SDL2_framerate.h
1 /*
2 
3 SDL2_framerate.h: framerate manager
4 
5 Copyright (C) 2012-2014 Andreas Schiffler
6 
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.
10 
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:
14 
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.
19 
20 2. Altered source versions must be plainly marked as such, and must not be
21 misrepresented as being the original software.
22 
23 3. This notice may not be removed or altered from any source
24 distribution.
25 
26 Andreas Schiffler -- aschiffler at ferzkopp dot net
27 
28 */
29 
30 #ifndef _SDL2_framerate_h
31 #define _SDL2_framerate_h
32 
33 /* Set up for C function definitions, even when using C++ */
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38  /* --- */
39 
40 #include <SDL2/SDL.h>
41 
42 
43  /* --------- Definitions */
44 
48 #define FPS_UPPER_LIMIT 200
49 
53 #define FPS_LOWER_LIMIT 1
54 
58 #define FPS_DEFAULT 30
59 
63  typedef struct {
64  Uint32 framecount;
65  float rateticks;
66  Uint32 baseticks;
67  Uint32 lastticks;
68  Uint32 rate;
69  } FPSmanager;
70 
71  /* ---- Function Prototypes */
72 
73 #ifdef _MSC_VER
74 # if defined(DLL_EXPORT) && !defined(LIBSDL2_GFX_DLL_IMPORT)
75 # define SDL2_FRAMERATE_SCOPE __declspec(dllexport)
76 # else
77 # ifdef LIBSDL2_GFX_DLL_IMPORT
78 # define SDL2_FRAMERATE_SCOPE __declspec(dllimport)
79 # endif
80 # endif
81 #endif
82 #ifndef SDL2_FRAMERATE_SCOPE
83 # define SDL2_FRAMERATE_SCOPE extern
84 #endif
85 
86  /* Functions return 0 or value for sucess and -1 for error */
87 
88  SDL2_FRAMERATE_SCOPE void SDL_initFramerate(FPSmanager * manager);
89  SDL2_FRAMERATE_SCOPE int SDL_setFramerate(FPSmanager * manager, Uint32 rate);
90  SDL2_FRAMERATE_SCOPE int SDL_getFramerate(FPSmanager * manager);
91  SDL2_FRAMERATE_SCOPE int SDL_getFramecount(FPSmanager * manager);
92  SDL2_FRAMERATE_SCOPE Uint32 SDL_framerateDelay(FPSmanager * manager);
93 
94  /* --- */
95 
96  /* Ends C function definitions when using C++ */
97 #ifdef __cplusplus
98 }
99 #endif
100 
101 #endif /* _SDL2_framerate_h */
FPSmanager
Structure holding the state and timing information of the framerate controller.
Definition: SDL2_framerate.h:63