Applied Magnet's Patch

[sdlgit/SDL_perl.git] / lib / docs / Sound.pod

diff --git a/lib/docs/Sound.pod b/lib/docs/Sound.pod
new file mode 100644 (file)
index 0000000..0858653
--- /dev/null
+++ b/lib/docs/Sound.pod
@@ -0,0 +1,31 @@
+=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