<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>My Project: SDL_timer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SDL_timer.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="SDL__stdinc_8h_source.html">SDL_stdinc.h</a>"</code><br />
<code>#include "<a class="el" href="SDL__error_8h_source.html">SDL_error.h</a>"</code><br />
<code>#include "<a class="el" href="begin__code_8h_source.html">begin_code.h</a>"</code><br />
<code>#include "<a class="el" href="close__code_8h_source.html">close_code.h</a>"</code><br />
</div>
<p><a href="SDL__timer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a5cc109e24ba0c46f6becb28353cd8921"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#a5cc109e24ba0c46f6becb28353cd8921">SDL_TICKS_PASSED</a>(A, B)   ((<a class="el" href="SDL__stdinc_8h.html#a7a90b941db9d4582e9ad7abb9940ff7e">Sint32</a>)((B) - (A)) <= 0)</td></tr>
<tr class="memdesc:a5cc109e24ba0c46f6becb28353cd8921"><td class="mdescLeft"> </td><td class="mdescRight">Compare SDL ticks values, and return true if A has passed B. <a href="#a5cc109e24ba0c46f6becb28353cd8921">More...</a><br /></td></tr>
<tr class="separator:a5cc109e24ba0c46f6becb28353cd8921"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a66c1e77a064d368116fcb0720ff84a05"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66c1e77a064d368116fcb0720ff84a05"></a>
typedef <a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> * </td><td class="memItemRight" valign="bottom"><b>param</b></td></tr>
<tr class="separator:a66c1e77a064d368116fcb0720ff84a05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a412e8ff8a6c89615ba8f9486b292213a"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#a412e8ff8a6c89615ba8f9486b292213a">SDL_TimerID</a></td></tr>
<tr class="separator:a412e8ff8a6c89615ba8f9486b292213a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0b9bc71d6287e0ffafdc3419760fe2b3"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#a0b9bc71d6287e0ffafdc3419760fe2b3">SDL_GetTicks</a> (<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a>)</td></tr>
<tr class="memdesc:a0b9bc71d6287e0ffafdc3419760fe2b3"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of milliseconds since the SDL library initialization. <a href="#a0b9bc71d6287e0ffafdc3419760fe2b3">More...</a><br /></td></tr>
<tr class="separator:a0b9bc71d6287e0ffafdc3419760fe2b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2dbeb63c4f0564811a4adf3938808977"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2dbeb63c4f0564811a4adf3938808977"></a>
DECLSPEC <a class="el" href="SDL__stdinc_8h.html#ac006cf2bd55a42a9cc8ae9f123aa7e13">Uint64</a> SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#a2dbeb63c4f0564811a4adf3938808977">SDL_GetPerformanceCounter</a> (<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a>)</td></tr>
<tr class="memdesc:a2dbeb63c4f0564811a4adf3938808977"><td class="mdescLeft"> </td><td class="mdescRight">Get the current value of the high resolution counter. <br /></td></tr>
<tr class="separator:a2dbeb63c4f0564811a4adf3938808977"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a507ebea12e31dacc9f85f7d9febe0efb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a507ebea12e31dacc9f85f7d9febe0efb"></a>
DECLSPEC <a class="el" href="SDL__stdinc_8h.html#ac006cf2bd55a42a9cc8ae9f123aa7e13">Uint64</a> SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#a507ebea12e31dacc9f85f7d9febe0efb">SDL_GetPerformanceFrequency</a> (<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a>)</td></tr>
<tr class="memdesc:a507ebea12e31dacc9f85f7d9febe0efb"><td class="mdescLeft"> </td><td class="mdescRight">Get the count per second of the high resolution counter. <br /></td></tr>
<tr class="separator:a507ebea12e31dacc9f85f7d9febe0efb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8050b95373b95249064467592ab4e21"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8050b95373b95249064467592ab4e21"></a>
DECLSPEC <a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#ae8050b95373b95249064467592ab4e21">SDL_Delay</a> (<a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> ms)</td></tr>
<tr class="memdesc:ae8050b95373b95249064467592ab4e21"><td class="mdescLeft"> </td><td class="mdescRight">Wait a specified number of milliseconds before returning. <br /></td></tr>
<tr class="separator:ae8050b95373b95249064467592ab4e21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeff98fcba90694d3267b1c549aa65eec"><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#aeff98fcba90694d3267b1c549aa65eec">Uint32</a> (SDLCALL *SDL_TimerCallback)(<a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> interval</td></tr>
<tr class="separator:aeff98fcba90694d3267b1c549aa65eec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56ceea49587e3fa5796b2e4bf85603b8"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="SDL__timer_8h.html#a412e8ff8a6c89615ba8f9486b292213a">SDL_TimerID</a> SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#a56ceea49587e3fa5796b2e4bf85603b8">SDL_AddTimer</a> (<a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> interval, SDL_TimerCallback callback, <a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> *param)</td></tr>
<tr class="memdesc:a56ceea49587e3fa5796b2e4bf85603b8"><td class="mdescLeft"> </td><td class="mdescRight">Add a new timer to the pool of timers already running. <a href="#a56ceea49587e3fa5796b2e4bf85603b8">More...</a><br /></td></tr>
<tr class="separator:a56ceea49587e3fa5796b2e4bf85603b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe8d418e59a24ae6ad820b92137ab9b2"><td class="memItemLeft" align="right" valign="top">DECLSPEC SDL_bool SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__timer_8h.html#afe8d418e59a24ae6ad820b92137ab9b2">SDL_RemoveTimer</a> (<a class="el" href="SDL__timer_8h.html#a412e8ff8a6c89615ba8f9486b292213a">SDL_TimerID</a> id)</td></tr>
<tr class="memdesc:afe8d418e59a24ae6ad820b92137ab9b2"><td class="mdescLeft"> </td><td class="mdescRight">Remove a timer knowing its ID. <a href="#afe8d418e59a24ae6ad820b92137ab9b2">More...</a><br /></td></tr>
<tr class="separator:afe8d418e59a24ae6ad820b92137ab9b2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header for the SDL time management routines. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a5cc109e24ba0c46f6becb28353cd8921"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDL_TICKS_PASSED</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">A, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">B </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   ((<a class="el" href="SDL__stdinc_8h.html#a7a90b941db9d4582e9ad7abb9940ff7e">Sint32</a>)((B) - (A)) <= 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare SDL ticks values, and return true if A has passed B. </p>
<p>e.g. if you want to wait 100 ms, you could do this: Uint32 timeout = <a class="el" href="SDL__timer_8h.html#a0b9bc71d6287e0ffafdc3419760fe2b3" title="Get the number of milliseconds since the SDL library initialization. ">SDL_GetTicks()</a> + 100; while (!SDL_TICKS_PASSED(<a class="el" href="SDL__timer_8h.html#a0b9bc71d6287e0ffafdc3419760fe2b3" title="Get the number of milliseconds since the SDL library initialization. ">SDL_GetTicks()</a>, timeout)) { ... do work until timeout has elapsed } </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a412e8ff8a6c89615ba8f9486b292213a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> <a class="el" href="SDL__timer_8h.html#a412e8ff8a6c89615ba8f9486b292213a">SDL_TimerID</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition of the timer ID type. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a56ceea49587e3fa5796b2e4bf85603b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC <a class="el" href="SDL__timer_8h.html#a412e8ff8a6c89615ba8f9486b292213a">SDL_TimerID</a> SDLCALL SDL_AddTimer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td>
<td class="paramname"><em>interval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SDL_TimerCallback </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> * </td>
<td class="paramname"><em>param</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new timer to the pool of timers already running. </p>
<dl class="section return"><dt>Returns</dt><dd>A timer ID, or NULL when an error occurs. </dd></dl>
</div>
</div>
<a class="anchor" id="a0b9bc71d6287e0ffafdc3419760fe2b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC <a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> SDLCALL SDL_GetTicks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of milliseconds since the SDL library initialization. </p>
<dl class="section note"><dt>Note</dt><dd>This value wraps if the program runs for more than ~49 days. </dd></dl>
</div>
</div>
<a class="anchor" id="afe8d418e59a24ae6ad820b92137ab9b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__timer_8h.html#a412e8ff8a6c89615ba8f9486b292213a">SDL_TimerID</a> </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a timer knowing its ID. </p>
<dl class="section return"><dt>Returns</dt><dd>A boolean value indicating success or failure.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>It is not safe to remove a timer multiple times. </dd></dl>
</div>
</div>
<a class="anchor" id="aeff98fcba90694d3267b1c549aa65eec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td>
<td>(</td>
<td class="paramtype">SDLCALL * </td>
<td class="paramname"><em>SDL_TimerCallback</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function prototype for the timer callback function.</p>
<p>The callback function is passed the current timer interval and returns the next timer interval. If the returned value is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled. If the callback returns 0, the periodic alarm is cancelled. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 16 2014 16:33:09 for My Project by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
