nel/src/sound/driver/openal/effect_al.h

   1 // NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef NLSOUND_EFFECT_AL_H
  18 #define NLSOUND_EFFECT_AL_H
  19
  20 namespace NLSOUND {
  21         class CSoundDriverAL;
  22
  23 /**
  24  * \brief CEffectAL
  25  * \date 2008-09-25 08:21GMT
  26  * \author Jan Boon (Kaetemi)
  27  * CEffectAL
  28  */
  29 class CEffectAL
  30 {
  31 protected:
  32         // outside pointers
  33         CSoundDriverAL *_SoundDriver;
  34
  35         // instances
  36         ALuint _AlEffect;
  37         ALuint _AlAuxEffectSlot;
  38
  39 public:
  40         CEffectAL(CSoundDriverAL *soundDriver, ALuint alEffect, ALuint alAuxEffectSlot);
  41         virtual ~CEffectAL();
  42         virtual void release();
  43
  44         inline ALuint getAlEffect() { return _AlEffect; }
  45         inline ALuint getAuxEffectSlot() { return _AlAuxEffectSlot; }
  46
  47 }; /* class CEffectAL */
  48
  49 /**
  50  * \brief CStandardReverbEffectAL
  51  * \date 2008-09-15 23:09GMT
  52  * \author Jan Boon (Kaetemi)
  53  * CStandardReverbEffectAL
  54  */
  55 class CStandardReverbEffectAL : public IReverbEffect, public CEffectAL
  56 {
  57 public:
  58         CStandardReverbEffectAL(CSoundDriverAL *soundDriver, ALuint alEffect, ALuint alAuxEffectSlot);
  59         virtual ~CStandardReverbEffectAL();
  60
  61         virtual void setEnvironment(const CEnvironment &environment = CEnvironment(), float roomSize = 100.0f);
  62
  63 }; /* class CReverbEffectAL */
  64
  65 #if EFX_CREATIVE_AVAILABLE
  66
  67 /**
  68  * \brief CCreativeReverbEffectAL
  69  * \date 2008-09-15 23:09GMT
  70  * \author Jan Boon (Kaetemi)
  71  * CCreativeReverbEffectAL
  72  */
  73 class CCreativeReverbEffectAL : public IReverbEffect, public CEffectAL
  74 {
  75 public:
  76         CCreativeReverbEffectAL(CSoundDriverAL *soundDriver, ALuint alEffect, ALuint alAuxEffectSlot);
  77         virtual ~CCreativeReverbEffectAL();
  78
  79         virtual void setEnvironment(const CEnvironment &environment = CEnvironment(), float roomSize = 100.0f);
  80
  81 }; /* class CReverbEffectAL */
  82
  83 #endif /* #if EFX_CREATIVE_AVAILABLE */
  84
  85 } /* namespace NLSOUND */
  86
  87 #endif /* #ifndef NLSOUND_EFFECT_AL_H */
  88
  89 /* end of file */