[sdlgit/SDL_perl.git] / lib / SDL / Music.pm

#!/usr/bin/env perl
#
# Music.pm
#
# Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
#
# ------------------------------------------------------------------------------
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
# 
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
# 
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
#
# ------------------------------------------------------------------------------
#
# Please feel free to send questions, suggestions or improvements to:
#
#	David J. Goehrig
#	dgoehrig@cpan.org
#

package SDL::Music;

use strict;
use warnings;
use Carp;
use SDL;

sub new {
	my $proto = shift;	
	my $class = ref($proto) || $proto;
	my $filename = shift;
	my $self = \SDL::MixLoadMusic($filename);
	croak SDL::GetError() unless $$self;
	bless $self,$class;
	return $self;
}

sub DESTROY {
	my $self = shift;
	SDL::MixFreeMusic($$self);
}

1;

__END__;

=pod

=head1 NAME

SDL::Music - a perl extension

=head1 DESCRIPTION

L<SDL::Music> is used to load music files for use with L<SDL::Mixer>.
To load a music file one simply creates a new object passing the filename 
to the constructor:

	my $music = new SDL::Music 'my_song.ogg';


=head1 AUTHOR

David J. Goehrig

=head1 SEE ALSO

L<perl> L<SDL::Mixer>

=cut
Commit	Line	Data
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
	31	package SDL::Music;
	32
	33	use strict;
084b921f	34	use warnings;
084b921f	35	use Carp;
bfd90409	36	use SDL;
	37
	38	sub new {
	39	my $proto = shift;
	40	my $class = ref($proto) \|\| $proto;
	41	my $filename = shift;
	42	my $self = \SDL::MixLoadMusic($filename);
cc6d0c7c	43	croak SDL::GetError() unless $$self;
bfd90409	44	bless $self,$class;
	45	return $self;
	46	}
	47
	48	sub DESTROY {
	49	my $self = shift;
	50	SDL::MixFreeMusic($$self);
	51	}
	52
	53	1;
	54
	55	__END__;
	56
	57	=pod
	58
	59	=head1 NAME
	60
	61	SDL::Music - a perl extension
	62
	63	=head1 DESCRIPTION
	64
	65	L<SDL::Music> is used to load music files for use with L<SDL::Mixer>.
	66	To load a music file one simply creates a new object passing the filename
	67	to the constructor:
	68
	69	my $music = new SDL::Music 'my_song.ogg';
	70
	71
	72	=head1 AUTHOR
	73
	74	David J. Goehrig
	75
	76	=head1 SEE ALSO
	77
	78	L<perl> L<SDL::Mixer>
	79
	80	=cut