FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
FIFE::EngineSettings Class Reference

This class defines the engine settings on engine init. More...

#include <enginesettings.h>

+ Collaboration diagram for FIFE::EngineSettings:

Public Member Functions

 EngineSettings ()
 Constructor. More...
 
 ~EngineSettings ()
 Destructor. More...
 
void setBitsPerPixel (uint8_t bitsperpixel)
 Sets bits per pixel. More...
 
uint8_t getBitsPerPixel () const
 Gets currently set bits per pixel value. More...
 
std::vector< uint8_t > getPossibleBitsPerPixel () const
 Gets all possible bits per pixel values. More...
 
void setFullScreen (bool fullscreen)
 Sets fullscreen / windowed mode. More...
 
bool isFullScreen () const
 True, if set to fullscreen. More...
 
void setRefreshRate (uint16_t rate)
 Sets refresh rate. More...
 
uint16_t getRefreshRate () const
 Gets the refresh rate. More...
 
void setDisplay (uint8_t display)
 Sets display index, starts with 0. More...
 
uint8_t getDisplay () const
 Gets the display index, starts with 0. More...
 
void setVSync (bool vsync)
 Sets Vsync. More...
 
bool isVSync () const
 True, if vsync is enable, otherwise false. More...
 
void setSDLDriver (const std::string &driver)
 Sets the used SDL render driver. More...
 
const std::string & getSDLDriver () const
 Gets the used SDL render driver. More...
 
void setInitialVolume (float volume)
 Sets initial engine sound volume. More...
 
float getInitialVolume () const
 Gets initial engine sound volume. More...
 
float getMaxVolume () const
 Gets maximum volume that can be set. More...
 
void setRenderBackend (const std::string &renderbackend)
 Sets name for renderbackend. More...
 
const std::string & getRenderBackend () const
 Gets currently set renderbackend name. More...
 
std::string getRenderBackend ()
 Gets currently set renderbackend name. More...
 
std::vector< std::string > getPossibleRenderBackends ()
 Gets all possible renderbackend names. More...
 
void setSDLRemoveFakeAlpha (bool sdlremovefakealpha)
 Sets if fake alpha is removed in SDL renderbackend. More...
 
bool isSDLRemoveFakeAlpha () const
 Tells if fake alpha is removed in SDL renderbackend. More...
 
void setGLCompressImages (bool oglcompressimages)
 Sets if images are compress by video driver in OpenGL renderbackend. More...
 
bool isGLCompressImages () const
 Tells if images are compress by video driver in OpenGL renderbackend. More...
 
void setGLUseFramebuffer (bool ogluseframebuffer)
 Sets if OpenGL renderbackend should use FramebufferObject (when available) More...
 
bool isGLUseFramebuffer () const
 Tells if OpenGL renderbackend should use FramebufferObject. More...
 
void setGLUseNPOT (bool oglusenpot)
 Sets if OpenGL renderbackend should use NPOT Textures (when available) More...
 
bool isGLUseNPOT () const
 Tells if OpenGL renderbackend should use NPOT Textures. More...
 
void setGLTextureFiltering (TextureFiltering filter)
 Sets texture filtering method for OpenGL renderbackend. More...
 
TextureFiltering getGLTextureFiltering () const
 Gets current texture filter which uses OpenGL. More...
 
void setGLUseMipmapping (bool mipmapping)
 Sets if OpenGL renderbackend should use mipmapping. More...
 
bool isGLUseMipmapping () const
 Tells if OpenGL renderbackend should use mipmapping. More...
 
void setGLUseMonochrome (bool monochrome)
 Sets if OpenGL renderbackend should render only monochrome. More...
 
bool isGLUseMonochrome () const
 Tells if OpenGL renderbackend should render only monochrome. More...
 
void setGLUseDepthBuffer (bool buffer)
 Sets if OpenGL renderbackend should use depth buffer. More...
 
bool isGLUseDepthBuffer () const
 Tells if OpenGL renderbackend should use depth buffer. More...
 
void setGLAlphaTestValue (float alpha)
 Sets alpha test value for OpenGL renderbackend. More...
 
float getGLAlphaTestValue () const
 Gets current alpha test value which uses OpenGL. More...
 
void setScreenWidth (uint16_t screenwidth)
 Sets screen width (pixels) More...
 
uint16_t getScreenWidth () const
 Gets screen width (pixels) More...
 
