olc::SOUND Class Reference

#include <olcPGEX_Sound.h>

Inheritance diagram for olc::SOUND:

Classes
class	AudioSample
struct	sCurrentlyPlayingSample

Static Public Member Functions
static bool	InitialiseAudio (unsigned int nSampleRate=44100, unsigned int nChannels=1, unsigned int nBlocks=8, unsigned int nBlockSamples=512)
static bool	DestroyAudio ()
static void	SetUserSynthFunction (std::function< float(int, float, float)> func)
static void	SetUserFilterFunction (std::function< float(int, float, float)> func)
static int	LoadAudioSample (std::string sWavFile, olc::ResourcePack *pack=nullptr)
static void	PlaySample (int id, bool bLoop=false)
static void	StopSample (int id)
static void	StopAll ()
static float	GetMixerOutput (int nChannel, float fGlobalTime, float fTimeStep)

Static Public Attributes
static std::list< sCurrentlyPlayingSample >	listActiveSamples

Additional Inherited Members
Public Member Functions inherited from olc::PGEX
	PGEX (bool bHook=false)
Protected Member Functions inherited from olc::PGEX
virtual void	OnBeforeUserCreate ()
virtual void	OnAfterUserCreate ()
virtual bool	OnBeforeUserUpdate (float &fElapsedTime)
virtual void	OnAfterUserUpdate (float fElapsedTime)
Static Protected Attributes inherited from olc::PGEX
static PixelGameEngine *	pge

Member Function Documentation

DestroyAudio()

static bool olc::SOUND::DestroyAudio ( )

static

GetMixerOutput()

static float olc::SOUND::GetMixerOutput ( int nChannel, float fGlobalTime, float fTimeStep )

static

InitialiseAudio()

static bool olc::SOUND::InitialiseAudio ( unsigned int nSampleRate = 44100, unsigned int nChannels = 1, unsigned int nBlocks = 8, unsigned int nBlockSamples = 512 )

static

LoadAudioSample()

static int olc::SOUND::LoadAudioSample ( std::string sWavFile, olc::ResourcePack * pack = nullptr )

static

PlaySample()

static void olc::SOUND::PlaySample ( int id, bool bLoop = false )

static

SetUserFilterFunction()

static void olc::SOUND::SetUserFilterFunction ( std::function< float(int, float, float)> func )

static

SetUserSynthFunction()

static void olc::SOUND::SetUserSynthFunction ( std::function< float(int, float, float)> func )

static

StopAll()

static void olc::SOUND::StopAll ( )

static

StopSample()

static void olc::SOUND::StopSample ( int id )

static

Member Data Documentation

listActiveSamples

std::list<sCurrentlyPlayingSample> olc::SOUND::listActiveSamples

static

---

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

• extensions/olcPGEX_Sound.h