1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<title>SDL_gfx: I:/Sources/sdlgfx/SDL_framerate.h File Reference</title> 7 8<link href="tabs.css" rel="stylesheet" type="text/css"/> 9<link href="doxygen.css" rel="stylesheet" type="text/css" /> 10 11 12 13</head> 14<body> 15<div id="top"><!-- do not remove this div! --> 16 17 18<div id="titlearea"> 19<table cellspacing="0" cellpadding="0"> 20 <tbody> 21 <tr style="height: 56px;"> 22 23 24 <td style="padding-left: 0.5em;"> 25 <div id="projectname">SDL_gfx 26  <span id="projectnumber">2.0.25</span> 27 </div> 28 29 </td> 30 31 32 33 </tr> 34 </tbody> 35</table> 36</div> 37 38<!-- Generated by Doxygen 1.8.0 --> 39 <div id="navrow1" class="tabs"> 40 <ul class="tablist"> 41 <li><a href="index.html"><span>Main Page</span></a></li> 42 <li><a href="annotated.html"><span>Data Structures</span></a></li> 43 <li class="current"><a href="files.html"><span>Files</span></a></li> 44 </ul> 45 </div> 46 <div id="navrow2" class="tabs2"> 47 <ul class="tablist"> 48 <li><a href="files.html"><span>File List</span></a></li> 49 <li><a href="globals.html"><span>Globals</span></a></li> 50 </ul> 51 </div> 52</div> 53<div class="header"> 54 <div class="summary"> 55<a href="#nested-classes">Data Structures</a> | 56<a href="#define-members">Defines</a> | 57<a href="#func-members">Functions</a> </div> 58 <div class="headertitle"> 59<div class="title">I:/Sources/sdlgfx/SDL_framerate.h File Reference</div> </div> 60</div><!--header--> 61<div class="contents"> 62<div class="textblock"><code>#include "SDL.h"</code><br/> 63</div> 64<p><a href="_s_d_l__framerate_8h_source.html">Go to the source code of this file.</a></p> 65<table class="memberdecls"> 66<tr><td colspan="2"><h2><a name="nested-classes"></a> 67Data Structures</h2></td></tr> 68<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a></td></tr> 69<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure holding the state and timing information of the framerate controller. <a href="struct_f_p_smanager.html#details">More...</a><br/></td></tr> 70<tr><td colspan="2"><h2><a name="define-members"></a> 71Defines</h2></td></tr> 72<tr class="memitem:aeaeac0f0b439344496e29abf60904d58"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#aeaeac0f0b439344496e29abf60904d58">FPS_UPPER_LIMIT</a>   200</td></tr> 73<tr class="memdesc:aeaeac0f0b439344496e29abf60904d58"><td class="mdescLeft"> </td><td class="mdescRight">Highest possible rate supported by framerate controller in Hz (1/s). <a href="#aeaeac0f0b439344496e29abf60904d58"></a><br/></td></tr> 74<tr class="memitem:a9555dceeaaffdd2669c991e6a300085b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#a9555dceeaaffdd2669c991e6a300085b">FPS_LOWER_LIMIT</a>   1</td></tr> 75<tr class="memdesc:a9555dceeaaffdd2669c991e6a300085b"><td class="mdescLeft"> </td><td class="mdescRight">Lowest possible rate supported by framerate controller in Hz (1/s). <a href="#a9555dceeaaffdd2669c991e6a300085b"></a><br/></td></tr> 76<tr class="memitem:ab3ac02e6acb348129a019b9f20aa5c90"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#ab3ac02e6acb348129a019b9f20aa5c90">FPS_DEFAULT</a>   30</td></tr> 77<tr class="memdesc:ab3ac02e6acb348129a019b9f20aa5c90"><td class="mdescLeft"> </td><td class="mdescRight">Default rate of framerate controller in Hz (1/s). <a href="#ab3ac02e6acb348129a019b9f20aa5c90"></a><br/></td></tr> 78<tr class="memitem:a3dea4aed583d439f014e606c18da6fe4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a>   extern</td></tr> 79<tr><td colspan="2"><h2><a name="func-members"></a> 80Functions</h2></td></tr> 81<tr class="memitem:a3ca69231486837c809fdcbe5b0a10787"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#a3ca69231486837c809fdcbe5b0a10787">SDL_initFramerate</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr> 82<tr class="memdesc:a3ca69231486837c809fdcbe5b0a10787"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the framerate manager. <a href="#a3ca69231486837c809fdcbe5b0a10787"></a><br/></td></tr> 83<tr class="memitem:a186ef8e6b1ee4ab36e05b162545fb0e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#a186ef8e6b1ee4ab36e05b162545fb0e4">SDL_setFramerate</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager, Uint32 rate)</td></tr> 84<tr class="memdesc:a186ef8e6b1ee4ab36e05b162545fb0e4"><td class="mdescLeft"> </td><td class="mdescRight">Set the framerate in Hz. <a href="#a186ef8e6b1ee4ab36e05b162545fb0e4"></a><br/></td></tr> 85<tr class="memitem:adeb2ddd02412527aad226ba453a21999"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#adeb2ddd02412527aad226ba453a21999">SDL_getFramerate</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr> 86<tr class="memdesc:adeb2ddd02412527aad226ba453a21999"><td class="mdescLeft"> </td><td class="mdescRight">Return the current target framerate in Hz. <a href="#adeb2ddd02412527aad226ba453a21999"></a><br/></td></tr> 87<tr class="memitem:a3f3b7da73f3d92ff82b069b6108aa7ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#a3f3b7da73f3d92ff82b069b6108aa7ad">SDL_getFramecount</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr> 88<tr class="memdesc:a3f3b7da73f3d92ff82b069b6108aa7ad"><td class="mdescLeft"> </td><td class="mdescRight">Return the current framecount. <a href="#a3f3b7da73f3d92ff82b069b6108aa7ad"></a><br/></td></tr> 89<tr class="memitem:a2c452933d7376dbb0083304b760ed63b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> Uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#a2c452933d7376dbb0083304b760ed63b">SDL_framerateDelay</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr> 90<tr class="memdesc:a2c452933d7376dbb0083304b760ed63b"><td class="mdescLeft"> </td><td class="mdescRight">Delay execution to maintain a constant framerate and calculate fps. <a href="#a2c452933d7376dbb0083304b760ed63b"></a><br/></td></tr> 91</table> 92<hr/><h2>Define Documentation</h2> 93<a class="anchor" id="ab3ac02e6acb348129a019b9f20aa5c90"></a> 94<div class="memitem"> 95<div class="memproto"> 96 <table class="memname"> 97 <tr> 98 <td class="memname">#define <a class="el" href="_s_d_l__framerate_8h.html#ab3ac02e6acb348129a019b9f20aa5c90">FPS_DEFAULT</a>   30</td> 99 </tr> 100 </table> 101</div> 102<div class="memdoc"> 103 104<p>Default rate of framerate controller in Hz (1/s). </p> 105 106<p>Definition at line <a class="el" href="_s_d_l__framerate_8h_source.html#l00057">57</a> of file <a class="el" href="_s_d_l__framerate_8h_source.html">SDL_framerate.h</a>.</p> 107 108</div> 109</div> 110<a class="anchor" id="a9555dceeaaffdd2669c991e6a300085b"></a> 111<div class="memitem"> 112<div class="memproto"> 113 <table class="memname"> 114 <tr> 115 <td class="memname">#define <a class="el" href="_s_d_l__framerate_8h.html#a9555dceeaaffdd2669c991e6a300085b">FPS_LOWER_LIMIT</a>   1</td> 116 </tr> 117 </table> 118</div> 119<div class="memdoc"> 120 121<p>Lowest possible rate supported by framerate controller in Hz (1/s). </p> 122 123<p>Definition at line <a class="el" href="_s_d_l__framerate_8h_source.html#l00052">52</a> of file <a class="el" href="_s_d_l__framerate_8h_source.html">SDL_framerate.h</a>.</p> 124 125</div> 126</div> 127<a class="anchor" id="aeaeac0f0b439344496e29abf60904d58"></a> 128<div class="memitem"> 129<div class="memproto"> 130 <table class="memname"> 131 <tr> 132 <td class="memname">#define <a class="el" href="_s_d_l__framerate_8h.html#aeaeac0f0b439344496e29abf60904d58">FPS_UPPER_LIMIT</a>   200</td> 133 </tr> 134 </table> 135</div> 136<div class="memdoc"> 137 138<p>Highest possible rate supported by framerate controller in Hz (1/s). </p> 139 140<p>Definition at line <a class="el" href="_s_d_l__framerate_8h_source.html#l00047">47</a> of file <a class="el" href="_s_d_l__framerate_8h_source.html">SDL_framerate.h</a>.</p> 141 142</div> 143</div> 144<a class="anchor" id="a3dea4aed583d439f014e606c18da6fe4"></a> 145<div class="memitem"> 146<div class="memproto"> 147 <table class="memname"> 148 <tr> 149 <td class="memname">#define <a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a>   extern</td> 150 </tr> 151 </table> 152</div> 153<div class="memdoc"> 154 155<p>Definition at line <a class="el" href="_s_d_l__framerate_8h_source.html#l00082">82</a> of file <a class="el" href="_s_d_l__framerate_8h_source.html">SDL_framerate.h</a>.</p> 156 157</div> 158</div> 159<hr/><h2>Function Documentation</h2> 160<a class="anchor" id="a2c452933d7376dbb0083304b760ed63b"></a> 161<div class="memitem"> 162<div class="memproto"> 163 <table class="memname"> 164 <tr> 165 <td class="memname"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> Uint32 <a class="el" href="_s_d_l__framerate_8h.html#a2c452933d7376dbb0083304b760ed63b">SDL_framerateDelay</a> </td> 166 <td>(</td> 167 <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> 168 <td class="paramname"><em>manager</em></td><td>)</td> 169 <td></td> 170 </tr> 171 </table> 172</div> 173<div class="memdoc"> 174 175<p>Delay execution to maintain a constant framerate and calculate fps. </p> 176<p>Generate a delay to accomodate currently set framerate. Call once in the graphics/rendering loop. If the computer cannot keep up with the rate (i.e. drawing too slow), the delay is zero and the delay interpolation is reset.</p> 177<dl class="params"><dt><b>Parameters:</b></dt><dd> 178 <table class="params"> 179 <tr><td class="paramname">manager</td><td>Pointer to the framerate manager.</td></tr> 180 </table> 181 </dd> 182</dl> 183<dl class="section return"><dt>Returns:</dt><dd>The time that passed since the last call to the function in ms. May return 0. </dd></dl> 184 185<p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00146">146</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> 186 187</div> 188</div> 189<a class="anchor" id="a3f3b7da73f3d92ff82b069b6108aa7ad"></a> 190<div class="memitem"> 191<div class="memproto"> 192 <table class="memname"> 193 <tr> 194 <td class="memname"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> int <a class="el" href="_s_d_l__framerate_8h.html#a3f3b7da73f3d92ff82b069b6108aa7ad">SDL_getFramecount</a> </td> 195 <td>(</td> 196 <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> 197 <td class="paramname"><em>manager</em></td><td>)</td> 198 <td></td> 199 </tr> 200 </table> 201</div> 202<div class="memdoc"> 203 204<p>Return the current framecount. </p> 205<p>Get the current framecount from the framerate manager. A frame is counted each time SDL_framerateDelay is called.</p> 206<dl class="params"><dt><b>Parameters:</b></dt><dd> 207 <table class="params"> 208 <tr><td class="paramname">manager</td><td>Pointer to the framerate manager.</td></tr> 209 </table> 210 </dd> 211</dl> 212<dl class="section return"><dt>Returns:</dt><dd>Current frame count or -1 for error. </dd></dl> 213 214<p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00126">126</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> 215 216</div> 217</div> 218<a class="anchor" id="adeb2ddd02412527aad226ba453a21999"></a> 219<div class="memitem"> 220<div class="memproto"> 221 <table class="memname"> 222 <tr> 223 <td class="memname"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> int <a class="el" href="_s_d_l__framerate_8h.html#adeb2ddd02412527aad226ba453a21999">SDL_getFramerate</a> </td> 224 <td>(</td> 225 <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> 226 <td class="paramname"><em>manager</em></td><td>)</td> 227 <td></td> 228 </tr> 229 </table> 230</div> 231<div class="memdoc"> 232 233<p>Return the current target framerate in Hz. </p> 234<p>Get the currently set framerate of the manager.</p> 235<dl class="params"><dt><b>Parameters:</b></dt><dd> 236 <table class="params"> 237 <tr><td class="paramname">manager</td><td>Pointer to the framerate manager.</td></tr> 238 </table> 239 </dd> 240</dl> 241<dl class="section return"><dt>Returns:</dt><dd>Current framerate in Hz or -1 for error. </dd></dl> 242 243<p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00107">107</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> 244 245</div> 246</div> 247<a class="anchor" id="a3ca69231486837c809fdcbe5b0a10787"></a> 248<div class="memitem"> 249<div class="memproto"> 250 <table class="memname"> 251 <tr> 252 <td class="memname"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> void <a class="el" href="_s_d_l__framerate_8h.html#a3ca69231486837c809fdcbe5b0a10787">SDL_initFramerate</a> </td> 253 <td>(</td> 254 <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> 255 <td class="paramname"><em>manager</em></td><td>)</td> 256 <td></td> 257 </tr> 258 </table> 259</div> 260<div class="memdoc"> 261 262<p>Initialize the framerate manager. </p> 263<p>Initialize the framerate manager, set default framerate of 30Hz and reset delay interpolation.</p> 264<dl class="params"><dt><b>Parameters:</b></dt><dd> 265 <table class="params"> 266 <tr><td class="paramname">manager</td><td>Pointer to the framerate manager. </td></tr> 267 </table> 268 </dd> 269</dl> 270 271<p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00062">62</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> 272 273</div> 274</div> 275<a class="anchor" id="a186ef8e6b1ee4ab36e05b162545fb0e4"></a> 276<div class="memitem"> 277<div class="memproto"> 278 <table class="memname"> 279 <tr> 280 <td class="memname"><a class="el" href="_s_d_l__framerate_8h.html#a3dea4aed583d439f014e606c18da6fe4">SDL_FRAMERATE_SCOPE</a> int <a class="el" href="_s_d_l__framerate_8h.html#a186ef8e6b1ee4ab36e05b162545fb0e4">SDL_setFramerate</a> </td> 281 <td>(</td> 282 <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> 283 <td class="paramname"><em>manager</em>, </td> 284 </tr> 285 <tr> 286 <td class="paramkey"></td> 287 <td></td> 288 <td class="paramtype">Uint32 </td> 289 <td class="paramname"><em>rate</em> </td> 290 </tr> 291 <tr> 292 <td></td> 293 <td>)</td> 294 <td></td><td></td> 295 </tr> 296 </table> 297</div> 298<div class="memdoc"> 299 300<p>Set the framerate in Hz. </p> 301<p>Sets a new framerate for the manager and reset delay interpolation. Rate values must be between FPS_LOWER_LIMIT and FPS_UPPER_LIMIT inclusive to be accepted.</p> 302<dl class="params"><dt><b>Parameters:</b></dt><dd> 303 <table class="params"> 304 <tr><td class="paramname">manager</td><td>Pointer to the framerate manager. </td></tr> 305 <tr><td class="paramname">rate</td><td>The new framerate in Hz (frames per second).</td></tr> 306 </table> 307 </dd> 308</dl> 309<dl class="section return"><dt>Returns:</dt><dd>0 for sucess and -1 for error. </dd></dl> 310 311<p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00086">86</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> 312 313</div> 314</div> 315</div><!-- contents --> 316 317 318<hr class="footer"/><address class="footer"><small> 319Generated by  <a href="http://www.doxygen.org/index.html"> 320<img class="footer" src="doxygen.png" alt="doxygen"/> 321</a> 1.8.0 322</small></address> 323 324</body> 325</html> 326