void setScreenHeight (uint16_t screenheight)
 Sets screen height (pixels) More...
 
uint16_t getScreenHeight () const
 Gets screen height (pixels) More...
 
void setDefaultFontPath (const std::string &defaultfontpath)
 Sets path for default font. More...
 
const std::string & getDefaultFontPath () const
 Gets current path for default font. More...
 
std::string getDefaultFontPath ()
 Gets current path for default font. More...
 
void setDefaultFontSize (uint16_t defaultfontsize)
 Sets size for default font. More...
 
uint16_t getDefaultFontSize () const
 Gets size for default font. More...
 
void setDefaultFontGlyphs (const std::string &defaultfontglyphs)
 Sets glyphs for default font. More...
 
const std::string & getDefaultFontGlyphs () const
 Gets current glyphs for default font. More...
 
std::string getDefaultFontGlyphs ()
 Gets current glyphs for default font. More...
 
void setWindowTitle (const std::string &title)
 Sets the title of the window. More...
 
const std::string & getWindowTitle () const
 Gets the current window title. More...
 
std::string getWindowTitle ()
 Gets the current window title. More...
 
void setWindowIcon (const std::string &icon)
 Sets the icon that appears in the window title bar. More...
 
const std::string & getWindowIcon () const
 Gets the icon in the window title bar. More...
 
std::string getWindowIcon ()
 Gets the icon in the window title bar. More...
 
void setColorKeyEnabled (bool colorkeyenable)
 Sets whether to use the colorkey feature. More...
 
bool isColorKeyEnabled () const
 Gets whether the colorkey feature is in use. More...
 
void setColorKey (uint8_t r, uint8_t g, uint8_t b)
 Sets the global colorkey to use for images. More...
 
const SDL_Color & getColorKey () const
 Gets the global colorkey setting. More...
 
void setVideoDriver (const std::string &driver)
 Sets the video driver. More...
 
const std::string & getVideoDriver () const
 Gets the video driver. More...
 
void setLightingModel (uint32_t lighting)
 Sets the light model. More...
 
uint32_t getLightingModel () const
 Gets the currently set light model. More...
 
void setFrameLimitEnabled (bool limited)
 Sets whether to use the frame limiter. More...
 
bool isFrameLimitEnabled () const
 Gets whether the frame limiter is in use. More...
 
void setFrameLimit (uint16_t framelimit)
 Sets the frame limit. More...
 
uint16_t getFrameLimit () const
 Gets the frame limit. More...
 
void setMouseSensitivity (float sens)
 Sets mouse sensitivity. More...
 
float getMouseSensitivity () const
 Gets mouse sensitivity. More...
 
void setMouseAccelerationEnabled (bool acceleration)
 Sets mouse acceleration if mouse acceleration is enabled, then the mouse sensitivity is used as speed max. More...
 
bool isMouseAccelerationEnabled () const
 Returns if mouse acceleration is enabled or not. More...
 
void setNativeImageCursorEnabled (bool nativeimagecursor)
 Enables or disables native image cursor. More...
 
bool isNativeImageCursorEnabled () const
 Returns whether cursors set to an image or an animation are drawn natively. More...
 
void setJoystickSupport (bool support)
 Enables or disables joystick and gamepad support. More...
 
bool isJoystickSupport () const
 Returns whether joystick and gamepad support is enabled or not. More...
 

Private Attributes

uint8_t m_bitsperpixel
 
bool m_fullscreen
 
uint16_t m_refreshRate
 
uint8_t m_displayIndex
 
bool m_vSync
 
std::string m_renderDriver
 
float m_initialvolume
 
std::string m_renderbackend
 
bool m_sdlremovefakealpha
 
bool m_oglcompressimages
 
bool m_ogluseframebuffer
 
bool m_oglusenpot
 
bool m_oglMipmapping
 
bool m_oglMonochrome
 
TextureFiltering m_oglTextureFilter
 
bool m_oglDepthBuffer
 
float m_alphaTestValue
 
uint16_t m_screenwidth
 
uint16_t m_screenheight
 
std::string m_windowtitle
 
std::string m_windowicon
 
std::string m_defaultfontpath
 
uint16_t m_defaultfontsize
 
std::string m_defaultfontglyphs
 
bool m_iscolorkeyenabled
 
SDL_Color m_colorkey
 
std::string m_videodriver
 
