driver.h File Reference

Base for all drivers (video, sound, music, etc). More...

#include "core/enum_type.hpp"
#include "string_type.h"

Go to the source code of this file.

Data Structures
class	Driver
	A driver for communicating with the user. More...
class	DriverFactoryBase
	Base for all driver factories. More...

Functions
const char *	GetDriverParam (const StringList &parm, const char *name)
	Get a string parameter the list of parameters.
bool	GetDriverParamBool (const StringList &parm, const char *name)
	Get a boolean parameter the list of parameters.
int	GetDriverParamInt (const StringList &parm, const char *name, int def)
	Get an integer parameter the list of parameters.

Detailed Description

Base for all drivers (video, sound, music, etc).

Definition in file driver.h.

Function Documentation

GetDriverParam()

const char * GetDriverParam	(	const StringList &	parm,
		const char *	name
	)

Get a string parameter the list of parameters.

Parameters

parm	The parameters.
name	The parameter name we're looking for.

Returns

The parameter value.

Definition at line 44 of file driver.cpp.

Referenced by GetDriverParamBool(), GetDriverParamInt(), MusicDriver_DMusic::Start(), MusicDriver_ExtMidi::Start(), MusicDriver_FluidSynth::Start(), and MusicDriver_Win32::Start().

GetDriverParamBool()

bool GetDriverParamBool	(	const StringList &	parm,
		const char *	name
	)

Get a boolean parameter the list of parameters.

Parameters

parm	The parameters.
name	The parameter name we're looking for.

Returns

The parameter value.

Definition at line 64 of file driver.cpp.

References GetDriverParam().

Referenced by VideoDriver_SDL_Base::Start(), VideoDriver_SDL::Start(), and VideoDriver_Win32GDI::Start().

GetDriverParamInt()

int GetDriverParamInt	(	const StringList &	parm,
		const char *	name,
		int	def
	)

Get an integer parameter the list of parameters.

Parameters

parm	The parameters.
name	The parameter name we're looking for.
def	The default value if the parameter doesn't exist.

Returns

The parameter value.

Definition at line 76 of file driver.cpp.

References GetDriverParam().

Referenced by MusicDriver_DMusic::Start(), MusicDriver_Win32::Start(), SoundDriver_SDL::Start(), SoundDriver_Win32::Start(), SoundDriver_XAudio2::Start(), VideoDriver_Null::Start(), VideoDriver_SDL_Base::Start(), and VideoDriver_SDL::Start().