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

#!/usr/bin/env perl
#
# Sound.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::Sound;
use strict;
use warnings;
use Carp;
sub new {
	my $proto = shift;	
	my $class = ref($proto) || $proto;
	my $filename = shift;
	my $self = \SDL::MixLoadWAV($filename);
	croak SDL::GetError() unless $$self;
	bless $self,$class;
	return $self;
}

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

sub volume {
	my $self = shift;
	my $volume = shift;
	return SDL::MixVolumeChunk($$self,$volume);
}

1;

__END__;

=pod


=head1 NAME

SDL::Sound - a perl extension

=head1 DESCRIPTION

L<SDL::Sound> is a module for loading WAV files for sound effects.
The file can be loaded by creating a new L<SDL::Sound> object by
passing the filename to the constructor;

	my $sound = new SDL::Sound 'my_sfx.wav';

=head1 METHODS

=head2 volume ( value )

Sets the volume of the sample.

=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	# Sound.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::Sound;
	32	use strict;
084b921f	33	use warnings;
084b921f	34	use Carp;
bfd90409	35	sub new {
	36	my $proto = shift;
	37	my $class = ref($proto) \|\| $proto;
	38	my $filename = shift;
	39	my $self = \SDL::MixLoadWAV($filename);
cc6d0c7c	40	croak SDL::GetError() unless $$self;
bfd90409	41	bless $self,$class;
	42	return $self;
	43	}
	44
	45	sub DESTROY {
	46	my $self = shift;
	47	SDL::MixFreeChunk($$self);
	48	}
	49
	50	sub volume {
	51	my $self = shift;
	52	my $volume = shift;
	53	return SDL::MixVolumeChunk($$self,$volume);
	54	}
	55
	56	1;
	57
	58	__END__;
	59
	60	=pod
	61
	62
	63
	64	=head1 NAME
	65
	66	SDL::Sound - a perl extension
	67
	68	=head1 DESCRIPTION
	69
	70	L<SDL::Sound> is a module for loading WAV files for sound effects.
	71	The file can be loaded by creating a new L<SDL::Sound> object by
	72	passing the filename to the constructor;
	73
	74	my $sound = new SDL::Sound 'my_sfx.wav';
	75
	76	=head1 METHODS
	77
	78	=head2 volume ( value )
	79
	80	Sets the volume of the sample.
	81
	82	=head1 AUTHOR
	83
	84	David J. Goehrig
	85
	86	=head1 SEE ALSO
	87
	88	L<perl> L<SDL::Mixer>
	89
	90	=cut