#include <App.h>
Public Member Functions | |
bool | isPrepared () const |
void | setWindowSize (int windowSizeX, int windowSizeY) |
Sets the size of the default window measured in pixels. More... | |
void | setWindowSize (const Vec2i &size) |
Sets the size of the default window measured in pixels. More... | |
Vec2i | getWindowSize () const |
Gets the size of the default window measured in pixels. More... | |
Vec2i | getWindowPos () const |
Returns the position of the default window in screen coordinates measured in pixels. More... | |
void | setWindowPos (int windowPosX, int windowPosY) |
Sets the position of the default window in screen coordinates measured in pixels. More... | |
void | setWindowPos (const Vec2i &windowPos) |
Sets the position of the default window in screen coordinates measured in pixels. More... | |
bool | isWindowPosSpecified () const |
Returns whether a non-default window position has been requested. More... | |
void | unspecifyWindowPos () |
Marks the window position setting as unspecified, effectively requesting the default. More... | |
bool | isFullScreen () |
Returns whether the default window is fullscreen. More... | |
void | setFullScreen (bool fullScreen=true, const FullScreenOptions &options=FullScreenOptions()) |
Sets whether the default window is fullscreen at startup with FullScreenOptions options. Kiosk Mode is enabled by default. More... | |
bool | isResizable () const |
Returns whether the default window is resizable. More... | |
void | setResizable (bool resizable=true) |
Sets the default window to be resizable or not. More... | |
bool | isBorderless () const |
Returns whether the default window will be created without a border (chrome/frame) More... | |
void | setBorderless (bool borderless=true) |
Sets the default window to be created without a border (chrome/frame) More... | |
bool | isAlwaysOnTop () const |
Returns whether the default window always remains above all other windows. More... | |
void | setAlwaysOnTop (bool alwaysOnTop=true) |
Sets whether the default window always remains above all other windows. More... | |
DisplayRef | getDisplay () const |
Returns the display for the default window. More... | |
void | setDisplay (DisplayRef display) |
Sets the display for the default window. More... | |
void | prepareWindow (const Window::Format &format) |
std::vector< Window::Format > & | getWindowFormats () |
const std::vector < Window::Format > & | getWindowFormats () const |
void | enableHighDensityDisplay (bool enable=true) |
Sets whether Windows created on a high-density (Retina) display will have their resolution doubled. Default is true on iOS and false on other platforms. More... | |
bool | isHighDensityDisplayEnabled () const |
Returns whether Windows created on a high-density (Retina) display will have their resolution doubled. Default is true on iOS and false on other platforms. More... | |
Window::Format | getDefaultWindowFormat () const |
Returns the Window::Format which will be used if no calls are made to Settings::prepareWindow() More... | |
void | setDefaultWindowFormat (const Window::Format &format) |
Sets the Window::Format which will be used if no calls are made to Settings::prepareWindow() More... | |
void | enableMultiTouch (bool enable=true) |
Registers the app to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile. More... | |
bool | isMultiTouchEnabled () const |
Returns whether the app is registered to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile. More... | |
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 on desktop, and true on mobile More... | |
bool | isPowerManagementEnabled () const |
is power management enabled, allowing screensavers and the system's power management to hide the application More... | |
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) More... | |
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) More... | |
void | setFrameRate (float frameRate) |
Sets maximum frameRate the update/draw loop will execute at, specified in frames per second. FrameRate limiting is on by default, at 60 FPS. More... | |
void | disableFrameRate () |
Disables the frameRate limiting, which is on by default. Restore using setFrameRate(). See also enableVerticalSync(). More... | |
bool | isFrameRateEnabled () const |
Returns whether frameRate limiting is enabled. On by default, at 60 FPS. More... | |
float | getFrameRate () const |
maximum frameRate of the application specified in frames per second More... | |
Settings () | |
virtual | ~Settings () |
Protected Attributes | |
bool | mShouldQuit |
std::vector< Window::Format > | mWindowFormats |
Window::Format | mDefaultWindowFormat |
bool | mFrameRateEnabled |
float | mFrameRate |
bool | mPowerManagement |
bool | mEnableHighDensityDisplay |
bool | mEnableMultiTouch |
std::string | mTitle |
Friends | |
class | App |
cinder::app::App::Settings::Settings | ( | ) |
|
virtual |
bool cinder::app::App::Settings::isPrepared | ( | ) | const |
Sets the size of the default window measured in pixels.
Sets the size of the default window measured in pixels.
Vec2i cinder::app::App::Settings::getWindowSize | ( | ) | const |
Gets the size of the default window measured in pixels.
Vec2i cinder::app::App::Settings::getWindowPos | ( | ) | const |
Returns the position of the default window in screen coordinates measured in pixels.
Sets the position of the default window in screen coordinates measured in pixels.
Sets the position of the default window in screen coordinates measured in pixels.
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::isFullScreen | ( | ) |
Returns whether the default window is fullscreen.
void cinder::app::App::Settings::setFullScreen | ( | bool | fullScreen = true , |
const FullScreenOptions & | options = FullScreenOptions() |
||
) |
Sets whether the default window is fullscreen at startup with FullScreenOptions options. Kiosk Mode is enabled by default.
bool cinder::app::App::Settings::isResizable | ( | ) | const |
Returns whether the default window is resizable.
void cinder::app::App::Settings::setResizable | ( | bool | resizable = true | ) |
Sets the default window to be resizable or not.
bool cinder::app::App::Settings::isBorderless | ( | ) | const |
Returns whether the default window will be created without a border (chrome/frame)
void cinder::app::App::Settings::setBorderless | ( | bool | borderless = true | ) |
Sets the default window to be created without a border (chrome/frame)
bool cinder::app::App::Settings::isAlwaysOnTop | ( | ) | const |
Returns whether the default window always remains above all other windows.
void cinder::app::App::Settings::setAlwaysOnTop | ( | bool | alwaysOnTop = true | ) |
Sets whether the default window always remains above all other windows.
DisplayRef cinder::app::App::Settings::getDisplay | ( | ) | const |
Returns the display for the default window.
void cinder::app::App::Settings::setDisplay | ( | DisplayRef | display | ) |
Sets the display for the default window.
void cinder::app::App::Settings::prepareWindow | ( | const Window::Format & | format | ) |
std::vector<Window::Format>& cinder::app::App::Settings::getWindowFormats | ( | ) |
const std::vector<Window::Format>& cinder::app::App::Settings::getWindowFormats | ( | ) | const |
void cinder::app::App::Settings::enableHighDensityDisplay | ( | bool | enable = true | ) |
Sets whether Windows created on a high-density (Retina) display will have their resolution doubled. Default is true
on iOS and false
on other platforms.
bool cinder::app::App::Settings::isHighDensityDisplayEnabled | ( | ) | const |
Returns whether Windows created on a high-density (Retina) display will have their resolution doubled. Default is true
on iOS and false
on other platforms.
Window::Format cinder::app::App::Settings::getDefaultWindowFormat | ( | ) | const |
Returns the Window::Format which will be used if no calls are made to Settings::prepareWindow()
void cinder::app::App::Settings::setDefaultWindowFormat | ( | const Window::Format & | format | ) |
Sets the Window::Format which will be used if no calls are made to Settings::prepareWindow()
void cinder::app::App::Settings::enableMultiTouch | ( | bool | enable = true | ) |
Registers the app to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile.
bool cinder::app::App::Settings::isMultiTouchEnabled | ( | ) | const |
Returns whether the app is registered to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile.
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
on desktop, and true
on mobile
bool cinder::app::App::Settings::isPowerManagementEnabled | ( | ) | const |
is power management enabled, allowing screensavers and the system's power management to hide the application
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)
void cinder::app::App::Settings::setFrameRate | ( | float | frameRate | ) |
Sets maximum frameRate the update/draw loop will execute at, specified in frames per second. FrameRate limiting is on by default, at 60 FPS.
void cinder::app::App::Settings::disableFrameRate | ( | ) |
Disables the frameRate limiting, which is on by default. Restore using setFrameRate(). See also enableVerticalSync().
bool cinder::app::App::Settings::isFrameRateEnabled | ( | ) | const |
Returns whether frameRate limiting is enabled. On by default, at 60 FPS.
float cinder::app::App::Settings::getFrameRate | ( | ) | const |
maximum frameRate of the application specified in frames per second
|
friend |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |