nge::core::IConfigManager Class Reference
Interface for loading/saving configuration files. More...
#include <IConfigManager.hpp>
Public Member Functions | |
| virtual bool | createEmptyIniFile (E_DRIVER_TYPE DriverType, E_AUDIO_DEVICE AudioDeviceType, dimension2d< s32 > WindowSize, u32 Bits, bool Fullscreen, bool Stencilbuffer, bool Vsync, bool AntiAlias, bool HighPrecisionFPU, c8 *MainFontFile, c8 *IsMediaFolderOrZip, c8 *MediaArchive)=0 |
| Creates a new config file with default values. | |
| virtual bool | getAntiAlias () const =0 |
| Returns whether Anti Aliasing is on or off. | |
| virtual E_AUDIO_DEVICE | getAudioDeviceType () const =0 |
| Returns the audio device used. | |
| virtual u32 | getBitsPerPixel () const =0 |
| Returns how many bits are used per pixel. | |
| virtual bool | getFullscreen () const =0 |
| Returns whether the full-screen mode is on or off. | |
| virtual bool | getHighPrecisionFPU () const =0 |
| Returns whether high precision FPU is used or not. | |
| virtual stringc | getIniFilePath () const =0 |
| Returns the config file's path. | |
| virtual c8 * | getMainFontFileName () const =0 |
| Returns the file name of the main font. | |
| virtual c8 * | getMediaArchivePath () const =0 |
| Returns the path to the media. | |
| virtual SIrrlichtCreationParameters & | getSDeviceParam ()=0 |
| Returns the SIrrlichtCreationParameters with the created device's data. | |
| virtual bool | getStencilbuffer () const =0 |
| Returns whether shadows are drawn or not. | |
| virtual E_DRIVER_TYPE | getVideoDriverType () const =0 |
| Returns the driver used (like Direct3D9 or OpenGL..). | |
| virtual bool | getVsync () const =0 |
| Returns whether vertical retrace is on or off. | |
| virtual dimension2di | getWindowSize () const =0 |
| Returns the dimension of the device. | |
| virtual c8 * | isMediaFolderOrZip () const =0 |
| Returns "folder" or "zip" if the media path is to a folder or a zip. | |
| virtual bool | loadConfigFromIni ()=0 |
| Loads the config file. | |
| virtual bool | saveChanges ()=0 |
| Writes changes from memory into the file. | |
| virtual void | setAntiAlias (bool)=0 |
| Sets whether Anti Aliasing should be used or not. | |
| virtual void | setAudioDeviceType (E_AUDIO_DEVICE)=0 |
| Sets new audio device. | |
| virtual void | setBitsPerPixel (u32)=0 |
| Sets new amount of bits per pixel. | |
| virtual void | setDriverType (E_DRIVER_TYPE)=0 |
| Sets new driver. | |
| virtual void | setFullscreen (bool)=0 |
| Sets new full-screen mode. | |
| virtual void | setHighPrecisionFPU (bool)=0 |
| Sets whether high precision FPU should be used or not. | |
| virtual void | setMainFontFileName (c8 *)=0 |
| Sets the file name of the main font. | |
| virtual void | setMediaArchivePath (c8 *)=0 |
| Sets the path to the media. | |
| virtual void | setMediaFolderOrZip (c8 *)=0 |
| virtual void | setSDeviceParam (const SIrrlichtCreationParameters &)=0 |
| Sets the SIrrlichtCreationParameters for efficiency purpose. | |
| virtual void | setStencilbuffer (bool)=0 |
| Sets whether shadows are on or off. | |
| virtual void | setVsync (bool)=0 |
| Sets whether vertical retrace is on or off. | |
| virtual void | setWindowSize (const s32, const s32)=0 |
| Sets new device dimnesion. | |
| virtual | ~IConfigManager () |
| Destructor. | |
Detailed Description
Interface for loading/saving configuration files.The setters are to be used before saving a file if one wants to make changes for next device creation, then save.
Definition at line 28 of file IConfigManager.hpp.
Constructor & Destructor Documentation
| virtual nge::core::IConfigManager::~IConfigManager | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual bool nge::core::IConfigManager::createEmptyIniFile | ( | E_DRIVER_TYPE | DriverType, | |
| E_AUDIO_DEVICE | AudioDeviceType, | |||
| dimension2d< s32 > | WindowSize, | |||
| u32 | Bits, | |||
| bool | Fullscreen, | |||
| bool | Stencilbuffer, | |||
| bool | Vsync, | |||
| bool | AntiAlias, | |||
| bool | HighPrecisionFPU, | |||
| c8 * | MainFontFile, | |||
| c8 * | IsMediaFolderOrZip, | |||
| c8 * | MediaArchive | |||
| ) | [pure virtual] |
Creates a new config file with default values.
- See also:
- CConfigManager for default values
- Parameters:
-
DriverType : Which driver should be used WindowSize : What will be the device's dimensions Bits : How many BitsPerPixel will be used Fullscreen : Will device be in full-sceen Stencilbuffer : Will shadows be On or Off AntiAlias : Will Anti Aliasing be On or Off HighPrecisionFPU : This is only relevant for DirectX Devices, which switch to low FPU precision by default for performance reasons. However, this may lead to problems with the other computations of the application. In this case setting this flag to true should help - on the expense of performance loss, though.
- Returns:
- false if creation failed
| virtual bool nge::core::IConfigManager::getAntiAlias | ( | ) | const [pure virtual] |
Returns whether Anti Aliasing is on or off.
| virtual E_AUDIO_DEVICE nge::core::IConfigManager::getAudioDeviceType | ( | ) | const [pure virtual] |
Returns the audio device used.
| virtual u32 nge::core::IConfigManager::getBitsPerPixel | ( | ) | const [pure virtual] |
Returns how many bits are used per pixel.
| virtual bool nge::core::IConfigManager::getFullscreen | ( | ) | const [pure virtual] |
Returns whether the full-screen mode is on or off.
| virtual bool nge::core::IConfigManager::getHighPrecisionFPU | ( | ) | const [pure virtual] |
Returns whether high precision FPU is used or not.
| virtual stringc nge::core::IConfigManager::getIniFilePath | ( | ) | const [pure virtual] |
Returns the config file's path.
| virtual c8* nge::core::IConfigManager::getMainFontFileName | ( | ) | const [pure virtual] |
Returns the file name of the main font.
| virtual c8* nge::core::IConfigManager::getMediaArchivePath | ( | ) | const [pure virtual] |
Returns the path to the media.
| virtual SIrrlichtCreationParameters& nge::core::IConfigManager::getSDeviceParam | ( | ) | [pure virtual] |
Returns the SIrrlichtCreationParameters with the created device's data.
| virtual bool nge::core::IConfigManager::getStencilbuffer | ( | ) | const [pure virtual] |
Returns whether shadows are drawn or not.
| virtual E_DRIVER_TYPE nge::core::IConfigManager::getVideoDriverType | ( | ) | const [pure virtual] |
Returns the driver used (like Direct3D9 or OpenGL..).
| virtual bool nge::core::IConfigManager::getVsync | ( | ) | const [pure virtual] |
Returns whether vertical retrace is on or off.
| virtual dimension2di nge::core::IConfigManager::getWindowSize | ( | ) | const [pure virtual] |
Returns the dimension of the device.
| virtual c8* nge::core::IConfigManager::isMediaFolderOrZip | ( | ) | const [pure virtual] |
Returns "folder" or "zip" if the media path is to a folder or a zip.
| virtual bool nge::core::IConfigManager::loadConfigFromIni | ( | ) | [pure virtual] |
Loads the config file.
It loads it into the memory untill saved or application exits. When it loads the SIrrlichtCreationParameters member is filled with the data from the file which should be called with getSDeviceParam() when creating the device.
- Returns:
- false if loading failed
| virtual bool nge::core::IConfigManager::saveChanges | ( | ) | [pure virtual] |
Writes changes from memory into the file.
- Returns:
- false if current configurations could not be saved to hard-drive
| virtual void nge::core::IConfigManager::setAntiAlias | ( | bool | ) | [pure virtual] |
Sets whether Anti Aliasing should be used or not.
| virtual void nge::core::IConfigManager::setAudioDeviceType | ( | E_AUDIO_DEVICE | ) | [pure virtual] |
Sets new audio device.
| virtual void nge::core::IConfigManager::setBitsPerPixel | ( | u32 | ) | [pure virtual] |
Sets new amount of bits per pixel.
| virtual void nge::core::IConfigManager::setDriverType | ( | E_DRIVER_TYPE | ) | [pure virtual] |
Sets new driver.
| virtual void nge::core::IConfigManager::setFullscreen | ( | bool | ) | [pure virtual] |
Sets new full-screen mode.
| virtual void nge::core::IConfigManager::setHighPrecisionFPU | ( | bool | ) | [pure virtual] |
Sets whether high precision FPU should be used or not.
| virtual void nge::core::IConfigManager::setMainFontFileName | ( | c8 * | ) | [pure virtual] |
Sets the file name of the main font.
| virtual void nge::core::IConfigManager::setMediaArchivePath | ( | c8 * | ) | [pure virtual] |
Sets the path to the media.
| virtual void nge::core::IConfigManager::setMediaFolderOrZip | ( | c8 * | ) | [pure virtual] |
| virtual void nge::core::IConfigManager::setSDeviceParam | ( | const SIrrlichtCreationParameters & | ) | [pure virtual] |
Sets the SIrrlichtCreationParameters for efficiency purpose.
| virtual void nge::core::IConfigManager::setStencilbuffer | ( | bool | ) | [pure virtual] |
Sets whether shadows are on or off.
| virtual void nge::core::IConfigManager::setVsync | ( | bool | ) | [pure virtual] |
Sets whether vertical retrace is on or off.
| virtual void nge::core::IConfigManager::setWindowSize | ( | const | s32, | |
| const | s32 | |||
| ) | [pure virtual] |
Sets new device dimnesion.
The documentation for this class was generated from the following file:
