Permalink
Browse files

Merge branch 'experimental' of https://GitHub.Com/PerlGameDev/SDL int…

…o Pip-dox
  • Loading branch information...
2 parents 94c1d3e + 0b0e9ec commit d6601b6eaef1b32d40d5947344497f86348ac3bd @pip pip committed Mar 28, 2011
Showing with 39 additions and 0 deletions.
  1. +3 −0 CHANGELOG
  2. +36 −0 lib/pods/SDL/Mixer.pod
View
@@ -1,5 +1,8 @@
Revision history for Perl extension SDL_perl.
+* 2.531_03 March 21 2011
+ - setting parent_perl to NULL for non-threaded perls [FROGGS]
+
* 2.531_02 March 20 2011
- using parent Perls context in SDL::Mixer::Music's callbacks instead of TLS [FROGGS]
- Adding sleep(2) to core_palette.t [FROGGS]
View
@@ -79,6 +79,42 @@ Export tag: ':status'
SDL::Mixer allows you to enable sound, alter music volume settings, and lets you play, pause and resume, as well as fading the sound and music
in and out.
+=head2 Supported Formats
+
+The SDL Mixer library is a multi-channel audio mixer. It supports I<8 channels> of B<16 bit> stereo audio, and a I<single channel for music>.
+
+You can use the channels to load samples (i.e. sound effects) in the following formats:
+
+=over 4
+
+=item * Microsoft WAVE files (WAV)
+
+=item * Creative Labs VOC files (VOC)
+
+=item * MIDI files (if compiled with Timidity)
+
+=back
+
+If you use MIDI, you should note that the process of mixing MIDI files to wave output is very CPU-intensive, so if playing regular WAVE
+files sound great, but playing MIDI files sound choppy, try using 8-bit audio, mono audio, or lower frequencies.
+
+The music channel can play the following formats:
+
+=over 4
+
+=item * AIFF
+
+=item * MOD (.mod .xm .s3m .669 .it .med and more - if compiled with libmikmod)
+
+=item * OggVorbis (.ogg - if compiled with ogg/vorbis libraries)
+
+=item * MP3 (if compiled with SMPEG or MAD libraries)
+
+=item * FLAC (if compiled with FLAC library)
+
+=back
+
+
=head1 METHODS
=head2 init

0 comments on commit d6601b6

Please sign in to comment.