Merged garu's changes: new Game::Rect, TTFont docs, and tests for
[sdlgit/SDL_perl.git] / lib / SDL / Font.pm
1 #!/usr/bin/env perl
2 #
3 # Font.pm
4 #
5 # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
6 #
7 # ------------------------------------------------------------------------------
8 #
9 # This library is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public
11 # License as published by the Free Software Foundation; either
12 # version 2.1 of the License, or (at your option) any later version.
13
14 # This library is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # Lesser General Public License for more details.
18
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with this library; if not, write to the Free Software
21 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 #
23 # ------------------------------------------------------------------------------
24 #
25 # Please feel free to send questions, suggestions or improvements to:
26 #
27 #       David J. Goehrig
28 #       dgoehrig@cpan.org
29 #
30
31 package SDL::Font;
32
33 use strict;
34 use warnings;
35 use Carp;
36 use SDL;
37 use SDL::SFont;
38 use SDL::Surface;
39
40 use vars qw(@ISA $CurrentFont );
41             
42
43 @ISA = qw(SDL::Surface);
44
45
46 sub new {
47         my $proto = shift;
48         my $class = ref($proto) || $proto;
49         my $self = \SDL::SFont::NewFont(shift);
50         bless $self,$class;
51         return $self;   
52 }
53
54 sub DESTROY {
55         my $self = shift;
56         SDL::FreeSurface($$self);
57 }
58
59 sub use ($) {
60         my $self = shift;
61         $CurrentFont = $self;
62         if ( $self->isa('SDL::Font')) {
63                 SDL::SFont::UseFont($$self);
64         }       
65 }
66
67 1;
68
69 __END__;
70
71 =pod
72
73
74 =head1 NAME
75
76 SDL::Font - a SDL perl extension
77
78 =head1 SYNOPSIS
79
80   $font = new Font "Font.png";
81   $font->use();
82         
83 =head1 DESCRIPTION
84
85 L<SDL::Font> provides an interface to loading and using SFont style 
86 fonts with L<SDL::Surface> objects.  
87
88 =head1 AUTHOR
89
90 David J. Goehrig
91
92 =head1 SEE ALSO
93
94 L<perl> L<SDL::Surface>
95
96 =cut