~ubuntu-branches/ubuntu/trusty/libsdl2-gfx/trusty-proposed

<a href="_s_d_l2__framerate_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 /*

<a name="l00002"></a>00002

<a name="l00003"></a>00003 SDL2_framerate.h: framerate manager

<a name="l00004"></a>00004

<a name="l00006"></a>00006

<a name="l00007"></a>00007 This software is provided 'as-is', without any express or implied

<a name="l00008"></a>00008 warranty. In no event will the authors be held liable for any damages

<a name="l00009"></a>00009 arising from the use of this software.

<a name="l00010"></a>00010

<a name="l00011"></a>00011 Permission is granted to anyone to use this software for any purpose,

<a name="l00012"></a>00012 including commercial applications, and to alter it and redistribute it

<a name="l00013"></a>00013 freely, subject to the following restrictions:

<a name="l00014"></a>00014

<a name="l00015"></a>00015 1. The origin of this software must not be misrepresented; you must not

<a name="l00016"></a>00016 claim that you wrote the original software. If you use this software

<a name="l00017"></a>00017 in a product, an acknowledgment in the product documentation would be

<a name="l00018"></a>00018 appreciated but is not required.

<a name="l00019"></a>00019

<a name="l00020"></a>00020 2. Altered source versions must be plainly marked as such, and must not be

<a name="l00021"></a>00021 misrepresented as being the original software.

<a name="l00022"></a>00022

<a name="l00023"></a>00023 3. This notice may not be removed or altered from any source

<a name="l00024"></a>00024 distribution.

<a name="l00025"></a>00025

<a name="l00026"></a>00026 Andreas Schiffler -- aschiffler at ferzkopp dot net

<a name="l00027"></a>00027

<a name="l00028"></a>00028 */

<a name="l00029"></a>00029

<a name="l00030"></a>00030 #ifndef _SDL2_framerate_h

<a name="l00031"></a>00031 #define _SDL2_framerate_h

<a name="l00032"></a>00032

<a name="l00033"></a>00033 /* Set up for C function definitions, even when using C++ */

<a name="l00034"></a>00034 #ifdef __cplusplus