uint32_t m_lighting
 
bool m_isframelimit
 
uint16_t m_framelimit
 
float m_mousesensitivity
 
bool m_mouseacceleration
 
bool m_nativeimagecursor
 
bool m_joystickSupport
 

Detailed Description

This class defines the engine settings on engine init.

Definition at line 43 of file enginesettings.h.

Constructor & Destructor Documentation

FIFE::EngineSettings::EngineSettings ( )

Constructor.

Definition at line 46 of file enginesettings.cpp.

References m_colorkey, and m_videodriver.

FIFE::EngineSettings::~EngineSettings ( )

Destructor.

Definition at line 95 of file enginesettings.cpp.

Member Function Documentation

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

Gets currently set bits per pixel value.

Definition at line 60 of file enginesettings.h.

References getPossibleBitsPerPixel(), and m_bitsperpixel.

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 258 of file enginesettings.cpp.

References m_colorkey.

Referenced by getWindowIcon(), and 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 301 of file enginesettings.h.

References m_defaultfontglyphs.

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

Gets current glyphs for default font.

Definition at line 307 of file enginesettings.h.

References m_defaultfontglyphs, and setWindowTitle().

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

Gets current path for default font.

Definition at line 275 of file enginesettings.h.

References m_defaultfontpath.

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

Gets current path for default font.

Definition at line 281 of file enginesettings.h.

References m_defaultfontpath, and setDefaultFontSize().

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

Gets size for default font.

Definition at line 291 of file enginesettings.h.

References m_defaultfontsize, and setDefaultFontGlyphs().

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

Gets the display index, starts with 0.

Definition at line 100 of file enginesettings.h.

References m_displayIndex.

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

+ Here is the caller graph for this function:

uint16_t FIFE::EngineSettings::getFrameLimit ( ) const

Gets the frame limit.

Definition at line 295 of file enginesettings.cpp.

References m_framelimit.

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

+ Here is the caller graph for this function:

float FIFE::EngineSettings::getGLAlphaTestValue ( ) const

Gets current alpha test value which uses OpenGL.

Definition at line 212 of file enginesettings.cpp.

References m_alphaTestValue.

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

+ Here is the caller graph for this function:

TextureFiltering FIFE::EngineSettings::getGLTextureFiltering ( ) const

Gets current texture filter which uses OpenGL.

Definition at line 180 of file enginesettings.cpp.

References m_oglTextureFilter.

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

+ Here is the caller graph for this function:

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

Gets initial engine sound volume.

Definition at line 140 of file enginesettings.h.

References getMaxVolume(), m_initialvolume, and setRenderBackend().

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

+ Here is the caller graph for this function:

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

Gets maximum volume that can be set.

Definition at line 135 of file enginesettings.cpp.

References FIFE::MAXIMUM_VOLUME.

Referenced by getInitialVolume(), and setInitialVolume().

+ Here is the caller graph for this function:

float FIFE::EngineSettings::getMouseSensitivity ( ) const

Gets mouse sensitivity.

Definition at line 303 of file enginesettings.cpp.

References m_mousesensitivity.

Referenced by getLightingModel(), and 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 113 of file enginesettings.cpp.

Referenced by getBitsPerPixel(), and setBitsPerPixel().

+ Here is the caller graph for this function:

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

Gets all possible renderbackend names.

Definition at line 153 of file enginesettings.cpp.

Referenced by getRenderBackend(), and setRenderBackend().

+ Here is the caller graph for this function:

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

Gets the refresh rate.

Definition at line 88 of file enginesettings.h.

References m_refreshRate.

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

+ Here is the caller graph for this function:

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

Gets currently set renderbackend name.

Definition at line 155 of file enginesettings.h.

References m_renderbackend.

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

References getPossibleRenderBackends(), m_renderbackend, and setSDLRemoveFakeAlpha().

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

Gets screen height (pixels)

Definition at line 265 of file enginesettings.h.

References m_screenheight, and setDefaultFontPath().

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

References m_screenwidth, and setScreenHeight().

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

+ Here is the caller graph for this function:

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

Gets the used SDL render driver.

Default is a empty string, that indicates SDL chooses the driver.

See also
setSDLDriver()

Definition at line 129 of file enginesettings.h.

References m_renderDriver, and setInitialVolume().

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

+ Here is the caller graph for this function:

const std::string & FIFE::EngineSettings::getVideoDriver ( ) const

