Kochol Game Engine  0.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | Private Attributes | List of all members
kge::av::SoundSystem Class Reference

#include <soundsystem.h>

Public Member Functions

 SoundSystem (SoundSystemType type, float musicVolume, float effectsVolume)
 constructor
virtual ~SoundSystem ()
virtual bool Init (void *hwnd)=0
virtual sn::Sound3D * CreateSound3D (const char *filename)=0
 creates a 3D sound and returns a pointer to it
virtual sn::Sound2D * CreateSound2D (const char *filename, bool streaming)=0
 creates a 2D sound and return a pointer to it
virtual void SetListenerPosition (const math::Vector &pos)=0
virtual void SetListenerVelocity (const math::Vector &vel)=0
virtual void SetListenerOrientation (const math::Vector &forward, const math::Vector &up)=0
virtual void Update ()=0
 update sound system
virtual void SetMusicVolume (float volume)=0
 volume: [0-1000]
float GetMusicVolume () const
virtual void SetEffectsVolume (float volume)=0
 volume: [0-1000]
float GetEffectsVolume () const
virtual void Pause (bool pause)=0
virtual void Stop ()=0
SoundSystemType GetType () const
 returns type of the sound system

Protected Attributes

float m_musicVolume
float m_effectsVolume

Private Attributes

SoundSystemType m_eType

Detailed Description

Definition at line 29 of file soundsystem.h.

Constructor & Destructor Documentation

kge::av::SoundSystem::SoundSystem ( SoundSystemType  type,
float  musicVolume,
float  effectsVolume 
)
inline

constructor

Definition at line 33 of file soundsystem.h.

virtual kge::av::SoundSystem::~SoundSystem ( )
inlinevirtual

Definition at line 36 of file soundsystem.h.

Member Function Documentation

virtual sn::Sound2D* kge::av::SoundSystem::CreateSound2D ( const char *  filename,
bool  streaming 
)
pure virtual

creates a 2D sound and return a pointer to it

virtual sn::Sound3D* kge::av::SoundSystem::CreateSound3D ( const char *  filename)
pure virtual

creates a 3D sound and returns a pointer to it

float kge::av::SoundSystem::GetEffectsVolume ( ) const
inline

Definition at line 68 of file soundsystem.h.

References m_effectsVolume.

float kge::av::SoundSystem::GetMusicVolume ( ) const
inline

Definition at line 62 of file soundsystem.h.

References m_musicVolume.

SoundSystemType kge::av::SoundSystem::GetType ( ) const
inline

returns type of the sound system

Definition at line 77 of file soundsystem.h.

References m_eType.

virtual bool kge::av::SoundSystem::Init ( void *  hwnd)
pure virtual
virtual void kge::av::SoundSystem::Pause ( bool  pause)
pure virtual
virtual void kge::av::SoundSystem::SetEffectsVolume ( float  volume)
pure virtual

volume: [0-1000]

virtual void kge::av::SoundSystem::SetListenerOrientation ( const math::Vector &  forward,
const math::Vector &  up 
)
pure virtual
virtual void kge::av::SoundSystem::SetListenerPosition ( const math::Vector &  pos)
pure virtual
virtual void kge::av::SoundSystem::SetListenerVelocity ( const math::Vector &  vel)
pure virtual
virtual void kge::av::SoundSystem::SetMusicVolume ( float  volume)
pure virtual

volume: [0-1000]

virtual void kge::av::SoundSystem::Stop ( )
pure virtual
virtual void kge::av::SoundSystem::Update ( )
pure virtual

update sound system

Member Data Documentation

float kge::av::SoundSystem::m_effectsVolume
protected

Definition at line 81 of file soundsystem.h.

Referenced by GetEffectsVolume().

SoundSystemType kge::av::SoundSystem::m_eType
private

Definition at line 84 of file soundsystem.h.

Referenced by GetType().

float kge::av::SoundSystem::m_musicVolume
protected

Definition at line 80 of file soundsystem.h.

Referenced by GetMusicVolume().

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