<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>SDL_gfx: SDL_framerate.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> </div> <div class="contents"> <h1>SDL_framerate.h File Reference</h1><code>#include "SDL.h"</code><br/> <p><a href="_s_d_l__framerate_8h_source.html">Go to the source code of this file.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Data Structures</h2></td></tr> <tr><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> <tr><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> <tr><td colspan="2"><h2>Defines</h2></td></tr> <tr><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> <tr><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> <tr><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> <tr><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> <tr><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> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default rate of framerate controller in Hz (1/s). <a href="#ab3ac02e6acb348129a019b9f20aa5c90"></a><br/></td></tr> <tr><td colspan="2"><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">SDL_FRAMERATE_SCOPE 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> <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the framerate manager. <a href="#a3ca69231486837c809fdcbe5b0a10787"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">SDL_FRAMERATE_SCOPE int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#a2e3d03ef080b6e2337661992c4b6c208">SDL_setFramerate</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager, int rate)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the framerate in Hz. <a href="#a2e3d03ef080b6e2337661992c4b6c208"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">SDL_FRAMERATE_SCOPE 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> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current target framerate in Hz. <a href="#adeb2ddd02412527aad226ba453a21999"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">SDL_FRAMERATE_SCOPE 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> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current framecount. <a href="#a3f3b7da73f3d92ff82b069b6108aa7ad"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">SDL_FRAMERATE_SCOPE void </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__framerate_8h.html#a5c85c9846e5b0d3abff57480501710a3">SDL_framerateDelay</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Delay execution to maintain a constant framerate and calculate fps. <a href="#a5c85c9846e5b0d3abff57480501710a3"></a><br/></td></tr> </table> <hr/><h2>Define Documentation</h2> <a class="anchor" id="ab3ac02e6acb348129a019b9f20aa5c90"></a><!-- doxytag: member="SDL_framerate.h::FPS_DEFAULT" ref="ab3ac02e6acb348129a019b9f20aa5c90" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define FPS_DEFAULT 30</td> </tr> </table> </div> <div class="memdoc"> <p>Default rate of framerate controller in Hz (1/s). </p> <p>Definition at line <a class="el" href="_s_d_l__framerate_8h_source.html#l00037">37</a> of file <a class="el" href="_s_d_l__framerate_8h_source.html">SDL_framerate.h</a>.</p> </div> </div> <a class="anchor" id="a9555dceeaaffdd2669c991e6a300085b"></a><!-- doxytag: member="SDL_framerate.h::FPS_LOWER_LIMIT" ref="a9555dceeaaffdd2669c991e6a300085b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define FPS_LOWER_LIMIT 1</td> </tr> </table> </div> <div class="memdoc"> <p>Lowest possible rate supported by framerate controller in Hz (1/s). </p> <p>Definition at line <a class="el" href="_s_d_l__framerate_8h_source.html#l00032">32</a> of file <a class="el" href="_s_d_l__framerate_8h_source.html">SDL_framerate.h</a>.</p> </div> </div> <a class="anchor" id="aeaeac0f0b439344496e29abf60904d58"></a><!-- doxytag: member="SDL_framerate.h::FPS_UPPER_LIMIT" ref="aeaeac0f0b439344496e29abf60904d58" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define FPS_UPPER_LIMIT 200</td> </tr> </table> </div> <div class="memdoc"> <p>Highest possible rate supported by framerate controller in Hz (1/s). </p> <p>Definition at line <a class="el" href="_s_d_l__framerate_8h_source.html#l00027">27</a> of file <a class="el" href="_s_d_l__framerate_8h_source.html">SDL_framerate.h</a>.</p> </div> </div> <hr/><h2>Function Documentation</h2> <a class="anchor" id="a5c85c9846e5b0d3abff57480501710a3"></a><!-- doxytag: member="SDL_framerate.h::SDL_framerateDelay" ref="a5c85c9846e5b0d3abff57480501710a3" args="(FPSmanager *manager)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SDL_FRAMERATE_SCOPE void SDL_framerateDelay </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> <td class="paramname"> <em>manager</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Delay execution to maintain a constant framerate and calculate fps. </p> <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> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the framerate manager. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00099">99</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> </div> </div> <a class="anchor" id="a3f3b7da73f3d92ff82b069b6108aa7ad"></a><!-- doxytag: member="SDL_framerate.h::SDL_getFramecount" ref="a3f3b7da73f3d92ff82b069b6108aa7ad" args="(FPSmanager *manager)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SDL_FRAMERATE_SCOPE int SDL_getFramecount </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> <td class="paramname"> <em>manager</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Return the current framecount. </p> <p>Get the current framecount from the framerate manager. A frame is counted each time SDL_framerateDelay is called.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the framerate manager.</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>Current frame count or -1 for error. </dd></dl> <p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00081">81</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> </div> </div> <a class="anchor" id="adeb2ddd02412527aad226ba453a21999"></a><!-- doxytag: member="SDL_framerate.h::SDL_getFramerate" ref="adeb2ddd02412527aad226ba453a21999" args="(FPSmanager *manager)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SDL_FRAMERATE_SCOPE int SDL_getFramerate </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> <td class="paramname"> <em>manager</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Return the current target framerate in Hz. </p> <p>Get the currently set framerate of the manager.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the framerate manager.</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>Current framerate in Hz or -1 for error. </dd></dl> <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> </div> </div> <a class="anchor" id="a3ca69231486837c809fdcbe5b0a10787"></a><!-- doxytag: member="SDL_framerate.h::SDL_initFramerate" ref="a3ca69231486837c809fdcbe5b0a10787" args="(FPSmanager *manager)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SDL_FRAMERATE_SCOPE void SDL_initFramerate </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> <td class="paramname"> <em>manager</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Initialize the framerate manager. </p> <p>Initialize the framerate manager, set default framerate of 30Hz and reset delay interpolation.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the framerate manager. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00019">19</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> </div> </div> <a class="anchor" id="a2e3d03ef080b6e2337661992c4b6c208"></a><!-- doxytag: member="SDL_framerate.h::SDL_setFramerate" ref="a2e3d03ef080b6e2337661992c4b6c208" args="(FPSmanager *manager, int rate)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SDL_FRAMERATE_SCOPE int SDL_setFramerate </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td> <td class="paramname"> <em>manager</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>rate</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Set the framerate in Hz. </p> <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> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the framerate manager. </td></tr> <tr><td valign="top"></td><td valign="top"><em>rate</em> </td><td>The new framerate in Hz (frames per second).</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>0 for sucess and -1 for error. </dd></dl> <p>Definition at line <a class="el" href="_s_d_l__framerate_8c_source.html#l00041">41</a> of file <a class="el" href="_s_d_l__framerate_8c_source.html">SDL_framerate.c</a>.</p> </div> </div> </div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>