pge_audio::PgeAudio Class Reference

Detailed Description

Definition at line 32 of file PgeAudio.h.

#include <PgeAudio.h>

Public Member Functions
CConsole &	getConsole () const
	PgeAudio (PGEcfgProfiles &cfgProfiles)
	PgeAudio (const PgeAudio &)=delete
PgeAudio &	operator= (const PgeAudio &)=delete
	PgeAudio (PgeAudio &&)=delete
PgeAudio &&	operator= (PgeAudio &&)=delete
bool	initialize ()
	Initialize the audio subsystem.
bool	shutdown ()
	Stops the audio subsystem.
bool	isInitialized () const
	Gets the state of the audio subsystem.
SoLoud::Soloud &	getAudioEngineCore ()
void	loadSound (SoLoud::Wav &snd, const std::string &sFname)
SoLoud::handle	playSound (SoLoud::Wav &snd)
SoLoud::handle	play3dSound (SoLoud::Wav &snd, const float &posX, const float &posY, const float &posZ)
SoLoud::handle	play3dSound (SoLoud::Wav &snd, const PureVector &pos)
SoLoud::handle	play3dSound (SoLoud::Wav &snd, const TXYZ &pos)
void	stopSoundInstance (const SoLoud::handle &sndHandle)

Static Public Member Functions
static const char *	getLoggerModuleName ()

Static Public Attributes
static constexpr char *	CVAR_SFX_ENABLED = "sfx_enabled"

Private Attributes
PGEcfgProfiles &	m_cfgProfiles
bool	m_bInitialized = false
SoLoud::Soloud	m_SoLoudCore

Constructor & Destructor Documentation

PgeAudio() [1/3]

pge_audio::PgeAudio::PgeAudio

(

PGEcfgProfiles &

cfgProfiles

)

Definition at line 28 of file PgeAudio.cpp.

PgeAudio() [2/3]

pge_audio::PgeAudio::PgeAudio ( const PgeAudio & )

delete

PgeAudio() [3/3]

pge_audio::PgeAudio::PgeAudio ( PgeAudio && )

delete

Member Function Documentation

getAudioEngineCore()

SoLoud::Soloud & pge_audio::PgeAudio::getAudioEngineCore

(

)

Definition at line 125 of file PgeAudio.cpp.

getConsole()

CConsole & pge_audio::PgeAudio::getConsole

(

)

const

Definition at line 23 of file PgeAudio.cpp.

getLoggerModuleName()

const char * pge_audio::PgeAudio::getLoggerModuleName ( )

static

Definition at line 18 of file PgeAudio.cpp.

initialize()

bool pge_audio::PgeAudio::initialize

(

)

Initialize the audio subsystem.

Returns

The result of the initialization. True on success, false otherwise.

Definition at line 39 of file PgeAudio.cpp.

isInitialized()

bool pge_audio::PgeAudio::isInitialized

(

)

const

Gets the state of the audio subsystem.

Returns

True if the audio subsystem is successfully initialized, false before initialization or after shutdown.

Definition at line 120 of file PgeAudio.cpp.

loadSound()

void pge_audio::PgeAudio::loadSound	(	SoLoud::Wav &	snd,
		const std::string &	sFname )

Definition at line 130 of file PgeAudio.cpp.

operator=() [1/2]

PgeAudio & pge_audio::PgeAudio::operator= ( const PgeAudio & )

delete

operator=() [2/2]

PgeAudio && pge_audio::PgeAudio::operator= ( PgeAudio && )

delete

play3dSound() [1/3]

SoLoud::handle pge_audio::PgeAudio::play3dSound	(	SoLoud::Wav &	snd,
		const float &	posX,
		const float &	posY,
		const float &	posZ )

Definition at line 188 of file PgeAudio.cpp.

play3dSound() [2/3]

SoLoud::handle pge_audio::PgeAudio::play3dSound	(	SoLoud::Wav &	snd,
		const PureVector &	pos )

Definition at line 217 of file PgeAudio.cpp.

play3dSound() [3/3]

SoLoud::handle pge_audio::PgeAudio::play3dSound	(	SoLoud::Wav &	snd,
		const TXYZ &	pos )

Definition at line 222 of file PgeAudio.cpp.

playSound()

SoLoud::handle pge_audio::PgeAudio::playSound

(

SoLoud::Wav &

snd

)

Definition at line 169 of file PgeAudio.cpp.

shutdown()

bool pge_audio::PgeAudio::shutdown

(

)

Stops the audio subsystem.

No effect before initialization. After shutdown, initialize() can be called again.

Returns

True on successful shutdown, false otherwise.

Definition at line 100 of file PgeAudio.cpp.

stopSoundInstance()

void pge_audio::PgeAudio::stopSoundInstance

(

const SoLoud::handle &

sndHandle

)

Definition at line 227 of file PgeAudio.cpp.

Member Data Documentation

CVAR_SFX_ENABLED

char* pge_audio::PgeAudio::CVAR_SFX_ENABLED = "sfx_enabled"

staticconstexpr

Definition at line 36 of file PgeAudio.h.

m_bInitialized

bool pge_audio::PgeAudio::m_bInitialized = false

private

Definition at line 75 of file PgeAudio.h.

m_cfgProfiles

PGEcfgProfiles& pge_audio::PgeAudio::m_cfgProfiles

private

Definition at line 73 of file PgeAudio.h.

m_SoLoudCore

SoLoud::Soloud pge_audio::PgeAudio::m_SoLoudCore

private

Definition at line 76 of file PgeAudio.h.

---

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

• C:/__PR00F__/___developing___/projects/PGE/PGE/Audio/PgeAudio.h
• C:/__PR00F__/___developing___/projects/PGE/PGE/Audio/PgeAudio.cpp