.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SDLx::FPS 3pm"
.TH SDLx::FPS 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDLx::FPS \- a more convenient way to set a framerate
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\& use SDLx::FPS;
\& my $fps = SDLx::FPS\->new(fps => 60);
\& while(1) { # Main game loop
\&     # Do game related stuff
\&
\&     $fps\->delay;
\& }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
SDLx::FPS simplifies the task of giving your game a framerate.
Basically, it combines the methods of \f(CW\*(C`SDL::GFX::Framerate\*(C'\fR and \f(CW\*(C`SDL::GFX::FPSManager\*(C'\fR into a single module.
Use it to delay the main loop to keep it at a specified framerate.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 1
\& my $fps = SDLx::FPS\->new( fps => 30 );
.Ve
.PP
No arguments are required, if no \f(CW\*(C`fps\*(C'\fR is specified, the default FPS is 30.
.SS set
.IX Subsection "set"
.Vb 1
\& $fps\->set($new_framerate);
.Ve
.PP
Same as \f(CW\*(C`SDL::GFX::Framerate::set\*(C'\fR.
Set the new desired framerate.
.SS get
.IX Subsection "get"
Same as \f(CW\*(C`SDL::GFX::Framerate::get\*(C'\fR.
Get the currently set framerate.
.SS delay
.IX Subsection "delay"
Same as \f(CW\*(C`SDL::GFX::Framerate::delay\*(C'\fR.
Generate a delay to accommodate 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 0 and the delay interpolation is reset.
.SS framecount
.IX Subsection "framecount"
Return the \f(CW\*(C`framecount\*(C'\fR.
.SS rateticks
.IX Subsection "rateticks"
Return the \f(CW\*(C`rateticks\*(C'\fR.
.SS lastticks
.IX Subsection "lastticks"
Return the \f(CW\*(C`lastticks\*(C'\fR.
.SS rate
.IX Subsection "rate"
Return the \f(CW\*(C`rate\*(C'\fR.
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SDL::GFX::Framerate, SDL::GFX::FPSManager