CYIFrameworkConfiguration is used to specify configuration settings for the CYIFramework class.
To configure CYIFramework, pass a configured instance of this class to CYIFramework::SetFrameworkConfiguration().
#include <framework/YiFrameworkConfiguration.h>
| CYIFrameworkConfiguration::CYIFrameworkConfiguration |
( |
| ) |
|
| virtual CYIFrameworkConfiguration::~CYIFrameworkConfiguration |
( |
| ) |
|
|
virtual |
| uint16_t CYIFrameworkConfiguration::GetFontAtlasSize |
( |
| ) |
const |
Returns the size of the font atlas in pixels.
\sa SetFontAtlasSize()
| uint16_t CYIFrameworkConfiguration::GetMaxFonts |
( |
| ) |
const |
Returns the maximum number of fonts to cache.
| bool CYIFrameworkConfiguration::IsAudioEngineEnabled |
( |
| ) |
const |
Get whether or not the Audio Engine will be enabled by this configuration. Default is true.
| void CYIFrameworkConfiguration::SetAudioEngineEnabled |
( |
bool |
bEnabled | ) |
|
Set whether to enable the Audio Engine or not. The default is true. If false, the Audio Engine won't be initialized, saving a small amount of memory and CPU time. Could be use if the app doesn't plan on playing sounds at all, or if it is using a third party audio engine.
- Note
- The Audio Engine is not responsible for playing audio from the video player. The audio in video player will still be heard even if the Audio Engine is not initialized.
| void CYIFrameworkConfiguration::SetFontAtlasSize |
( |
uint16_t |
uFontAtlasSize | ) |
|
Set the size of the font atlas in pixels.
The font atlas is a square texture. This will set both the width and height of the texture.
| void CYIFrameworkConfiguration::SetMaxFonts |
( |
uint16_t |
uMaxFonts | ) |
|
Sets the maximum number of fonts to cache. The default is 0, which will use the caching system's default value.
The documentation for this class was generated from the following file:
1.8.11