fixed list

[sdlgit/SDL-Site.git] / pages / SDL-Timer.html-inc

<div class="pod">
<!-- INDEX START -->
<h3 id="TOP">Index</h3>

<ul><li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#METHODS">METHODS</a>
<ul><li><a href="#get_ticks">get_ticks()</a></li>
<li><a href="#delay_ms">delay(ms)</a></li>
<li><a href="#add_timer_interval_callback_param">add_timer(interval,callback,param)</a>
<ul>
<li>
<ul><li><a href="#Parameters">Parameters</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#remove_timer_id">remove_timer( id )</a></li>
<li><a href="#set_timer_interval_callback">set_timer( interval,callback )</a>
</li>
</ul>
</li>
</ul><hr />
<!-- INDEX END -->

<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="NAME_CONTENT">
<p>SDL::Time - a SDL perl extension for managing timers.</p>





</div>
<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="SYNOPSIS_CONTENT">











</div>
<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="METHODS_CONTENT">





</div>
<h2 id="get_ticks">get_ticks()</h2>
<div id="get_ticks_CONTENT">
<p>Returns the number of milliseconds since SDL library initialization. This value wraps around if the program runs for more than 49.7 days</p>





</div>
<h2 id="delay_ms">delay(ms)</h2>
<div id="delay_ms_CONTENT">
<p>This function waits a specified number of milliseconds before returning. It waits at least the specified time, but possible longer due to OS scheduling. The delay granularity is at least 10 ms. Some platforms have shorter clock ticks but this is the most common.
SDL::delay doesn't returns anything.</p>

</div>
<h2 id="add_timer_interval_callback_param">add_timer(interval,callback,param)</h2>
<div id="add_timer_interval_callback_param_CO">
<p>Adds a callback function to be run after the specified number of milliseconds has elapsed. 
The callback function is passed the current timer interval and the user supplied parameter from the SDL::add_timer call and returns the next timer interval.
If the returned value from the callback is the same as the one passed in, the timer continues at the same rate.
If the returned value from the callback is 0, the timer is cancelled.</p>
<p>Another way to cancel a currently-running timer is by calling SDL::remove_timer with the timer's ID (which was returned from SDL::add_timer).</p>
<p>The timer callback function may run in a different thread than your main program, and so shouldn't call any functions from within itself. 
However, you may always call SDL::push_event.</p>
<p>SDL::add_timer returns the identifier value of the generated timer or undef on error. </p>
<p>Note : If you use this function, you need to pass SDL_INIT_TIMER to SDL::init. </p>

</div>
<h4 id="Parameters">Parameters</h4>
<div id="Parameters_CONTENT">
<pre>	interval [in]   The desired interval of the timer, in milliseconds. 
			The granularity of the timer is platform-dependent, but you should count on it being at least 10 ms as this is the most common number.
			This means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system. 
			If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a timer for 30 ms (see example below). 

	callback [in]   The SDL timer callback function which is called when the specified interval elapses. 

	param [in]	The user parameter which is passed to the callback function 




</pre>

</div>
<h2 id="remove_timer_id">remove_timer( id )</h2>
<div id="remove_timer_id_CONTENT">
<p>Removes a timer callback previously added with SDL::add_timer. 
It returns 0 on succés or -1 on error.</p>

</div>
<h2 id="set_timer_interval_callback">set_timer( interval,callback )</h2>
<div id="set_timer_interval_callback_CONTENT">
<p>Set a callback to run after the specified number of milliseconds has elapsed.
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.</p>
<p>To cancel a currently running timer, call SDL::set_timer(0, NULL);</p>
<p>The timer callback function may run in a different thread than your main constant, and so shouldn't call any functions from within itself.</p>
<p>The maximum resolution of this timer is 10 ms, which means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system. If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a timer for 30 ms (see example below).</p>
<p>If you use this function, you need to pass SDL_INIT_TIMER to SDL::init(). 
Note: This function is kept for compatibility but has been superseded by the new timer functions SDL::add_timer and SDL::remove_timer which support multiple timers.</p>





</div>
</div>