Gets the video driver.

Default is a empty string.

See also
setVideoDriver()

Definition at line 267 of file enginesettings.cpp.

References m_videodriver.

Referenced by getWindowIcon(), and 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 333 of file enginesettings.h.

References m_windowicon.

Referenced by FIFE::Engine::changeScreenMode(), and 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 339 of file enginesettings.h.

References getColorKey(), getVideoDriver(), isColorKeyEnabled(), m_windowicon, setColorKey(), setColorKeyEnabled(), setLightingModel(), and setVideoDriver().

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

Gets the current window title.

Definition at line 317 of file enginesettings.h.

References m_windowtitle.

Referenced by FIFE::Engine::changeScreenMode(), and 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 323 of file enginesettings.h.

References m_windowtitle, and setWindowIcon().

bool FIFE::EngineSettings::isColorKeyEnabled ( ) const

Gets whether the colorkey feature is in use.

Definition at line 248 of file enginesettings.cpp.

References m_iscolorkeyenabled.

Referenced by getWindowIcon(), and 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 287 of file enginesettings.cpp.

References m_isframelimit.

Referenced by getLightingModel(), and 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 76 of file enginesettings.h.

References m_fullscreen.

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

References m_oglcompressimages, and setGLUseFramebuffer().

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

+ Here is the caller graph for this function:

bool FIFE::EngineSettings::isGLUseDepthBuffer ( ) const

Tells if OpenGL renderbackend should use depth buffer.

Definition at line 204 of file enginesettings.cpp.

References m_oglDepthBuffer.

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

+ Here is the caller graph for this function:

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

Tells if OpenGL renderbackend should use FramebufferObject.

Definition at line 195 of file enginesettings.h.

References m_ogluseframebuffer, and setGLUseNPOT().

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

+ Here is the caller graph for this function:

bool FIFE::EngineSettings::isGLUseMipmapping ( ) const

Tells if OpenGL renderbackend should use mipmapping.

Definition at line 188 of file enginesettings.cpp.

References m_oglMipmapping.

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

+ Here is the caller graph for this function:

bool FIFE::EngineSettings::isGLUseMonochrome ( ) const

Tells if OpenGL renderbackend should render only monochrome.

Definition at line 196 of file enginesettings.cpp.

References m_oglMonochrome.

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

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

References getGLAlphaTestValue(), getGLTextureFiltering(), isGLUseDepthBuffer(), isGLUseMipmapping(), isGLUseMonochrome(), m_oglusenpot, setGLAlphaTestValue(), setGLTextureFiltering(), setGLUseDepthBuffer(), setGLUseMipmapping(), setGLUseMonochrome(), and setScreenWidth().

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

+ Here is the caller graph for this function:

bool FIFE::EngineSettings::isJoystickSupport ( ) const

Returns whether joystick and gamepad support is enabled or not.

Definition at line 327 of file enginesettings.cpp.

References m_joystickSupport.

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

+ Here is the caller graph for this function:

bool FIFE::EngineSettings::isMouseAccelerationEnabled ( ) const

Returns if mouse acceleration is enabled or not.

Returns
True if mouse acceleration is enabled, false if not.

Definition at line 311 of file enginesettings.cpp.

References m_mouseacceleration.

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

+ Here is the caller graph for this function:

bool FIFE::EngineSettings::isNativeImageCursorEnabled ( ) const

Returns whether cursors set to an image or an animation are drawn natively.

See also
Cursor::setNativeImageCursorEnabled()

Definition at line 319 of file enginesettings.cpp.

References m_nativeimagecursor.

Referenced by getLightingModel(), and 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 175 of file enginesettings.h.

References m_sdlremovefakealpha, and setGLCompressImages().

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

True, if vsync is enable, otherwise false.

Definition at line 112 of file enginesettings.h.

References m_vSync.

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

+ Here is the caller graph for this function:

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

Sets bits per pixel.

See also
getPossibleBitsPerPixel

Definition at line 98 of file enginesettings.cpp.

References FIFE::_log, FL_WARN, getPossibleBitsPerPixel(), and m_bitsperpixel.

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

Sets the global colorkey to use for images.

Definition at line 252 of file enginesettings.cpp.

References m_colorkey.

Referenced by getWindowIcon().

+ Here is the caller graph for this function:

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

Sets whether to use the colorkey feature.

