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

Public Member Functions

 EngineSettings ()
 
 ~EngineSettings ()
 
void setBitsPerPixel (uint8_t bitsperpixel)
 
uint8_t getBitsPerPixel () const
 
std::vector< uint8_t > getPossibleBitsPerPixel () 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::string getRenderBackend ()
 
std::vector< std::string > getPossibleRenderBackends ()
 
void setSDLRemoveFakeAlpha (bool sdlremovefakealpha)
 
bool isSDLRemoveFakeAlpha () const
 
void setGLCompressImages (bool oglcompressimages)
 
bool isGLCompressImages () const
 
void setGLUseFramebuffer (bool ogluseframebuffer)
 
bool isGLUseFramebuffer () const
 
void setGLUseNPOT (bool oglusenpot)
 
bool isGLUseNPOT () 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)
 
const std::string & getDefaultFontPath () const
 
std::string getDefaultFontPath ()
 
void setDefaultFontSize (uint16_t defaultfontsize)
 
uint16_t getDefaultFontSize () const
 
void setDefaultFontGlyphs (const std::string &defaultfontglyphs)
 
const std::string & getDefaultFontGlyphs () const
 
std::string getDefaultFontGlyphs ()
 
void setWindowTitle (const std::string &title)
 
const std::string & getWindowTitle () const
 
std::string getWindowTitle ()
 
void setWindowIcon (const std::string &icon)
 
const std::string & getWindowIcon () const
 
std::string getWindowIcon ()
 
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 (uint32_t lighting)
 
uint32_t getLightingModel () const
 
void setFrameLimitEnabled (bool limited)
 
bool isFrameLimitEnabled () const
 
void setFrameLimit (uint16_t framelimit)
 
uint16_t getFrameLimit () const
 
void setMouseSensitivity (float sens)
 
float getMouseSensitivity () const
 
void setMouseAcceleration (bool acceleration)
 
bool getMouseAcceleration () 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 43 of file enginesettings.cpp.

FIFE::EngineSettings::~EngineSettings ( )

Destructor

Definition at line 81 of file enginesettings.cpp.

Member Function Documentation

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

Gets currently set bits per pixel value

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

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

Here is the caller graph for this function:

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

Gets current glyphs for default font

Definition at line 207 of file enginesettings.h.

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

Gets current glyphs for default font

Definition at line 213 of file enginesettings.h.

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

Gets current path for default font

Definition at line 181 of file enginesettings.h.

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

Gets current path for default font

Definition at line 187 of file enginesettings.h.

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

Gets size for default font

Definition at line 197 of file enginesettings.h.

uint16_t FIFE::EngineSettings::getFrameLimit ( ) const

Gets the frame limit

Definition at line 242 of file enginesettings.cpp.

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 86 of file enginesettings.h.

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

Here is the caller graph for this function:

uint32_t FIFE::EngineSettings::getLightingModel ( ) const
inline

Gets the currently set light model

Definition at line 275 of file enginesettings.h.

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

Here is the caller graph for this function:

float FIFE::EngineSettings::getMaxVolume ( ) const

Gets maximum volume that can be set

Definition at line 121 of file enginesettings.cpp.

Referenced by setInitialVolume().

Here is the caller graph for this function:

bool FIFE::EngineSettings::getMouseAcceleration ( ) const

Gets mouse acceleration

Definition at line 258 of file enginesettings.cpp.

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

Here is the caller graph for this function:

float FIFE::EngineSettings::getMouseSensitivity ( ) const

Gets mouse sensitivity

Definition at line 250 of file enginesettings.cpp.

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

Here is the caller graph for this function:

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

Gets all possible bits per pixel values

Definition at line 99 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:

const std::string& FIFE::EngineSettings::getRenderBackend ( ) const
inline

Gets currently set renderbackend name

Definition at line 101 of file enginesettings.h.

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

Here is the caller graph for this function:

std::string FIFE::EngineSettings::getRenderBackend ( )
inline

Gets currently set renderbackend name

Definition at line 107 of file enginesettings.h.

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

Gets screen height (pixels)

