FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
FIFE::EngineSettings Class Reference

#include <enginesettings.h>

Collaboration diagram for FIFE::EngineSettings:
Collaboration graph

List of all members.

Public Member Functions

 EngineSettings ()
 ~EngineSettings ()
void validate () const
void setBitsPerPixel (uint16_t bitsperpixel)
uint16_t getBitsPerPixel () const
std::vector< uint16_t > getPossibleBitsPerPixel () const
std::vector< std::pair
< uint16_t, uint16_t > > 
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 sdlremovefakealpha)
bool isSDLRemoveFakeAlpha (bool sdlremovefakealpha) const
void setScreenWidth (uint16_t screenwidth)
uint16_t getScreenWidth () const
void setScreenHeight (uint16_t screenheight)
uint16_t getScreenHeight () const
void setDefaultFontPath (const std::string &defaultfontpath)
std::string getDefaultFontPath () const
void setDefaultFontSize (uint16_t defaultfontsize)
uint16_t getDefaultFontSize () const
void setDefaultFontGlyphs (const std::string &defaultfontglyphs)
std::string getDefaultFontGlyphs () 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_t r, uint8_t g, uint8_t b)
const SDL_Color & getColorKey () const
void setLightingModel (unsigned int lighting)
unsigned int getLightingModel () 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 71 of file enginesettings.cpp.


Member Function Documentation

uint16_t FIFE::EngineSettings::getBitsPerPixel ( ) const
inline

Gets currently set bits per pixel value

Definition at line 63 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

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

Gets the global colorkey setting

Definition at line 192 of file enginesettings.cpp.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

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

Gets current glyphs for default font

Definition at line 173 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

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

Sets current path for default font

Definition at line 153 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

uint16_t FIFE::EngineSettings::getDefaultFontSize ( ) const
inline

Gets size for default font

Definition at line 163 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

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

Gets initial engine sound volume

Definition at line 94 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

unsigned int FIFE::EngineSettings::getLightingModel ( ) const
inline

Gets the currently set light model

Definition at line 223 of file enginesettings.h.

Referenced by FIFE::Engine::init(), and FIFE::Engine::pump().

Here is the caller graph for this function:

float FIFE::EngineSettings::getMaxVolume ( ) const

Gets maximum volume that can be set

Definition at line 125 of file enginesettings.cpp.

Referenced by setInitialVolume().

Here is the caller graph for this function:

std::vector< uint16_t > FIFE::EngineSettings::getPossibleBitsPerPixel ( ) const

Gets all possible bits per pixel values

Definition at line 106 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 139 of file enginesettings.cpp.

Referenced by setRenderBackend().

Here is the caller graph for this function:

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

Gets all possible screen resolutions

Definition at line 84 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(), and FIFE::Engine::init().

Here is the caller graph for this function:

uint16_t FIFE::EngineSettings::getScreenHeight ( ) const
inline

Gets screen height (pixels)

Definition at line 143 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

uint16_t FIFE::EngineSettings::getScreenWidth ( ) const
inline

Gets screen width (pixels)

Definition at line 133 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

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

Gets the icon in the window title bar

Definition at line 193 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

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

Gets the current window title

Definition at line 183 of file enginesettings.h.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

bool FIFE::EngineSettings::isColorKeyEnabled ( ) const

Gets whether the colorkey feature is in use

Definition at line 182 of file enginesettings.cpp.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:

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

True, if set to fullscreen. False = windowed

Definition at line 83 of file enginesettings.h.

Referenced by getPossibleResolutions(), and FIFE::Engine::init().

Here is the caller graph for this function:

bool FIFE::EngineSettings::isSDLRemoveFakeAlpha ( bool  sdlremovefakealpha) const
inline

Tells if fake alpha is removed in SDL renderbackend

Definition at line 123 of file enginesettings.h.

void FIFE::EngineSettings::setBitsPerPixel ( uint16_t  bitsperpixel)

Sets bits per pixel

See also:
getPossibleBitsPerPixel

Definition at line 96 of file enginesettings.cpp.

References getPossibleBitsPerPixel().

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

Sets the global colorkey to use for images

Definition at line 186 of file enginesettings.cpp.

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

Sets whether to use the colorkey feature

Definition at line 178 of file enginesettings.cpp.

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

Sets glyphs for default font

Definition at line 166 of file enginesettings.cpp.

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

Sets path for default font

Definition at line 158 of file enginesettings.cpp.

void FIFE::EngineSettings::setDefaultFontSize ( uint16_t  defaultfontsize)

Sets size for default font

Definition at line 162 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::setInitialVolume ( float  volume)

Sets initial engine sound volume

See also:
getInitialMaxVolume

Definition at line 115 of file enginesettings.cpp.

References getMaxVolume().

void FIFE::EngineSettings::setLightingModel ( unsigned int  lighting)

Sets the light model

Definition at line 203 of file enginesettings.cpp.

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

Sets name for renderbackend

See also:
getPossibleRenderBackends

Definition at line 129 of file enginesettings.cpp.

References getPossibleRenderBackends().

void FIFE::EngineSettings::setScreenHeight ( uint16_t  screenheight)

Sets screen height (pixels)

Definition at line 154 of file enginesettings.cpp.

void FIFE::EngineSettings::setScreenWidth ( uint16_t  screenwidth)

Sets screen width (pixels)

Definition at line 150 of file enginesettings.cpp.

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

Sets if fake alpha is removed in SDL renderbackend

Definition at line 146 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 174 of file enginesettings.cpp.

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

Sets the title of the window

Definition at line 170 of file enginesettings.cpp.

void FIFE::EngineSettings::validate ( ) const

Validates settings. On invalid settings, throws NotSet with message

Definition at line 74 of file enginesettings.cpp.

Referenced by FIFE::Engine::init().

Here is the caller graph for this function:


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