blob: 69d9823d6d512d0f29168c45b29811da9e405310 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*
* 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 <SDL_mixer.h>
#include "resource.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);
/**
* 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
|
