Serious Sam's Bogus Detour  2016/06/09
Engine documentation
Classes
Sound

Classes

class  SoundInstance
 An instance of a sound. A played sound can be located in the world, and controlled via this class. More...
 
class  SoundEvent
 A sound resource. This can play sounds in 2D and 3D. Creates SoundInstance objects. More...
 

Detailed Description


Class Documentation

class SoundInstance

An instance of a sound. A played sound can be located in the world, and controlled via this class.

Public Member Functions

void SetPosition (vec3 pos)
 
int32 GetLength ()
 
void Stop ()
 
bool IsPlaying ()
 
void SetPaused (bool paused)
 
bool IsPaused ()
 
void SetLooped (bool looped)
 
bool IsLooped ()
 
void SetVolume (float volume)
 
float GetVolume ()
 
void SetParameter (string name, float value)
 

Member Function Documentation

int32 SoundInstance::GetLength ( )
float SoundInstance::GetVolume ( )
bool SoundInstance::IsLooped ( )
bool SoundInstance::IsPaused ( )
bool SoundInstance::IsPlaying ( )
void SoundInstance::SetLooped ( bool  looped)
void SoundInstance::SetParameter ( string  name,
float  value 
)
void SoundInstance::SetPaused ( bool  paused)
void SoundInstance::SetPosition ( vec3  pos)
void SoundInstance::SetVolume ( float  volume)
void SoundInstance::Stop ( )
class SoundEvent

A sound resource. This can play sounds in 2D and 3D. Creates SoundInstance objects.

Public Member Functions

void Play ()
 
void Play (vec3 pos)
 
SoundInstancePlayTracked ()
 
SoundInstancePlayTracked (vec3 pos)
 
string GetName ()
 

Member Function Documentation

string SoundEvent::GetName ( )
void SoundEvent::Play ( )
void SoundEvent::Play ( vec3  pos)
SoundInstance* SoundEvent::PlayTracked ( )
SoundInstance* SoundEvent::PlayTracked ( vec3  pos)