GameEngine::IMusic< MusicType > Class Template Reference

interface for music handling More...

#include <RenderInterfaces.hpp>

Public Member Functions
	~IMusic ()=default
	destructor More...
virtual const MusicType &	getMusic () const =0
	Get the wrapped music instance. More...
virtual void	load (const std::string &filename)=0
	Load music from a file. More...
virtual void	play ()=0
	play the loaded music More...

Detailed Description

template<typename MusicType>
class GameEngine::IMusic< MusicType >

interface for music handling

Template Parameters

MusicType

type of the music

Constructor & Destructor Documentation

~IMusic()

template<typename MusicType >

GameEngine::IMusic< MusicType >::~IMusic ( )

default

destructor

Member Function Documentation

getMusic()

template<typename MusicType >

virtual const MusicType& GameEngine::IMusic< MusicType >::getMusic ( ) const

pure virtual

Get the wrapped music instance.

Returns

Reference to the music instance

Implemented in GameEngine::Music.

load()

template<typename MusicType >

virtual void GameEngine::IMusic< MusicType >::load ( const std::string &  filename )

pure virtual

Load music from a file.

Parameters

filename

The path to the music file

Implemented in GameEngine::Music.

play()

template<typename MusicType >

virtual void GameEngine::IMusic< MusicType >::play ( )

pure virtual

play the loaded music

Implemented in GameEngine::Music.

---

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

• GameEngine/include/utils/RenderInterfaces.hpp