Definition at line 171 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 161 of file enginesettings.h.

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

Here is the caller graph for this function:

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

Gets the icon in the window title bar

Definition at line 239 of file enginesettings.h.

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

Here is the caller graph for this function:

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

Gets the icon in the window title bar

Definition at line 245 of file enginesettings.h.

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

Gets the current window title

Definition at line 223 of file enginesettings.h.

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

Here is the caller graph for this function:

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

Gets the current window title

Definition at line 229 of file enginesettings.h.

bool FIFE::EngineSettings::isColorKeyEnabled ( ) const

Gets whether the colorkey feature is in use

Definition at line 195 of file enginesettings.cpp.

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

Here is the caller graph for this function:

bool FIFE::EngineSettings::isFrameLimitEnabled ( ) const

Gets whether the frame limiter is in use

Definition at line 234 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 75 of file enginesettings.h.

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

Here is the caller graph for this function:

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

Tells if images are compress by video driver in OpenGL renderbackend

Definition at line 131 of file enginesettings.h.

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

Here is the caller graph for this function:

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

Tells if OpenGL renderbackend should use FramebufferObject

Definition at line 141 of file enginesettings.h.

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

Here is the caller graph for this function:

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

Tells if OpenGL renderbackend should use NPOT Textures

Definition at line 151 of file enginesettings.h.

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

Here is the caller graph for this function:

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

Tells if fake alpha is removed in SDL renderbackend

Definition at line 121 of file enginesettings.h.

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

Sets bits per pixel

See also
getPossibleBitsPerPixel

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

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

Sets whether to use the colorkey feature

Definition at line 191 of file enginesettings.cpp.

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

Sets glyphs for default font

Definition at line 179 of file enginesettings.cpp.

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

Sets path for default font

Definition at line 171 of file enginesettings.cpp.

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

Sets size for default font

Definition at line 175 of file enginesettings.cpp.

void FIFE::EngineSettings::setFrameLimit ( uint16_t  framelimit)

Sets the frame limit

Definition at line 238 of file enginesettings.cpp.

void FIFE::EngineSettings::setFrameLimitEnabled ( bool  limited)

Sets whether to use the frame limiter

Definition at line 230 of file enginesettings.cpp.

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

Sets fullscreen / windowed mode

Definition at line 69 of file enginesettings.h.

void FIFE::EngineSettings::setGLCompressImages ( bool  oglcompressimages)

Sets if images are compress by video driver in OpenGL renderbackend

Definition at line 151 of file enginesettings.cpp.

void FIFE::EngineSettings::setGLUseFramebuffer ( bool  ogluseframebuffer)

Sets if OpenGL renderbackend should use FramebufferObject (when available)

Definition at line 155 of file enginesettings.cpp.

void FIFE::EngineSettings::setGLUseNPOT ( bool  oglusenpot)

Sets if OpenGL renderbackend should use NPOT Textures (when available)

Definition at line 159 of file enginesettings.cpp.

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

Sets initial engine sound volume

See also
getInitialMaxVolume

Definition at line 108 of file enginesettings.cpp.

References getMaxVolume().

void FIFE::EngineSettings::setLightingModel ( uint32_t  lighting)

Sets the light model

Definition at line 217 of file enginesettings.cpp.

void FIFE::EngineSettings::setMouseAcceleration ( bool  acceleration)

Sets mouse acceleration if mouse acceleration is enabled, then the mouse sensitivity is used as speed max.

Definition at line 254 of file enginesettings.cpp.

void FIFE::EngineSettings::setMouseSensitivity ( float  sens)

Sets mouse sensitivity

Definition at line 246 of file enginesettings.cpp.

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

Sets name for renderbackend

See also
getPossibleRenderBackends

Definition at line 125 of file enginesettings.cpp.

References getPossibleRenderBackends().

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

Sets screen height (pixels)

Definition at line 167 of file enginesettings.cpp.

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

Sets screen width (pixels)

Definition at line 163 of file enginesettings.cpp.

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

Sets if fake alpha is removed in SDL renderbackend

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

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

Sets the title of the window

Definition at line 183 of file enginesettings.cpp.


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