blob: c375fa0f87063b4a99379c634ab18e5064c9d6a4 (
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
74
75
76
77
78
79
80
|
/*
* The ManaPlus Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2013 The ManaPlus Developers
*
* This file is part of The ManaPlus 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"
#include <SDL_mixer.h>
#include "localconsts.h"
/**
* Defines a class for loading and storing sound effects.
*/
class SoundEffect final : public Resource
{
public:
A_DELETE_COPY(SoundEffect)
/**
* Destructor.
*/
virtual ~SoundEffect();
/**
* Loads a sample from a buffer in memory.
*
* @param rw The SDL_RWops to load the sample data from.
*
* @return <code>NULL</code> if the an error occurred, a valid pointer
* otherwise.
*/
static Resource *load(SDL_RWops *const rw);
/**
* Plays the sample.
*
* @param loops Number of times to repeat the playback.
* @param volume Sample playback volume.
* @param channel Sample playback channel.
*
* @return <code>true</code> if the playback started properly
* <code>false</code> otherwise.
*/
bool play(const int loops, const int volume,
const int channel = -1) const;
protected:
/**
* Constructor.
*/
explicit SoundEffect(Mix_Chunk *const soundEffect) :
Resource(),
mChunk(soundEffect)
{ }
Mix_Chunk *mChunk;
};
#endif // SOUND_EFFECT_H
|
