The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

FROGGS / SDL-2.548 / lib / SDLx / FPS.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
—
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

              
package SDLx::FPS;
use strict;
use warnings;
use SDL::GFX::Framerate;
use SDL::GFX::FPSManager;
use Carp;
our @ISA = qw(SDL::GFX::FPSManager);
our $VERSION = 2.548;
sub new {
        my ( $class, %args ) = @_;
        for ( grep { $_ ne 'fps' } keys %args ) {
                Carp::cluck("Unrecognized constructor hash key: $_");
        }
        my $fps = $class->SDL::GFX::FPSManager::new( 0, 0, 0, 0 );
        SDL::GFX::Framerate::init( $fps );
        $fps->set( $args{fps} ) if defined $args{fps};
        $fps;
}
sub set {
        SDL::GFX::Framerate::set( @_[ 0, 1 ] );
}
sub get {
        SDL::GFX::Framerate::get( $_[0] );
}
sub delay {
        SDL::GFX::Framerate::delay( $_[0] );
}
1;
__END__
=head1 NAME
SDLx::FPS - a more convenient way to set a framerate
=head1 SYNOPSIS
 use SDLx::FPS;
 my $fps = SDLx::FPS->new(fps => 60);
 while(1) { # Main game loop
     # Do game related stuff
     $fps->delay;
 }
=head1 DESCRIPTION
SDLx::FPS simplifies the task of giving your game a framerate.
Basically, it combines the methods of C<SDL::GFX::Framerate> and C<SDL::GFX::FPSManager> into a single module.
Use it to delay the main loop to keep it at a specified framerate.
=head1 METHODS
=head2 new
 my $fps = SDLx::FPS->new( fps => 30 );
No arguments are required, if no C<fps> is specified, the default FPS is 30.
=head2 set
 $fps->set($new_framerate);
Same as C<SDL::GFX::Framerate::set>.
Set the new desired framerate.
=head2 get
Same as C<SDL::GFX::Framerate::get>.
Get the currently set framerate.
=head2 delay
Same as C<SDL::GFX::Framerate::delay>.
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.
=head2 framecount
Return the C<framecount>.
=head2 rateticks
Return the C<rateticks>.
=head2 lastticks
Return the C<lastticks>.
=head2 rate
Return the C<rate>.
=head1 AUTHORS
See L<SDL/AUTHORS>.
=head1 SEE ALSO
L<< SDL::GFX::Framerate >>, L<< SDL::GFX::FPSManager >>