<a name="l00035"></a>00035 extern "C" {

<a name="l00036"></a>00036 #endif

<a name="l00037"></a>00037

<a name="l00038"></a>00038 /* --- */

<a name="l00039"></a>00039

<a name="l00040"></a>00040 #include "SDL.h"

<a name="l00041"></a>00041

<a name="l00042"></a>00042 /* --------- Definitions */

100

<a name="l00043"></a>00043

101

<a name="l00047"></a><a class="code" href="_s_d_l2__framerate_8h.html#aeaeac0f0b439344496e29abf60904d58">00047</a> #define FPS_UPPER_LIMIT 200

102

<a name="l00048"></a>00048

103

<a name="l00052"></a><a class="code" href="_s_d_l2__framerate_8h.html#a9555dceeaaffdd2669c991e6a300085b">00052</a> #define FPS_LOWER_LIMIT 1

104

<a name="l00053"></a>00053

105

<a name="l00057"></a><a class="code" href="_s_d_l2__framerate_8h.html#ab3ac02e6acb348129a019b9f20aa5c90">00057</a> #define FPS_DEFAULT 30

106

<a name="l00058"></a>00058

107

<a name="l00062"></a><a class="code" href="struct_f_p_smanager.html">00062</a> typedef struct {

108

<a name="l00063"></a><a class="code" href="struct_f_p_smanager.html#a05019faae5de8486dbb69d24b24eed78">00063</a> Uint32 <a class="code" href="struct_f_p_smanager.html#a05019faae5de8486dbb69d24b24eed78">framecount</a>;

109

<a name="l00064"></a><a class="code" href="struct_f_p_smanager.html#a48695d55d40900a197688bb773b9d431">00064</a> float <a class="code" href="struct_f_p_smanager.html#a48695d55d40900a197688bb773b9d431">rateticks</a>;

110

<a name="l00065"></a><a class="code" href="struct_f_p_smanager.html#ad853f9c03e200a77fd897c1ea3aec43d">00065</a> Uint32 <a class="code" href="struct_f_p_smanager.html#ad853f9c03e200a77fd897c1ea3aec43d">baseticks</a>;

111

<a name="l00066"></a><a class="code" href="struct_f_p_smanager.html#aa7716779b7cc57dee24c15d7c5d62e55">00066</a> Uint32 <a class="code" href="struct_f_p_smanager.html#aa7716779b7cc57dee24c15d7c5d62e55">lastticks</a>;

112

<a name="l00067"></a><a class="code" href="struct_f_p_smanager.html#af7eec7342fd8eb48d5f49ba7f5b91853">00067</a> Uint32 <a class="code" href="struct_f_p_smanager.html#af7eec7342fd8eb48d5f49ba7f5b91853">rate</a>;

113

<a name="l00068"></a>00068 } <a class="code" href="struct_f_p_smanager.html" title="Structure holding the state and timing information of the framerate controller.">FPSmanager</a>;

114

<a name="l00069"></a>00069

115

<a name="l00070"></a>00070 /* ---- Function Prototypes */

116

<a name="l00071"></a>00071

117

<a name="l00072"></a>00072 #ifdef _MSC_VER

118

<a name="l00073"></a>00073 # if defined(DLL_EXPORT) && !defined(LIBSDL2_GFX_DLL_IMPORT)

119

<a name="l00074"></a>00074 # define SDL2_FRAMERATE_SCOPE __declspec(dllexport)

120

<a name="l00075"></a>00075 # else

121

<a name="l00076"></a>00076 # ifdef LIBSDL2_GFX_DLL_IMPORT

122

<a name="l00077"></a>00077 # define SDL2_FRAMERATE_SCOPE __declspec(dllimport)

123

<a name="l00078"></a>00078 # endif

124

<a name="l00079"></a>00079 # endif

125

<a name="l00080"></a>00080 #endif

126

<a name="l00081"></a>00081 #ifndef SDL2_FRAMERATE_SCOPE

127

<a name="l00082"></a><a class="code" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">00082</a> # define SDL2_FRAMERATE_SCOPE extern

128

<a name="l00083"></a>00083 #endif

129

<a name="l00084"></a>00084

130

<a name="l00085"></a>00085 /* Functions return 0 or value for sucess and -1 for error */

131

<a name="l00086"></a>00086

132

<a name="l00087"></a>00087 <a class="code" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> void <a class="code" href="_s_d_l2__framerate_8c.html#a444ebaaaa6b1ceeafa921562bdab1a44" title="Initialize the framerate manager.">SDL_initFramerate</a>(<a class="code" href="struct_f_p_smanager.html" title="Structure holding the state and timing information of the framerate controller.">FPSmanager</a> * manager);

133

<a name="l00088"></a>00088 <a class="code" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int <a class="code" href="_s_d_l2__framerate_8c.html#afad4b503cf9719daced45fa4d9653d72" title="Set the framerate in Hz.">SDL_setFramerate</a>(<a class="code" href="struct_f_p_smanager.html" title="Structure holding the state and timing information of the framerate controller.">FPSmanager</a> * manager, Uint32 rate);

134

<a name="l00089"></a>00089 <a class="code" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int <a class="code" href="_s_d_l2__framerate_8c.html#a575bb511d6f817ad846a788cbd08ae91" title="Return the current target framerate in Hz.">SDL_getFramerate</a>(<a class="code" href="struct_f_p_smanager.html" title="Structure holding the state and timing information of the framerate controller.">FPSmanager</a> * manager);

135

<a name="l00090"></a>00090 <a class="code" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int <a class="code" href="_s_d_l2__framerate_8c.html#a96b13e26f8436222e866904a592a6eec" title="Return the current framecount.">SDL_getFramecount</a>(<a class="code" href="struct_f_p_smanager.html" title="Structure holding the state and timing information of the framerate controller.">FPSmanager</a> * manager);

136

<a name="l00091"></a>00091 <a class="code" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> Uint32 <a class="code" href="_s_d_l2__framerate_8c.html#afce13fa3dd37130deb4975d8b230c3ba" title="Delay execution to maintain a constant framerate and calculate fps.">SDL_framerateDelay</a>(<a class="code" href="struct_f_p_smanager.html" title="Structure holding the state and timing information of the framerate controller.">FPSmanager</a> * manager);

137

<a name="l00092"></a>00092

138

<a name="l00093"></a>00093 /* --- */

139

<a name="l00094"></a>00094

140

<a name="l00095"></a>00095 /* Ends C function definitions when using C++ */

141

<a name="l00096"></a>00096 #ifdef __cplusplus

142

<a name="l00097"></a>00097 }

143

<a name="l00098"></a>00098 #endif

144

<a name="l00099"></a>00099

145

<a name="l00100"></a>00100 #endif /* _SDL2_framerate_h */

146

</pre></div></div>

147

148

149

150

Generated by  <a href="http://www.doxygen.org/index.html">

151

152

</a> 1.8.0

153

</address>

154

155

</body>

156

</html>

Older »