GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/resources/soundeffect.h Lines: 0 6 0.0 %
Date: 2017-11-29 Branches: 0 0 0.0 %

Line Branch Exec Source
1
/*
2
 *  The ManaPlus Client
3
 *  Copyright (C) 2004-2009  The Mana World Development Team
4
 *  Copyright (C) 2009-2010  The Mana Developers
5
 *  Copyright (C) 2011-2017  The ManaPlus Developers
6
 *
7
 *  This file is part of The ManaPlus Client.
8
 *
9
 *  This program is free software; you can redistribute it and/or modify
10
 *  it under the terms of the GNU General Public License as published by
11
 *  the Free Software Foundation; either version 2 of the License, or
12
 *  any later version.
13
 *
14
 *  This program is distributed in the hope that it will be useful,
15
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 *  GNU General Public License for more details.
18
 *
19
 *  You should have received a copy of the GNU General Public License
20
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
 */
22
23
#ifndef RESOURCES_SOUNDEFFECT_H
24
#define RESOURCES_SOUNDEFFECT_H
25
26
#include "resources/resource.h"
27
28
PRAGMA48(GCC diagnostic push)
29
PRAGMA48(GCC diagnostic ignored "-Wshadow")
30
#include <SDL_mixer.h>
31
PRAGMA48(GCC diagnostic pop)
32
33
#include "localconsts.h"
34
35
/**
36
 * Defines a class for loading and storing sound effects.
37
 */
38
class SoundEffect final : public Resource
39
{
40
    public:
41
        /**
42
         * Constructor.
43
         */
44
        SoundEffect(Mix_Chunk *const soundEffect,
45
                    const std::string &name) :
46
            Resource(),
47
            mName(name),
48
            mChunk(soundEffect)
49
        { }
50
51
        A_DELETE_COPY(SoundEffect)
52
53
        /**
54
         * Destructor.
55
         */
56
        ~SoundEffect();
57
58
        /**
59
         * Plays the sample.
60
         *
61
         * @param loops     Number of times to repeat the playback.
62
         * @param volume    Sample playback volume.
63
         * @param channel   Sample playback channel.
64
         *
65
         * @return <code>true</code> if the playback started properly
66
         *         <code>false</code> otherwise.
67
         */
68
        bool play(const int loops, const int volume,
69
                  const int channel = -1) const;
70
71
        int calcMemoryLocal() const override final;
72
73
        std::string getCounterName() const override final
74
        { return mName; }
75
76
    protected:
77
        std::string mName;
78
        Mix_Chunk *mChunk;
79
};
80
81
#endif  // RESOURCES_SOUNDEFFECT_H