Public Member Functions | Protected Attributes | Private Member Functions

Mixer Class Reference

Mixer base class. More...

#include <Mixer.h>

Inheritance diagram for Mixer:
SDL_Mixer

List of all members.

Public Member Functions

 Mixer (const std::string &mixerName)
 Mixer ()
virtual ~Mixer ()
virtual void playSound (Sound *mSound)
virtual void stopSound ()
virtual void pauseSound ()
virtual void fadeIn (int delayTime)
virtual void fadeOut (int delayTime)
virtual void playMusic (Music *music)
virtual void stopMusic ()
virtual void pauseMusic ()
virtual void fadeInMusic ()
virtual void fadeOutMusic ()
virtual void stopAllAudio ()
const std::string & getLastErrorMessage ()
virtual bool loadMusic (Music *music)
virtual bool loadSound (Sound *mSound)

Protected Attributes

std::string mMixerName
std::string mErrorMessage

Private Member Functions

 Mixer (const Mixer &)
Mixer & operator= (const Mixer &)

Detailed Description

Mixer base class.

Provides a standard Mixer interface. This Mixer can be used but will do nothing -- e.g., a NULL renderer.

Constructor & Destructor Documentation

Mixer::Mixer ( const std::string &  mixerName  )  [inline]
Mixer::Mixer (  )  [inline]
virtual Mixer::~Mixer (  )  [inline, virtual]
Mixer::Mixer ( const Mixer &   )  [private]

Member Function Documentation

virtual void Mixer::fadeIn ( int  delayTime  )  [inline, virtual]

Fades the sound in from 0 volume.

Parameters:
delayTime Number of seconds the fade should last.
virtual void Mixer::fadeInMusic (  )  [inline, virtual]
virtual void Mixer::fadeOut ( int  delayTime  )  [inline, virtual]

Fades the sound to 0 volume.

Parameters:
delayTime Number of seconds the fade should last.
virtual void Mixer::fadeOutMusic (  )  [inline, virtual]
const std::string& Mixer::getLastErrorMessage (  )  [inline]

Gets a description of the last error message, if any.

virtual bool Mixer::loadMusic ( Music *  music  )  [inline, virtual]
virtual bool Mixer::loadSound ( Sound *  mSound  )  [inline, virtual]
Mixer& Mixer::operator= ( const Mixer &   )  [private]
virtual void Mixer::pauseMusic (  )  [inline, virtual]

Reimplemented in SDL_Mixer.

virtual void Mixer::pauseSound (  )  [inline, virtual]

Reimplemented in SDL_Mixer.

virtual void Mixer::playMusic ( Music *  music  )  [inline, virtual]

Reimplemented in SDL_Mixer.

virtual void Mixer::playSound ( Sound *  mSound  )  [inline, virtual]

Reimplemented in SDL_Mixer.

virtual void Mixer::stopAllAudio (  )  [inline, virtual]

Stops all audio globally (including all sound channels and music)

Reimplemented in SDL_Mixer.

virtual void Mixer::stopMusic (  )  [inline, virtual]

Reimplemented in SDL_Mixer.

virtual void Mixer::stopSound (  )  [inline, virtual]

Reimplemented in SDL_Mixer.

Member Data Documentation

std::string Mixer::mErrorMessage [protected]

String describing the last error that occured

std::string Mixer::mMixerName [protected]

Internal name of the Renderer.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Sep 2 2010 23:48:06 for The Legend of Mazzeroth by  doxygen 1.7.1