stmg::GameSound Class Reference

Inheritance diagram for stmg::GameSound:

Public Member Functions
virtual bool	isFinished () noexcept=0
	Tells whether the sound has finished. More...
virtual void	pause () noexcept=0
	Pause the sound. More...
virtual void	resume () noexcept=0
	Resume the sound. More...
virtual void	setPos (FPoint oXYPos, double fZ) noexcept=0
	Change sound position. More...
virtual void	setVolume (double fVolume01) noexcept=0
	Set the volume. More...
virtual	~GameSound () noexcept=default

Constructor & Destructor Documentation

~GameSound()

virtual stmg::GameSound::~GameSound ( )

virtualdefaultnoexcept

Member Function Documentation

isFinished()

virtual bool stmg::GameSound::isFinished ( )

pure virtualnoexcept

Tells whether the sound has finished.

When all the associated devices are removed this also returns true.

Returns

Whether sound no longer playing.

pause()

virtual void stmg::GameSound::pause ( )

pure virtualnoexcept

Pause the sound.

resume()

virtual void stmg::GameSound::resume ( )

pure virtualnoexcept

Resume the sound.

setPos()

virtual void stmg::GameSound::setPos ( FPoint  oXYPos, double  fZ  )

pure virtualnoexcept

Change sound position.

Parameters

oXYPos	The new x,y position.
fZ	The z position

setVolume()

virtual void stmg::GameSound::setVolume ( double  fVolume01 )

pure virtualnoexcept

Set the volume.

Parameters

fVolume01

The volume. Value 0 is inaudible, 1 is maximum volume.