diff options
author | Eugenio Favalli <elvenprogrammer@gmail.com> | 2005-04-10 14:16:58 +0000 |
---|---|---|
committer | Eugenio Favalli <elvenprogrammer@gmail.com> | 2005-04-10 14:16:58 +0000 |
commit | 26d50af0fb1b07e662978f7c341a3c2548074840 (patch) | |
tree | 548619f2a360bcef9227bbde4aa1592128a48e53 /src/resources/soundeffect.h | |
parent | b42e9e23fd6fe4819d34f04124ba66eca6a6c020 (diff) | |
download | mana-client-26d50af0fb1b07e662978f7c341a3c2548074840.tar.gz mana-client-26d50af0fb1b07e662978f7c341a3c2548074840.tar.bz2 mana-client-26d50af0fb1b07e662978f7c341a3c2548074840.tar.xz mana-client-26d50af0fb1b07e662978f7c341a3c2548074840.zip |
Resource manager can now load sfx and music as samples.
(added a new sfx to test the sound engine)
Diffstat (limited to 'src/resources/soundeffect.h')
-rw-r--r-- | src/resources/soundeffect.h | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/src/resources/soundeffect.h b/src/resources/soundeffect.h new file mode 100644 index 00000000..959a8e2e --- /dev/null +++ b/src/resources/soundeffect.h @@ -0,0 +1,78 @@ +/* + * The Mana World + * Copyright 2004 The Mana World Development Team + * + * This file is part of The Mana World. + * + * The Mana World is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * any later version. + * + * The Mana World 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with The Mana World; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * $Id$ + */ + +#ifndef _TMW_SOUND_EFFECT_H +#define _TMW_SOUND_EFFECT_H + +#include "resource.h" +#include <SDL.h> +#include <SDL_mixer.h> + +/** + * Defines a class for loading and storing sound effects. + */ +class SoundEffect : public Resource +{ + public: + /** + * Destructor. + */ + virtual ~SoundEffect(); + + /** + * Loads a sample from a buffer in memory. + * + * @param buffer The memory buffer containing the sample data. + * @param bufferSize The size of the memory buffer in bytes. + * + * @return <code>NULL</code> if the an error occurred, a valid pointer + * otherwise. + */ + static SoundEffect *load(void* buffer, unsigned int bufferSize); + + /** + * Frees the resources created by SDL. + */ + virtual void unload(); + + /** + * Plays the sample. + * + * @param loops Number of times to repeat the playback. + * @param volume Sample playback volume. + * + * @return <code>true</code> if the playback started properly + * <code>false</code> otherwise. + */ + virtual bool play(int loops, int volume); + + protected: + /** + * Constructor. + */ + SoundEffect(Mix_Chunk *soundEffect); + + Mix_Chunk *soundEffect; +}; + +#endif |