Clean up files that could mess up merge
[sdlgit/SDL_perl.git] / lib / SDL / Music.pm
CommitLineData
bfd90409 1#!/usr/bin/env perl
2#
3# Music.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
31package SDL::Music;
32
33use strict;
34use SDL;
35
36sub new {
37 my $proto = shift;
38 my $class = ref($proto) || $proto;
39 my $filename = shift;
40 my $self = \SDL::MixLoadMusic($filename);
41 die SDL::GetError() unless $$self;
42 bless $self,$class;
43 return $self;
44}
45
46sub DESTROY {
47 my $self = shift;
48 SDL::MixFreeMusic($$self);
49}
50
511;
52
53__END__;
54
55=pod
56
57=head1 NAME
58
59SDL::Music - a perl extension
60
61=head1 DESCRIPTION
62
63L<SDL::Music> is used to load music files for use with L<SDL::Mixer>.
64To load a music file one simply creates a new object passing the filename
65to the constructor:
66
67 my $music = new SDL::Music 'my_song.ogg';
68
69
70=head1 AUTHOR
71
72David J. Goehrig
73
74=head1 SEE ALSO
75
76L<perl> L<SDL::Mixer>
77
78=cut