#include <App.h>
Inherited by cinder::app::AppBasic::Settings, cinder::app::AppCinderView::Settings, cinder::app::AppCocoaTouch::Settings, and cinder::app::AppScreenSaver::Settings.
Public Member Functions | |
bool | isPrepared () const |
void | setWindowSize (int aWindowSizeX, int aWindowSizeY) |
width and height of the window when applicable | |
void | setWindowPos (int windowPositionX, int windowPositionY) |
Sets the position of the window on the screen. | |
void | setWindowPos (const Vec2i &windowPos) |
Sets the position of the window on the screen. | |
bool | isWindowPosSpecified () const |
Returns whether a non-default window position has been requested. | |
void | unspecifyWindowPos () |
Marks the window position setting as unspecified, effectively requesting the default. | |
bool | isBorderless () const |
Returns whether the window will be created without a border (chrome/frame). | |
void | setBorderless (bool borderless=true) |
Sets the window to be created without a border (chrome/frame). | |
bool | isAlwaysOnTop () const |
Returns whether the window always remains above all other windows. | |
void | setAlwaysOnTop (bool alwaysOnTop=true) |
Sets whether the window always remains above all other windows. | |
void | setFrameRate (float aFrameRate) |
The maximum frameRate the update/draw loop will execute at, specified in frames per second. Default value is 30 FPS. | |
void | enablePowerManagement (bool aPowerManagement=true) |
a value of true allows screensavers or the system's power management to hide the app. Default value is false . | |
bool | isFullScreen () const |
is the application set to run at fullscreen | |
int | getWindowWidth () const |
width of the application's window specified in pixels | |
int | getWindowHeight () const |
height of the application's window specified in pixels | |
Vec2i | getWindowSize () const |
width and height of the application's window specified in pixels | |
Area | getWindowBounds () const |
the size of the application's window specified in pixels. | |
int | getWindowPosX () const |
Returns the position of the window in pixels on screen from left in pixels. | |
int | getWindowPosY () const |
Returns the position of the window on screen from top in pixels. | |
Vec2i | getWindowPos () const |
Returns the position of the window on screen in pixels. | |
const std::string & | getTitle () const |
the title of the app reflected in ways particular to the app type and platform (such as its Window or menu) | |
void | setTitle (const std::string &title) |
the title of the app reflected in ways particular to the app type and platform (such as its Window or menu) | |
float | getFrameRate () const |
maximum frameRate of the application specified in frames per second | |
bool | isResizable () const |
are users allowed to resize the window | |
bool | getPowerManagement () const |
is power management enabled, allowing screensavers and the system's power management to hide the application | |
Protected Member Functions | |
Settings () | |
virtual | ~Settings () |
Protected Attributes | |
bool | mShouldQuit |
int | mWindowSizeX |
int | mWindowSizeY |
bool | mWindowPosSpecified |
int | mWindowPositionX |
int | mWindowPositionY |
bool | mFullScreen |
float | mFrameRate |
bool | mResizable |
bool | mBorderless |
bool | mAlwaysOnTop |
bool | mPowerManagement |
std::string | mTitle |
cinder::app::App::Settings::Settings | ( | ) | [protected] |
virtual cinder::app::App::Settings::~Settings | ( | ) | [protected, virtual] |
bool cinder::app::App::Settings::isPrepared | ( | ) | const |
void cinder::app::App::Settings::setWindowSize | ( | int | aWindowSizeX, | |
int | aWindowSizeY | |||
) |
width and height of the window when applicable
void cinder::app::App::Settings::setWindowPos | ( | int | windowPositionX, | |
int | windowPositionY | |||
) |
Sets the position of the window on the screen.
void cinder::app::App::Settings::setWindowPos | ( | const Vec2i & | windowPos | ) |
Sets the position of the window on the screen.
bool cinder::app::App::Settings::isWindowPosSpecified | ( | ) | const |
Returns whether a non-default window position has been requested.
void cinder::app::App::Settings::unspecifyWindowPos | ( | ) |
Marks the window position setting as unspecified, effectively requesting the default.
bool cinder::app::App::Settings::isBorderless | ( | ) | const |
Returns whether the window will be created without a border (chrome/frame).
void cinder::app::App::Settings::setBorderless | ( | bool | borderless = true |
) |
Sets the window to be created without a border (chrome/frame).
bool cinder::app::App::Settings::isAlwaysOnTop | ( | ) | const |
Returns whether the window always remains above all other windows.
void cinder::app::App::Settings::setAlwaysOnTop | ( | bool | alwaysOnTop = true |
) |
Sets whether the window always remains above all other windows.
void cinder::app::App::Settings::setFrameRate | ( | float | aFrameRate | ) |
The maximum frameRate the update/draw loop will execute at, specified in frames per second. Default value is 30 FPS.
void cinder::app::App::Settings::enablePowerManagement | ( | bool | aPowerManagement = true |
) |
a value of true allows screensavers or the system's power management to hide the app. Default value is false
.
bool cinder::app::App::Settings::isFullScreen | ( | ) | const |
is the application set to run at fullscreen
int cinder::app::App::Settings::getWindowWidth | ( | ) | const |
width of the application's window specified in pixels
int cinder::app::App::Settings::getWindowHeight | ( | ) | const |
height of the application's window specified in pixels
Vec2i cinder::app::App::Settings::getWindowSize | ( | ) | const |
width and height of the application's window specified in pixels
Area cinder::app::App::Settings::getWindowBounds | ( | ) | const |
the size of the application's window specified in pixels.
int cinder::app::App::Settings::getWindowPosX | ( | ) | const |
Returns the position of the window in pixels on screen from left in pixels.
int cinder::app::App::Settings::getWindowPosY | ( | ) | const |
Returns the position of the window on screen from top in pixels.
Vec2i cinder::app::App::Settings::getWindowPos | ( | ) | const |
Returns the position of the window on screen in pixels.
const std::string& cinder::app::App::Settings::getTitle | ( | ) | const |
the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)
void cinder::app::App::Settings::setTitle | ( | const std::string & | title | ) |
the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)
float cinder::app::App::Settings::getFrameRate | ( | ) | const |
maximum frameRate of the application specified in frames per second
bool cinder::app::App::Settings::isResizable | ( | ) | const |
are users allowed to resize the window
bool cinder::app::App::Settings::getPowerManagement | ( | ) | const |
is power management enabled, allowing screensavers and the system's power management to hide the application
bool cinder::app::App::Settings::mShouldQuit [protected] |
int cinder::app::App::Settings::mWindowSizeX [protected] |
int cinder::app::App::Settings::mWindowSizeY [protected] |
bool cinder::app::App::Settings::mWindowPosSpecified [protected] |
int cinder::app::App::Settings::mWindowPositionX [protected] |
int cinder::app::App::Settings::mWindowPositionY [protected] |
bool cinder::app::App::Settings::mFullScreen [protected] |
float cinder::app::App::Settings::mFrameRate [protected] |
bool cinder::app::App::Settings::mResizable [protected] |
bool cinder::app::App::Settings::mBorderless [protected] |
bool cinder::app::App::Settings::mAlwaysOnTop [protected] |
bool cinder::app::App::Settings::mPowerManagement [protected] |
std::string cinder::app::App::Settings::mTitle [protected] |