summaryrefslogtreecommitdiffhomepage
path: root/src/audio.h
diff options
context:
space:
mode:
authorraysan5 <[email protected]>2017-03-19 12:52:58 +0100
committerraysan5 <[email protected]>2017-03-19 12:52:58 +0100
commit8f5ff64420dda659583c156b9c5e42e60384e247 (patch)
tree2b0ee8a47d38a41cc105b6b79211b2873ca2b21c /src/audio.h
parentca8c56561792a58d9b66fef668cf9d3a0fc4e876 (diff)
downloadraylib-8f5ff64420dda659583c156b9c5e42e60384e247.tar.gz
raylib-8f5ff64420dda659583c156b9c5e42e60384e247.zip
Working on file header comments...
Diffstat (limited to 'src/audio.h')
-rw-r--r--src/audio.h28
1 files changed, 16 insertions, 12 deletions
diff --git a/src/audio.h b/src/audio.h
index 01ed9f72..a0279e3a 100644
--- a/src/audio.h
+++ b/src/audio.h
@@ -1,13 +1,16 @@
/**********************************************************************************************
*
-* raylib.audio
+* raylib.audio - Basic funtionality to work with audio
*
-* This module provides basic functionality to work with audio:
-* Manage audio device (init/close)
-* Load and Unload audio files (WAV, OGG, FLAC, XM, MOD)
-* Play/Stop/Pause/Resume loaded audio
-* Manage mixing channels
-* Manage raw audio context
+* DESCRIPTION:
+*
+* This module provides basic functionality to:
+* - Manage audio device (init/close)
+* - Load and unload audio files
+* - Format wave data (sample rate, size, channels)
+* - Play/Stop/Pause/Resume loaded audio
+* - Manage mixing channels
+* - Manage raw audio context
*
* DEPENDENCIES:
* OpenAL Soft - Audio device management (http://kcat.strangesoft.net/openal.html)
@@ -16,11 +19,12 @@
* jar_mod - MOD audio file loading
* dr_flac - FLAC audio file loading
*
-* Many thanks to Joshua Reisenauer (github: @kd7tck) for the following additions:
-* XM audio module support (jar_xm)
-* MOD audio module support (jar_mod)
-* Mixing channels support
-* Raw audio context support
+* CONTRIBUTORS:
+* Joshua Reisenauer (github: @kd7tck):
+* - XM audio module support (jar_xm)
+* - MOD audio module support (jar_mod)
+* - Mixing channels support
+* - Raw audio context support
*
*
* LICENSE: zlib/libpng