.\" -*- 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 "pods::SDL::GFX::Framerate 3pm"
.TH pods::SDL::GFX::Framerate 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
SDL::GFX::Framerate \- framerate calculating functions
.SH CATEGORY
.IX Header "CATEGORY"
GFX
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The framerate functions are used to insert delays into the graphics loop to maintain a constant framerate.
.SH METHODS
.IX Header "METHODS"
.SS init
.IX Subsection "init"
.Vb 3
\& 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);
.Ve
.PP
Initialize the framerate manager, set default framerate of 30Hz and reset delay interpolation.
.SS set
.IX Subsection "set"
.Vb 1
\& SDL::GFX::Framerate::set($fps, 60);
.Ve
.PP
Sets the new desired framerate to 60 frames per second.
.SS get
.IX Subsection "get"
.Vb 1
\& my $rate = SDL::GFX::Framerate::get($fps);
.Ve
.PP
Get the currently set framerate of the manager.
.SS delay
.IX Subsection "delay"
.Vb 1
\& SDL::GFX::Framerate::delay($fps);
.Ve
.PP
Generate a delay to accommodate the 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.
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.