#include <AppScreenSaver.h>
Public Member Functions | |
Settings () | |
void | enableSecondaryDisplayBlanking (bool enable=true) |
When enabled, secondary displays are blanked (rendered as black) rather than issued draw() calls. Disabled by default on Mac OS X, enabled by default on MSW. More... | |
bool | isSecondaryDisplayBlankingEnabled () const |
Returns whether secondary displays will be blanked (rendered as black) rather than issued draw() calls. Disabled by default on Mac OS X, enabled by default on MSW. More... | |
void | enableDebug (bool enable=true) |
Prevents the screensaver from quitting in response to anything but clicks in its window, and from being the top-most window. Currenty ignored on Mac. More... | |
bool | isDebugEnabled () const |
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... | |
Protected Attributes | |
bool | mEnableSecondaryDisplayBlanking |
bool | mEnableDebug |
bool | mShouldQuit |
std::vector< Window::Format > | mWindowFormats |
Window::Format | mDefaultWindowFormat |
bool | mFrameRateEnabled |
float | mFrameRate |
bool | mPowerManagement |
bool | mEnableHighDensityDisplay |
bool | mEnableMultiTouch |
std::string | mTitle |
cinder::app::AppScreenSaver::Settings::Settings | ( | ) |
void cinder::app::AppScreenSaver::Settings::enableSecondaryDisplayBlanking | ( | bool | enable = true | ) |
When enabled, secondary displays are blanked (rendered as black) rather than issued draw() calls. Disabled by default on Mac OS X, enabled by default on MSW.
bool cinder::app::AppScreenSaver::Settings::isSecondaryDisplayBlankingEnabled | ( | ) | const |
Returns whether secondary displays will be blanked (rendered as black) rather than issued draw() calls. Disabled by default on Mac OS X, enabled by default on MSW.
void cinder::app::AppScreenSaver::Settings::enableDebug | ( | bool | enable = true | ) |
Prevents the screensaver from quitting in response to anything but clicks in its window, and from being the top-most window. Currenty ignored on Mac.
bool cinder::app::AppScreenSaver::Settings::isDebugEnabled | ( | ) | const |
|
inherited |
Sets the size of the default window measured in pixels.
Sets the size of the default window measured in pixels.
|
inherited |
Gets the size of the default window measured in pixels.
|
inherited |
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.
|
inherited |
Returns whether a non-default window position has been requested.
|
inherited |
Marks the window position setting as unspecified, effectively requesting the default.
|
inherited |
Returns whether the default window is fullscreen.
|
inherited |
Sets whether the default window is fullscreen at startup with FullScreenOptions options. Kiosk Mode is enabled by default.
|
inherited |
Returns whether the default window is resizable.
|
inherited |
Sets the default window to be resizable or not.
|
inherited |
Returns whether the default window will be created without a border (chrome/frame)
|
inherited |
Sets the default window to be created without a border (chrome/frame)
|
inherited |
Returns whether the default window always remains above all other windows.
|
inherited |
Sets whether the default window always remains above all other windows.
|
inherited |
Returns the display for the default window.
|
inherited |
Sets the display for the default window.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
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.
|
inherited |
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.
|
inherited |
Returns the Window::Format which will be used if no calls are made to Settings::prepareWindow()
|
inherited |
Sets the Window::Format which will be used if no calls are made to Settings::prepareWindow()
|
inherited |
Registers the app to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile.
|
inherited |
Returns whether the app is registered to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile.
|
inherited |
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
|
inherited |
is power management enabled, allowing screensavers and the system's power management to hide the application
|
inherited |
the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)
|
inherited |
the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)
|
inherited |
Sets maximum frameRate the update/draw loop will execute at, specified in frames per second. FrameRate limiting is on by default, at 60 FPS.
|
inherited |
Disables the frameRate limiting, which is on by default. Restore using setFrameRate(). See also enableVerticalSync().
|
inherited |
Returns whether frameRate limiting is enabled. On by default, at 60 FPS.
|
inherited |
maximum frameRate of the application specified in frames per second
|
protected |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |