FIFE::EngineSettings Class Reference

#include <enginesettings.h>

List of all members.

Public Member Functions

 EngineSettings ()
 ~EngineSettings ()
void validate () const
void setBitsPerPixel (unsigned int bitsperpixel)
unsigned int getBitsPerPixel () const
std::vector< unsigned int > getPossibleBitsPerPixel () const
std::vector< std::pair
< unsigned int, unsigned int > > 
getPossibleResolutions () const
void setFullScreen (bool fullscreen)
bool isFullScreen () const
void setInitialVolume (float volume)
float getInitialVolume () const
float getMaxVolume () const
void setRenderBackend (const std::string &renderbackend)
const std::string getRenderBackend () const
std::vector< std::string > getPossibleRenderBackends ()
void setSDLRemoveFakeAlpha (bool sldremovefakealpha)
bool isSDLRemoveFakeAlpha (bool sldremovefakealpha) const
void setScreenWidth (unsigned int screenwidth)
unsigned int getScreenWidth () const
void setScreenHeight (unsigned int screenheight)
unsigned int getScreenHeight () const
void setDefaultFontPath (const std::string &defaultfontpath)
std::string getDefaultFontPath () const
void setDefaultFontSize (const unsigned int defaultfontsize)
unsigned int getDefaultFontSize () const
void setDefaultFontGlyphs (const std::string &defaultfontglyphs)
std::string getDefaultFontGlyphs () const
void setImageChunkingSize (unsigned int size)
unsigned int getImageChunkingSize () const
void setWindowTitle (const std::string &title)
std::string getWindowTitle () const
void setWindowIcon (const std::string &icon)
std::string getWindowIcon () const
void setColorKeyEnabled (bool colorkeyenable)
bool isColorKeyEnabled () const
void setColorKey (Uint8 r, Uint8 g, Uint8 b)
const SDL_Color & getColorKey () const

Detailed Description

This class defines the engine settings on engine init

Definition at line 42 of file enginesettings.h.


Constructor & Destructor Documentation

FIFE::EngineSettings::EngineSettings (  ) 

Constructor

Definition at line 40 of file enginesettings.cpp.

FIFE::EngineSettings::~EngineSettings (  ) 

Destructor

Definition at line 60 of file enginesettings.cpp.


Member Function Documentation

unsigned int FIFE::EngineSettings::getBitsPerPixel (  )  const [inline]

Gets currently set bits per pixel value

Definition at line 63 of file enginesettings.h.

const SDL_Color & FIFE::EngineSettings::getColorKey (  )  const

Gets the global colorkey setting

Definition at line 181 of file enginesettings.cpp.

std::string FIFE::EngineSettings::getDefaultFontGlyphs (  )  const [inline]

Gets current glyphs for default font

Definition at line 173 of file enginesettings.h.

std::string FIFE::EngineSettings::getDefaultFontPath (  )  const [inline]

Sets current path for default font

Definition at line 153 of file enginesettings.h.

unsigned int FIFE::EngineSettings::getDefaultFontSize (  )  const [inline]

Gets size for default font

Definition at line 163 of file enginesettings.h.

unsigned int FIFE::EngineSettings::getImageChunkingSize (  )  const [inline]
See also:
setImageChunkingSize

Definition at line 185 of file enginesettings.h.

float FIFE::EngineSettings::getInitialVolume (  )  const [inline]

Gets initial engine sound volume

Definition at line 94 of file enginesettings.h.

float FIFE::EngineSettings::getMaxVolume (  )  const

Gets maximum volume that can be set

Definition at line 114 of file enginesettings.cpp.

Referenced by setInitialVolume().

Here is the caller graph for this function:

std::vector< unsigned int > FIFE::EngineSettings::getPossibleBitsPerPixel (  )  const

Gets all possible bits per pixel values

Definition at line 95 of file enginesettings.cpp.

Referenced by setBitsPerPixel().

Here is the caller graph for this function:

std::vector< std::string > FIFE::EngineSettings::getPossibleRenderBackends (  ) 

Gets all possible renderbackend names

Definition at line 128 of file enginesettings.cpp.

Referenced by setRenderBackend().

Here is the caller graph for this function:

std::vector< std::pair< unsigned int, unsigned int > > FIFE::EngineSettings::getPossibleResolutions (  )  const

Gets all possible screen resolutions

Definition at line 73 of file enginesettings.cpp.

References getRenderBackend(), and isFullScreen().

const std::string FIFE::EngineSettings::getRenderBackend (  )  const [inline]

Gets currently set renderbackend name

Definition at line 109 of file enginesettings.h.

Referenced by getPossibleResolutions().

Here is the caller graph for this function:

unsigned int FIFE::EngineSettings::getScreenHeight (  )  const [inline]

Gets screen height (pixels)

Definition at line 143 of file enginesettings.h.

unsigned int FIFE::EngineSettings::getScreenWidth (  )  const [inline]

Gets screen width (pixels)

Definition at line 133 of file enginesettings.h.

std::string FIFE::EngineSettings::getWindowIcon (  )  const [inline]

Gets the icon in the window title bar

Definition at line 205 of file enginesettings.h.

std::string FIFE::EngineSettings::getWindowTitle (  )  const [inline]

Gets the current window title

Definition at line 195 of file enginesettings.h.

bool FIFE::EngineSettings::isColorKeyEnabled (  )  const

Gets whether the colorkey feature is in use

Definition at line 171 of file enginesettings.cpp.

bool FIFE::EngineSettings::isFullScreen (  )  const [inline]

True, if set to fullscreen. False = windowed

Definition at line 83 of file enginesettings.h.

Referenced by getPossibleResolutions().

Here is the caller graph for this function:

bool FIFE::EngineSettings::isSDLRemoveFakeAlpha ( bool  sldremovefakealpha  )  const [inline]

Tells if fake alpha is removed in SDL renderbackend

Definition at line 123 of file enginesettings.h.

void FIFE::EngineSettings::setBitsPerPixel ( unsigned int  bitsperpixel  ) 

Sets bits per pixel

See also:
getPossibleBitsPerPixel

Definition at line 85 of file enginesettings.cpp.

References getPossibleBitsPerPixel().

void FIFE::EngineSettings::setColorKey ( Uint8  r,
Uint8  g,
Uint8  b 
)

Sets the global colorkey to use for images

Definition at line 175 of file enginesettings.cpp.

void FIFE::EngineSettings::setColorKeyEnabled ( bool  colorkeyenable  ) 

Sets whether to use the colorkey feature

Definition at line 167 of file enginesettings.cpp.

void FIFE::EngineSettings::setDefaultFontGlyphs ( const std::string &  defaultfontglyphs  ) 

Sets glyphs for default font

Definition at line 155 of file enginesettings.cpp.

void FIFE::EngineSettings::setDefaultFontPath ( const std::string &  defaultfontpath  ) 

Sets path for default font

Definition at line 147 of file enginesettings.cpp.

void FIFE::EngineSettings::setDefaultFontSize ( const unsigned int  defaultfontsize  ) 

Sets size for default font

Definition at line 151 of file enginesettings.cpp.

void FIFE::EngineSettings::setFullScreen ( bool  fullscreen  )  [inline]

Sets fullscreen / windowed mode

Definition at line 77 of file enginesettings.h.

void FIFE::EngineSettings::setImageChunkingSize ( unsigned int  size  )  [inline]

Sets image chunking size,

See also:
RenderBackend::setChunkingSize

Definition at line 179 of file enginesettings.h.

void FIFE::EngineSettings::setInitialVolume ( float  volume  ) 

Sets initial engine sound volume

See also:
getInitialMaxVolume

Definition at line 104 of file enginesettings.cpp.

References getMaxVolume().

void FIFE::EngineSettings::setRenderBackend ( const std::string &  renderbackend  ) 

Sets name for renderbackend

See also:
getPossibleRenderBackends

Definition at line 118 of file enginesettings.cpp.

References getPossibleRenderBackends().

void FIFE::EngineSettings::setScreenHeight ( unsigned int  screenheight  ) 

Sets screen height (pixels)

Definition at line 143 of file enginesettings.cpp.

void FIFE::EngineSettings::setScreenWidth ( unsigned int  screenwidth  ) 

Sets screen width (pixels)

Definition at line 139 of file enginesettings.cpp.

void FIFE::EngineSettings::setSDLRemoveFakeAlpha ( bool  sldremovefakealpha  ) 

Sets if fake alpha is removed in SDL renderbackend

Definition at line 135 of file enginesettings.cpp.

void FIFE::EngineSettings::setWindowIcon ( const std::string &  icon  ) 

Sets the icon that appears in the window title bar

Definition at line 163 of file enginesettings.cpp.

void FIFE::EngineSettings::setWindowTitle ( const std::string &  title  ) 

Sets the title of the window

Definition at line 159 of file enginesettings.cpp.

void FIFE::EngineSettings::validate (  )  const

Validates settings. On invalid settings, throws NotSet with message

Definition at line 63 of file enginesettings.cpp.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2-20100208