SDLMusic Class Reference

#include <sdlmusic.h>

Inheritance diagram for SDLMusic:

Public Member Functions
	SDLMusic ()
	SDLMusic (Mix_Music *const music, SDL_RWops *const rw, const std::string &name)
	~SDLMusic ()
bool	play (const int loops, const int fadeIn) const
int	calcMemoryLocal () const
std::string	getCounterName () const
Public Member Functions inherited from Resource
	Resource ()
	~Resource ()
virtual void	incRef ()
virtual void	decRef ()
Public Member Functions inherited from MemoryCounter
	MemoryCounter ()
virtual	~MemoryCounter ()
int	calcMemory (const int level) const
virtual int	calcMemoryChilds (const int level) const

Protected Attributes
std::string	mName
Mix_Music *	mMusic
SDL_RWops *	mRw

Additional Inherited Members
Data Fields inherited from Resource
time_t	mTimeStamp
std::string	mIdPath
std::string	mSource
unsigned int	mRefCount
bool	mProtected
bool	mNotCount

Detailed Description

Defines a class for loading and storing music.

Definition at line 39 of file sdlmusic.h.

Constructor & Destructor Documentation

SDLMusic() [1/2]

SDLMusic::SDLMusic ( )

inline

Definition at line 42 of file sdlmusic.h.

                   :
            Resource(),
            mName(),
            mMusic(nullptr),
            mRw(nullptr)
        { }

Referenced by calcMemoryLocal().

SDLMusic() [2/2]

SDLMusic::SDLMusic	(	Mix_Music *const	music,
		SDL_RWops *const	rw,
		const std::string &	name
	)

Definition at line 40 of file sdlmusic.cpp.

                                          :
    Resource(),
    mName(name),
    mMusic(music),
    mRw(rw)
{
}

~SDLMusic()

SDLMusic::~SDLMusic

(

)

Destructor.

Definition at line 50 of file sdlmusic.cpp.

{
    Mix_FreeMusic(mMusic);
#ifndef USE_SDL2
#if SDL_MIXER_VERSION_ATLEAST(1, 2, 12)
    if (mRw != nullptr)
    {
        SDL_RWclose(mRw);
        mRw = nullptr;
    }
#endif  // SDL_MIXER_VERSION_ATLEAST(1, 2, 12)
#endif  // USE_SDL2
}

References mMusic, and mRw.

Member Function Documentation

calcMemoryLocal()

int SDLMusic::calcMemoryLocal ( ) const

virtual

Reimplemented from Resource.

Definition at line 72 of file sdlmusic.cpp.

{
    // +++ not used size of SDL_RWops
    return static_cast<int>(sizeof(SDLMusic)) +
        Resource::calcMemoryLocal();
}

References Resource::calcMemoryLocal(), and SDLMusic().

getCounterName()

std::string SDLMusic::getCounterName ( ) const

inlinevirtual

Reimplemented from Resource.

Definition at line 75 of file sdlmusic.h.

        { return mName; }

References mName.

play()

bool SDLMusic::play	(	const int	loops,
		const int	fadeIn
	)		const

Plays the music.

Parameters

loops	Number of times to repeat the playback (-1 means forever).
fadeIn	Duration in milliseconds to fade in the music.

Returns

true if the playback started properly false otherwise.

Definition at line 64 of file sdlmusic.cpp.

{
    if (fadeIn > 0)
        return Mix_FadeInMusicPos(mMusic, loops, fadeIn, 0.0) != 0;
    return Mix_FadeInMusicPos(mMusic, loops, 0, 0.0) != 0;
}

References mMusic.

Referenced by SoundManager::playMusic().

Field Documentation

mMusic

Mix_Music* SDLMusic::mMusic

protected

Definition at line 80 of file sdlmusic.h.

Referenced by play(), and ~SDLMusic().

mName

std::string SDLMusic::mName

protected

Definition at line 79 of file sdlmusic.h.

Referenced by getCounterName().

mRw

SDL_RWops* SDLMusic::mRw

protected

Definition at line 81 of file sdlmusic.h.

Referenced by ~SDLMusic().

---

The documentation for this class was generated from the following files:

• src/resources/sdlmusic.h (986a3bf)
• src/resources/sdlmusic.cpp (986a3bf)