Definition at line 244 of file enginesettings.cpp.

References m_iscolorkeyenabled.

Referenced by getWindowIcon().

+ Here is the caller graph for this function:

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

Sets glyphs for default font.

Definition at line 232 of file enginesettings.cpp.

References m_defaultfontglyphs.

Referenced by getDefaultFontSize().

+ Here is the caller graph for this function:

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

Sets path for default font.

Definition at line 224 of file enginesettings.cpp.

References m_defaultfontpath.

Referenced by getScreenHeight().

+ Here is the caller graph for this function:

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

Sets size for default font.

Definition at line 228 of file enginesettings.cpp.

References m_defaultfontsize.

Referenced by getDefaultFontPath().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setDisplay ( uint8_t  display)
inline

Sets display index, starts with 0.

Definition at line 94 of file enginesettings.h.

References m_displayIndex.

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

Sets the frame limit.

Definition at line 291 of file enginesettings.cpp.

References m_framelimit.

Referenced by getLightingModel().

+ Here is the caller graph for this function:

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

Sets whether to use the frame limiter.

Definition at line 283 of file enginesettings.cpp.

References m_isframelimit.

Referenced by getLightingModel().

+ Here is the caller graph for this function:

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

Sets fullscreen / windowed mode.

Definition at line 70 of file enginesettings.h.

References m_fullscreen.

void FIFE::EngineSettings::setGLAlphaTestValue ( float  alpha)

Sets alpha test value for OpenGL renderbackend.

Definition at line 208 of file enginesettings.cpp.

References m_alphaTestValue.

Referenced by isGLUseNPOT().

+ Here is the caller graph for this function:

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

Sets if images are compress by video driver in OpenGL renderbackend.

Definition at line 164 of file enginesettings.cpp.

References m_oglcompressimages.

Referenced by isSDLRemoveFakeAlpha().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setGLTextureFiltering ( TextureFiltering  filter)

Sets texture filtering method for OpenGL renderbackend.

Definition at line 176 of file enginesettings.cpp.

References m_oglTextureFilter.

Referenced by isGLUseNPOT().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setGLUseDepthBuffer ( bool  buffer)

Sets if OpenGL renderbackend should use depth buffer.

Definition at line 200 of file enginesettings.cpp.

References m_oglDepthBuffer.

Referenced by isGLUseNPOT().

+ Here is the caller graph for this function:

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

Sets if OpenGL renderbackend should use FramebufferObject (when available)

Definition at line 168 of file enginesettings.cpp.

References m_ogluseframebuffer.

Referenced by isGLCompressImages().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setGLUseMipmapping ( bool  mipmapping)

Sets if OpenGL renderbackend should use mipmapping.

Definition at line 184 of file enginesettings.cpp.

References m_oglMipmapping.

Referenced by isGLUseNPOT().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setGLUseMonochrome ( bool  monochrome)

Sets if OpenGL renderbackend should render only monochrome.

Definition at line 192 of file enginesettings.cpp.

References m_oglMonochrome.

Referenced by isGLUseNPOT().

+ Here is the caller graph for this function:

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

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

Definition at line 172 of file enginesettings.cpp.

References m_oglusenpot.

Referenced by isGLUseFramebuffer().

+ Here is the caller graph for this function:

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

Sets initial engine sound volume.

See also
getInitialMaxVolume

Definition at line 122 of file enginesettings.cpp.

References FIFE::_log, FL_WARN, getMaxVolume(), and m_initialvolume.

Referenced by getSDLDriver().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setJoystickSupport ( bool  support)

Enables or disables joystick and gamepad support.

Definition at line 323 of file enginesettings.cpp.

References m_joystickSupport.

Referenced by getLightingModel().

+ Here is the caller graph for this function:

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

Sets the light model.

Definition at line 270 of file enginesettings.cpp.

References FIFE::_log, FL_WARN, and m_lighting.

Referenced by getWindowIcon().

+ Here is the caller graph for this function:

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

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

Definition at line 307 of file enginesettings.cpp.

References m_mouseacceleration.

Referenced by getLightingModel().

+ Here is the caller graph for this function:

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

Sets mouse sensitivity.

Definition at line 299 of file enginesettings.cpp.

References m_mousesensitivity.

Referenced by getLightingModel().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setNativeImageCursorEnabled ( bool  nativeimagecursor)

Enables or disables native image cursor.

