diff options
Diffstat (limited to 'src/resources/soundeffect.h')
-rw-r--r-- | src/resources/soundeffect.h | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/src/resources/soundeffect.h b/src/resources/soundeffect.h new file mode 100644 index 000000000..e7c832f42 --- /dev/null +++ b/src/resources/soundeffect.h @@ -0,0 +1,75 @@ +/* + * The Mana Client + * Copyright (C) 2004-2009 The Mana World Development Team + * Copyright (C) 2009-2010 The Mana Developers + * + * This file is part of The Mana Client. + * + * This program 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. + * + * This program 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 this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#ifndef SOUND_EFFECT_H +#define SOUND_EFFECT_H + +#include "resources/resource.h" + +#ifdef __APPLE__ +#include <SDL_mixer/SDL_mixer.h> +#else +#include <SDL_mixer.h> +#endif + +/** + * 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 Resource *load(void *buffer, unsigned bufferSize); + + /** + * 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): mChunk(soundEffect) {} + + Mix_Chunk *mChunk; +}; + +#endif // SOUND_EFFECT_H |