<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="NAME_CONTENT">
-<p>SDL::GFX::FPSManager - blitting functions</p>
+<p>SDL::GFX::FPSManager - data structure used by SDL::GFX::Framerate</p>
</div>
<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="CATEGORY_CONTENT">
-<p>TODO, GFX, FPSManager</p>
+<p>GFX, FPSManager</p>
</div>
<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
</div>
<h2 id="new">new</h2>
<div id="new_CONTENT">
-<pre> FPSmanager *
- gfx_fps_new (CLASS, framecount, rateticks, lastticks, rate)
- char *CLASS
- Uint32 framecount
- float rateticks
- Uint32 lastticks
- Uint32 rate
- CODE:
- RETVAL = (FPSmanager *) safemalloc(sizeof(FPSmanager));
- RETVAL->framecount = framecount;
- RETVAL->rateticks = rateticks;
- RETVAL->lastticks = lastticks;
- RETVAL->rate = rate;
- OUTPUT:
- RETVAL
+<pre> use SDL;
+ use SDL::GFX::Framerate;
+ use SDL::GFX::FPSManager;
+
+ my $fps = SDL::GFX::FPSManager->new(0, 0, 0, 0);
</pre>
+<p>Initialize the framerate manager object. Arguments: framecount, rateticks, lastticks, rate.</p>
</div>
<h2 id="framecount">framecount</h2>
<div id="framecount_CONTENT">
-<pre> Uint32
- gfx_fps_framecount ( fps, ... )
- FPSmanager *fps
- CODE:
- if (items > 1 ) fps->framecount = SvIV(ST(1));
- RETVAL = fps->framecount;
- OUTPUT:
- RETVAL
+<pre> my $fc = $fps->framecount;
</pre>
+<p>Returns the <code>framecount</code>.</p>
</div>
<h2 id="rateticks">rateticks</h2>
<div id="rateticks_CONTENT">
-<pre> float
- gfx_fps_rateticks ( fps, ... )
- FPSmanager *fps
- CODE:
- if (items > 1 ) fps->rateticks = SvNV(ST(1));
- RETVAL = fps->rateticks;
- OUTPUT:
- RETVAL
+<pre> my $rt = $fps->rateticks;
</pre>
+<p>Returns the <code>rateticks</code>.</p>
</div>
<h2 id="lastticks">lastticks</h2>
<div id="lastticks_CONTENT">
-<pre> Uint32
- gfx_fps_lastticks ( fps, ... )
- FPSmanager *fps
- CODE:
- if (items > 1 ) fps->lastticks = SvIV(ST(1));
- RETVAL = fps->lastticks;
- OUTPUT:
- RETVAL
+<pre> my $lt = $fps->lastticks;
</pre>
+<p>Returns the <code>lastticks</code>.</p>
</div>
<h2 id="rate">rate</h2>
<div id="rate_CONTENT">
-<pre> Uint32
- gfx_fps_rate ( fps, ... )
- FPSmanager *fps
- CODE:
- if (items > 1 ) fps->rate = SvIV(ST(1));
- RETVAL = fps->rate;
- OUTPUT:
- RETVAL
-
-
-
+<pre> my $r = $fps->rate;
</pre>
+<p>Returns the <code>rate</code>.</p>
</div>
</div>
\ No newline at end of file
<ul><li><a href="#NAME">NAME</a></li>
<li><a href="#CATEGORY">CATEGORY</a></li>
+<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#METHODS">METHODS</a>
<ul><li><a href="#init">init</a></li>
<li><a href="#set">set</a></li>
<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="NAME_CONTENT">
-<p>SDL::GFX::Primitives - framerate calculating functions</p>
+<p>SDL::GFX::Framerate - framerate calculating functions</p>
</div>
<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
<p>GFX, Framerate</p>
</div>
+<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="DESCRIPTION_CONTENT">
+<p>The framerate functions are used to insert delays into the graphics loop to maintain a constant framerate.</p>
+
+</div>
<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="METHODS_CONTENT">
</div>
<h2 id="init">init</h2>
<div id="init_CONTENT">
-<p>void
-gfx_frame_init(manager)
- FPSmanager * manager
- CODE:
- SDL_initFramerate(manager);</p>
+<pre> use SDL;
+ use SDL::GFX::Framerate;
+ use SDL::GFX::FPSManager;
+
+ my $fps = SDL::GFX::FPSManager->new(0, 0, 0, 0);
+
+ SDL::GFX::Framerate::init($fps);
+
+</pre>
+<p>Initialize the framerate manager, set default framerate of 30Hz and reset delay interpolation.</p>
</div>
<h2 id="set">set</h2>
<div id="set_CONTENT">
-<p>int
-gfx_frame_set(manager, rate)
- FPSmanager * manager
- int rate
- CODE:
- RETVAL = SDL_setFramerate(manager, rate);
- OUTPUT:
- RETVAL</p>
+<pre> SDL::GFX::Framerate::set($fps, 60);
+
+</pre>
+<p>Sets the new desired framerate to 60 frames per second.</p>
</div>
<h2 id="get">get</h2>
<div id="get_CONTENT">
-<p>int
-gfx_frame_get(manager)
- FPSmanager * manager
- CODE:
- RETVAL = SDL_getFramerate(manager);
- OUTPUT:
- RETVAL</p>
+<pre> my $rate = SDL::GFX::Framerate::get($fps);
+
+</pre>
+<p>Get the currently set framerate of the manager.</p>
</div>
<h2 id="delay">delay</h2>
<div id="delay_CONTENT">
-<p>void
-gfx_frame_delay(manager)
- FPSmanager * manager
- CODE:
- SDL_framerateDelay(manager);</p>
+<pre> SDL::GFX::Framerate::delay($fps);
+
+</pre>
+<p>Generate a delay to accomodate currently set framerate. Call once in thegraphics/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>
projects / sdlgit/SDL-Site.git / commitdiff