See also
Cursor::setNativeImageCursorEnabled()

Definition at line 315 of file enginesettings.cpp.

References m_nativeimagecursor.

Referenced by getLightingModel().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setRefreshRate ( uint16_t  rate)
inline

Sets refresh rate.

Definition at line 82 of file enginesettings.h.

References m_refreshRate.

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

Sets name for renderbackend.

See also
getPossibleRenderBackends

Definition at line 139 of file enginesettings.cpp.

References FIFE::_log, FL_WARN, getPossibleRenderBackends(), and m_renderbackend.

Referenced by getInitialVolume().

+ Here is the caller graph for this function:

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

Sets screen height (pixels)

Definition at line 220 of file enginesettings.cpp.

References m_screenheight.

Referenced by getScreenWidth().

+ Here is the caller graph for this function:

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

Sets screen width (pixels)

Definition at line 216 of file enginesettings.cpp.

References m_screenwidth.

Referenced by isGLUseNPOT().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setSDLDriver ( const std::string &  driver)
inline

Sets the used SDL render driver.

Values depends on platform and is useless for the OpenGL backend. If none is set, SDL use the first one that supports the requested flags.

See also
DeviceCaps::getAvailableRenderDrivers()

Definition at line 121 of file enginesettings.h.

References m_renderDriver.

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

Sets if fake alpha is removed in SDL renderbackend.

Definition at line 160 of file enginesettings.cpp.

References m_sdlremovefakealpha.

Referenced by getRenderBackend().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setVideoDriver ( const std::string &  driver)

Sets the video driver.

Values depends on platform. If none is set, SDL chooses it.

See also
DeviceCaps::getAvailableVideoDrivers()

Definition at line 262 of file enginesettings.cpp.

References m_videodriver.

Referenced by getWindowIcon().

+ Here is the caller graph for this function:

void FIFE::EngineSettings::setVSync ( bool  vsync)
inline

Sets Vsync.

Synchronized updates with vertical refresh rate.

Definition at line 106 of file enginesettings.h.

References m_vSync.

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

Sets the icon that appears in the window title bar.

Definition at line 240 of file enginesettings.cpp.

References m_windowicon.

Referenced by getWindowTitle().

+ Here is the caller graph for this function:

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

Sets the title of the window.

Definition at line 236 of file enginesettings.cpp.

References m_windowtitle.

Referenced by getDefaultFontGlyphs().

+ Here is the caller graph for this function:

Member Data Documentation

float FIFE::EngineSettings::m_alphaTestValue
private

Definition at line 452 of file enginesettings.h.

Referenced by getGLAlphaTestValue(), and setGLAlphaTestValue().

uint8_t FIFE::EngineSettings::m_bitsperpixel
private

Definition at line 436 of file enginesettings.h.

Referenced by getBitsPerPixel(), and setBitsPerPixel().

SDL_Color FIFE::EngineSettings::m_colorkey
private

Definition at line 463 of file enginesettings.h.

Referenced by EngineSettings(), getColorKey(), and setColorKey().

std::string FIFE::EngineSettings::m_defaultfontglyphs
private

Definition at line 461 of file enginesettings.h.

Referenced by getDefaultFontGlyphs(), and setDefaultFontGlyphs().

std::string FIFE::EngineSettings::m_defaultfontpath
private

Definition at line 459 of file enginesettings.h.

Referenced by getDefaultFontPath(), and setDefaultFontPath().

uint16_t FIFE::EngineSettings::m_defaultfontsize
private

Definition at line 460 of file enginesettings.h.

Referenced by getDefaultFontSize(), and setDefaultFontSize().

uint8_t FIFE::EngineSettings::m_displayIndex
private

Definition at line 439 of file enginesettings.h.

Referenced by getDisplay(), and setDisplay().

uint16_t FIFE::EngineSettings::m_framelimit
private

Definition at line 467 of file enginesettings.h.

Referenced by getFrameLimit(), and setFrameLimit().

bool FIFE::EngineSettings::m_fullscreen
private

Definition at line 437 of file enginesettings.h.

Referenced by isFullScreen(), and setFullScreen().

float FIFE::EngineSettings::m_initialvolume
private

Definition at line 442 of file enginesettings.h.

Referenced by getInitialVolume(), and setInitialVolume().

bool FIFE::EngineSettings::m_iscolorkeyenabled
private

