Add RIFF wave format support. Update documentation.

1 files changed, 73 insertions, 13 deletions

diff --git a/include/smelt.hpp b/include/smelt.hpp
index 111c4b8..5435d15 100644
--- a/include/smelt.hpp
+++ b/include/smelt.hpp
@@ -73,7 +73,9 @@ typedef size_t SMCHN;//Audio channel Handle
 typedef bool (*smHook)();
 
 //Special FPS modes
+//Unlimited FPS
 #define FPS_FREE 0
+//VSync
 #define FPS_VSYNC -1
 
 //Primitives
@@ -127,29 +129,29 @@ class SMELT
 public:
 	SMELT(){}
 	virtual ~SMELT(){}
-	/*
+	/**
 	 * Releases the acquired SMELT interface.
 	 * Decreases the internal reference counter by one. If the counter
 	 * reaches 0, SMELT core will release all resources managed by it
 	 * (if smFinale() is not yet called) and destroy the interface.
 	 */
 	virtual void smRelease()=0;
-	/*
+	/**
 	 * Initializes SMELT core.
 	 * Creates application window, initializes video, audio and input
 	 * handling. No functions in these categories can be called before
 	 * the core is initialized.
 	 * Returns true on succees, false on failure. Error details will be
-	 * written to the log file.
+	 * written to the log file and stderr.
 	 */
 	virtual bool smInit()=0;
-	/*
+	/**
 	 * Deinitializes SMELT core.
 	 * Closes application window and frees resources managed by the core.
 	 * The core will return to the status before calling smInit().
 	 */
 	virtual void smFinale()=0;
-	/*
+	/**
 	 * Enters the main loop.
 	 * The main loop calls update function, focus gain function, focus
 	 * lost function and quit function periodally, handles input events
@@ -159,27 +161,27 @@ public:
 	 * The main loop breaks when the update function returns true.
 	 */
 	virtual void smMainLoop()=0;
-	/*
+	/**
 	 * Sets the update function.
 	 * Update function is called every frame.
 	 * It returns true when you want to terminate the main loop.
 	 */
 	virtual void smUpdateFunc(smHook func)=0;
-	/*
+	/**
 	 * Sets the focus lost function.
 	 * Focus lost function is called when the application window loses
 	 * focus.
 	 * The return value of the focus lost function has no effect.
 	 */
 	virtual void smUnFocFunc(smHook func)=0;
-	/*
+	/**
 	 * Sets the focus gain function.
 	 * Focus gain function is called when the application window gains
 	 * focus. Also called when the application window is created.
 	 * The return value of the focus gain function has no effect.
 	 */
 	virtual void smFocFunc(smHook func)=0;
-	/*
+	/**
 	 * Sets the quit function.
 	 * Quit function is called when the user attempts to close the
 	 * application window.
@@ -187,16 +189,17 @@ public:
 	 * Otherwise the main loop will break.
 	 */
 	virtual void smQuitFunc(smHook func)=0;
-	/*
+	/**
 	 * Sets the window title of the application window.
 	 * The default window title is "untitled".
 	 */
 	virtual void smWinTitle(const char* title)=0;
-	/*
+	/**
 	 * Tests if the application window has focus.
+	 * Returns the test result.
 	 */
 	virtual bool smIsActive()=0;
-	/*
+	/**
 	 * Changes the behavior when the application window loses focus.
 	 * By default, the main loop pauses when the application loses focus
 	 * (para=false).
@@ -225,21 +228,78 @@ public:
 	virtual void smLog(const char* format,...)=0;
 	/*
 	 * Saves the content of the application window to the given path.
-	 * The picture is saved in BMP format.
+	 * The picture is saved in the BMP format.
 	 */
 	virtual void smScreenShot(const char* path)=0;
 
+	/*
+	 * Sets the desired FPS value. The macros FPS_* can be used
+	 */
 	virtual void smSetFPS(int fps)=0;
+	/*
+	 * Get *current* FPS value your application is running at.
+	 * Not the value you set!
+	 * Returns the FPS value, which is updated once a second.
+	 */
 	virtual float smGetFPS()=0;
+	/*
+	 * Get delta time between the current frame and the last frame.
+	 * Return the value in seconds.
+	 */
 	virtual float smGetDelta()=0;
+	/*
+	 * Get elapsed time since calling smInit() in seconds.
+	 * Returns the result.
+	 */
 	virtual float smGetTime()=0;
 
+	/*
+	 * Load a single sound file into memory.
+	 * Currently only ogg and wav files are supported.
+	 * This function loads and decodes the ogg data, which may take
+	 * noticeable time to complete. Consider running it in a seperate
+	 * thread if you are loading a larger file.
+	 * Returns the SFX handle on success, or 0 on failure.
+	 */
 	virtual SMSFX smSFXLoad(const char *path)=0;
+	/*
+	 * Loads sound file from the given memory block.
+	 * Only ogg and wav formats are supported.
+	 * Returns the SFX handle on success, or 0 on failure.
+	 */
 	virtual SMSFX smSFXLoadFromMemory(const char *ptr,DWORD size)=0;
+	/*
+	 * Plays the sound.
+	 * If loop is set to false, the audio won't loop even if loop points
+	 * are set.
+	 * Volume should be between 0 to 100.
+	 * Panning should be between -100 to 100.
+	 * The values will be clamped to the range given above.
+	 * Returns the audio channel it occupies, or 0 if there's no audio
+	 * channel available.
+	 * Max audio channels can be modified in smelt_config.hpp.
+	 */
 	virtual SMCHN smSFXPlay(SMSFX fx,int vol=100,int pan=0,float pitch=1.,bool loop=0)=0;
+	/*
+	 * Gets the length of the audio, in seconds.
+	 * Returns the result.
+	 */
 	virtual float smSFXGetLengthf(SMSFX fx)=0;
+	/*
+	 * Gets the length of the audio, in sample numbers.
+	 * Returns the result.
+	 */
 	virtual DWORD smSFXGetLengthd(SMSFX fx)=0;
+	/*
+	 * Sets the loop points of the given sound.
+	 * By default, the whole sound is looped.
+	 * This function uses AL_SOFT_loop_points. So it may not work if
+	 * SMELT isn't build against OpenAL Soft
+	 */
 	virtual void smSFXSetLoopPoint(SMSFX fx,DWORD l,DWORD r)=0;
+	/*
+	 * Unloads the audio file from memory.
+	 */
 	virtual void smSFXFree(SMSFX fx)=0;
 
 	virtual void smChannelVol(SMCHN chn,int vol)=0;