Definition at line 462 of file enginesettings.h.

Referenced by isColorKeyEnabled(), and setColorKeyEnabled().

bool FIFE::EngineSettings::m_isframelimit
private

Definition at line 466 of file enginesettings.h.

Referenced by isFrameLimitEnabled(), and setFrameLimitEnabled().

bool FIFE::EngineSettings::m_joystickSupport
private

Definition at line 471 of file enginesettings.h.

Referenced by isJoystickSupport(), and setJoystickSupport().

uint32_t FIFE::EngineSettings::m_lighting
private

Definition at line 465 of file enginesettings.h.

Referenced by getLightingModel(), and setLightingModel().

bool FIFE::EngineSettings::m_mouseacceleration
private

Definition at line 469 of file enginesettings.h.

Referenced by isMouseAccelerationEnabled(), and setMouseAccelerationEnabled().

float FIFE::EngineSettings::m_mousesensitivity
private

Definition at line 468 of file enginesettings.h.

Referenced by getMouseSensitivity(), and setMouseSensitivity().

bool FIFE::EngineSettings::m_nativeimagecursor
private

Definition at line 470 of file enginesettings.h.

Referenced by isNativeImageCursorEnabled(), and setNativeImageCursorEnabled().

bool FIFE::EngineSettings::m_oglcompressimages
private

Definition at line 445 of file enginesettings.h.

Referenced by isGLCompressImages(), and setGLCompressImages().

bool FIFE::EngineSettings::m_oglDepthBuffer
private

Definition at line 451 of file enginesettings.h.

Referenced by isGLUseDepthBuffer(), and setGLUseDepthBuffer().

bool FIFE::EngineSettings::m_oglMipmapping
private

Definition at line 448 of file enginesettings.h.

Referenced by isGLUseMipmapping(), and setGLUseMipmapping().

bool FIFE::EngineSettings::m_oglMonochrome
private

Definition at line 449 of file enginesettings.h.

Referenced by isGLUseMonochrome(), and setGLUseMonochrome().

TextureFiltering FIFE::EngineSettings::m_oglTextureFilter
private

Definition at line 450 of file enginesettings.h.

Referenced by getGLTextureFiltering(), and setGLTextureFiltering().

bool FIFE::EngineSettings::m_ogluseframebuffer
private

Definition at line 446 of file enginesettings.h.

Referenced by isGLUseFramebuffer(), and setGLUseFramebuffer().

bool FIFE::EngineSettings::m_oglusenpot
private

Definition at line 447 of file enginesettings.h.

Referenced by isGLUseNPOT(), and setGLUseNPOT().

uint16_t FIFE::EngineSettings::m_refreshRate
private

Definition at line 438 of file enginesettings.h.

Referenced by getRefreshRate(), and setRefreshRate().

std::string FIFE::EngineSettings::m_renderbackend
private

Definition at line 443 of file enginesettings.h.

Referenced by getRenderBackend(), and setRenderBackend().

std::string FIFE::EngineSettings::m_renderDriver
private

Definition at line 441 of file enginesettings.h.

Referenced by getSDLDriver(), and setSDLDriver().

uint16_t FIFE::EngineSettings::m_screenheight
private

Definition at line 454 of file enginesettings.h.

Referenced by getScreenHeight(), and setScreenHeight().

uint16_t FIFE::EngineSettings::m_screenwidth
private

Definition at line 453 of file enginesettings.h.

Referenced by getScreenWidth(), and setScreenWidth().

bool FIFE::EngineSettings::m_sdlremovefakealpha
private

Definition at line 444 of file enginesettings.h.

Referenced by isSDLRemoveFakeAlpha(), and setSDLRemoveFakeAlpha().

std::string FIFE::EngineSettings::m_videodriver
private

Definition at line 464 of file enginesettings.h.

Referenced by EngineSettings(), getVideoDriver(), and setVideoDriver().

bool FIFE::EngineSettings::m_vSync
private

Definition at line 440 of file enginesettings.h.

Referenced by isVSync(), and setVSync().

std::string FIFE::EngineSettings::m_windowicon
private

Definition at line 456 of file enginesettings.h.

Referenced by getWindowIcon(), and setWindowIcon().

std::string FIFE::EngineSettings::m_windowtitle
private

Definition at line 455 of file enginesettings.h.

Referenced by getWindowTitle(), and setWindowTitle().


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