Cinder  0.9.1
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cinder::app::AppScreenSaver::Settings Class Reference

#include <AppScreenSaver.h>

Inherits cinder::app::AppBase::Settings.

Public Member Functions

 Settings ()
 
void enableSecondaryDisplayBlanking (bool enable=true)
 
bool isSecondaryDisplayBlankingEnabled () const
 
void enableDebug (bool enable=true)
 
bool isDebugEnabled () const
 
void setWindowSize (int windowSizeX, int windowSizeY)
 
void setWindowSize (const ivec2 &size)
 
ivec2 getWindowSize () const
 
ivec2 getWindowPos () const
 
void setWindowPos (int windowPosX, int windowPosY)
 
void setWindowPos (const ivec2 &windowPos)
 
bool isWindowPosSpecified () const
 
void setWindowPosUnspecified ()
 
void setQuitOnLastWindowCloseEnabled (bool enable=true)
 
bool isQuitOnLastWindowCloseEnabled () const
 
bool isFullScreen ()
 
void setFullScreen (bool fullScreen=true, const FullScreenOptions &options=FullScreenOptions())
 
bool isResizable () const
 
void setResizable (bool resizable=true)
 
bool isBorderless () const
 
void setBorderless (bool borderless=true)
 
bool isAlwaysOnTop () const
 
void setAlwaysOnTop (bool alwaysOnTop=true)
 
DisplayRef getDisplay () const
 
void setDisplay (DisplayRef display)
 
Window::Format getDefaultWindowFormat () const
 
void setDefaultWindowFormat (const Window::Format &format)
 
void setDefaultRenderer (const RendererRef &renderer)
 
RendererRef getDefaultRenderer () const
 
void prepareWindow (const Window::Format &format)
 
std::vector< Window::Format > & getWindowFormats ()
 
const std::vector< Window::Format > & getWindowFormats () const
 
const std::string & getTitle () const
 
void setTitle (const std::string &title)
 
void setHighDensityDisplayEnabled (bool enable=true)
 
bool isHighDensityDisplayEnabled () const
 
void setMultiTouchEnabled (bool enable=true)
 
bool isMultiTouchEnabled () const
 
void setPowerManagementEnabled (bool enable=true)
 
bool isPowerManagementEnabled () const
 
void setFrameRate (float frameRate)
 
void disableFrameRate ()
 
bool isFrameRateEnabled () const
 
float getFrameRate () const
 
const std::vector< std::string > & getCommandLineArgs () const
 
void setShouldQuit (bool shouldQuit=true)
 
bool getShouldQuit () const
 

Protected Member Functions

void init (const RendererRef &defaultRenderer, const char *title, int argc, char *const argv[])
 

Protected Attributes

bool mEnableSecondaryDisplayBlanking
 
bool mEnableDebug
 
std::vector< Window::FormatmWindowFormats
 
Window::Format mDefaultWindowFormat
 
RendererRef mDefaultRenderer
 
std::string mTitle
 
std::vector< std::string > mCommandLineArgs
 
bool mFrameRateEnabled
 
float mFrameRate
 
bool mPowerManagementEnabled
 
bool mHighDensityDisplayEnabled
 
bool mMultiTouchEnabled
 
bool mQuitOnLastWindowClose
 
bool mShouldQuit
 
friend AppBase
 

Constructor & Destructor Documentation

cinder::app::AppScreenSaver::Settings::Settings ( )

Member Function Documentation

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
void cinder::app::AppBase::Settings::setWindowSize ( int  windowSizeX,
int  windowSizeY 
)
inherited

Sets the size of the default window measured in pixels.

void cinder::app::AppBase::Settings::setWindowSize ( const ivec2 &  size)
inherited

Sets the size of the default window measured in pixels.

ivec2 cinder::app::AppBase::Settings::getWindowSize ( ) const
inherited

Gets the size of the default window measured in pixels.

ivec2 cinder::app::AppBase::Settings::getWindowPos ( ) const
inherited

Returns the position of the default window in screen coordinates measured in pixels.

void cinder::app::AppBase::Settings::setWindowPos ( int  windowPosX,
int  windowPosY 
)
inherited

Sets the position of the default window in screen coordinates measured in pixels.

void cinder::app::AppBase::Settings::setWindowPos ( const ivec2 &  windowPos)
inherited

Sets the position of the default window in screen coordinates measured in pixels.

bool cinder::app::AppBase::Settings::isWindowPosSpecified ( ) const
inherited

Returns whether a non-default window position has been requested.

void cinder::app::AppBase::Settings::setWindowPosUnspecified ( )
inherited

Marks the window position setting as unspecified, effectively requesting the default.

void cinder::app::AppBase::Settings::setQuitOnLastWindowCloseEnabled ( bool  enable = true)
inherited

Sets whether the app quits automatically when its last window is closed. Enabled by default.

bool cinder::app::AppBase::Settings::isQuitOnLastWindowCloseEnabled ( ) const
inherited

Returns whether the app quits automatically when its last window is closed. Enabled by default.

bool cinder::app::AppBase::Settings::isFullScreen ( )
inherited

Returns whether the default window is fullscreen.

void cinder::app::AppBase::Settings::setFullScreen ( bool  fullScreen = true,
const FullScreenOptions options = FullScreenOptions() 
)
inherited

Sets whether the default window is fullscreen at startup with FullScreenOptions options. Kiosk Mode is enabled by default.

bool cinder::app::AppBase::Settings::isResizable ( ) const
inherited

Returns whether the default window is resizable.

void cinder::app::AppBase::Settings::setResizable ( bool  resizable = true)
inherited

Sets the default window to be resizable or not.

bool cinder::app::AppBase::Settings::isBorderless ( ) const
inherited

Returns whether the default window will be created without a border (chrome/frame)

void cinder::app::AppBase::Settings::setBorderless ( bool  borderless = true)
inherited

Sets the default window to be created without a border (chrome/frame)

bool cinder::app::AppBase::Settings::isAlwaysOnTop ( ) const
inherited

Returns whether the default window always remains above all other windows.

void cinder::app::AppBase::Settings::setAlwaysOnTop ( bool  alwaysOnTop = true)
inherited

Sets whether the default window always remains above all other windows.

DisplayRef cinder::app::AppBase::Settings::getDisplay ( ) const
inherited

Returns the display for the default window.

void cinder::app::AppBase::Settings::setDisplay ( DisplayRef  display)
inherited

Sets the display for the default window.

Window::Format cinder::app::AppBase::Settings::getDefaultWindowFormat ( ) const
inherited

Returns the Window::Format which will be used if no calls are made to Settings::prepareWindow()

void cinder::app::AppBase::Settings::setDefaultWindowFormat ( const Window::Format format)
inherited

Sets the Window::Format which will be used if no calls are made to Settings::prepareWindow()

void cinder::app::AppBase::Settings::setDefaultRenderer ( const RendererRef renderer)
inherited

Sets the default Renderer, overridding what was passed in during app instanciation.

RendererRef cinder::app::AppBase::Settings::getDefaultRenderer ( ) const
inherited

Returns the default Renderer.

void cinder::app::AppBase::Settings::prepareWindow ( const Window::Format format)
inherited
std::vector<Window::Format>& cinder::app::AppBase::Settings::getWindowFormats ( )
inherited
const std::vector<Window::Format>& cinder::app::AppBase::Settings::getWindowFormats ( ) const
inherited
const std::string& cinder::app::AppBase::Settings::getTitle ( ) const
inherited

the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)

void cinder::app::AppBase::Settings::setTitle ( const std::string &  title)
inherited

the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)

void cinder::app::AppBase::Settings::setHighDensityDisplayEnabled ( bool  enable = true)
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.

bool cinder::app::AppBase::Settings::isHighDensityDisplayEnabled ( ) const
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.

void cinder::app::AppBase::Settings::setMultiTouchEnabled ( bool  enable = true)
inherited

Registers the app to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile.

bool cinder::app::AppBase::Settings::isMultiTouchEnabled ( ) const
inherited

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::AppBase::Settings::setPowerManagementEnabled ( bool  enable = true)
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

bool cinder::app::AppBase::Settings::isPowerManagementEnabled ( ) const
inherited

is power management enabled, allowing screensavers and the system's power management to hide the application

void cinder::app::AppBase::Settings::setFrameRate ( float  frameRate)
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.

void cinder::app::AppBase::Settings::disableFrameRate ( )
inherited

Disables the frameRate limiting, which is on by default. Restore using setFrameRate(). See also enableVerticalSync().

bool cinder::app::AppBase::Settings::isFrameRateEnabled ( ) const
inherited

Returns whether frameRate limiting is enabled. On by default, at 60 FPS.

float cinder::app::AppBase::Settings::getFrameRate ( ) const
inherited

Maximum frameRate of the application specified in frames per second.

const std::vector<std::string>& cinder::app::AppBase::Settings::getCommandLineArgs ( ) const
inherited

Returns the command line args passed to the application from its entry point (ex. a main's argc / argv).

void cinder::app::AppBase::Settings::setShouldQuit ( bool  shouldQuit = true)
inherited

Set this to true if the app should terminate prior to launching.

bool cinder::app::AppBase::Settings::getShouldQuit ( ) const
inherited

Whether or not the app should terminate prior to launching.

void cinder::app::AppBase::Settings::init ( const RendererRef defaultRenderer,
const char *  title,
int  argc,
char *const  argv[] 
)
protectedinherited

Member Data Documentation

bool cinder::app::AppScreenSaver::Settings::mEnableSecondaryDisplayBlanking
protected
bool cinder::app::AppScreenSaver::Settings::mEnableDebug
protected
std::vector<Window::Format> cinder::app::AppBase::Settings::mWindowFormats
protectedinherited
Window::Format cinder::app::AppBase::Settings::mDefaultWindowFormat
protectedinherited
RendererRef cinder::app::AppBase::Settings::mDefaultRenderer
protectedinherited
std::string cinder::app::AppBase::Settings::mTitle
protectedinherited
std::vector<std::string> cinder::app::AppBase::Settings::mCommandLineArgs
protectedinherited
bool cinder::app::AppBase::Settings::mFrameRateEnabled
protectedinherited
float cinder::app::AppBase::Settings::mFrameRate
protectedinherited
bool cinder::app::AppBase::Settings::mPowerManagementEnabled
protectedinherited
bool cinder::app::AppBase::Settings::mHighDensityDisplayEnabled
protectedinherited
bool cinder::app::AppBase::Settings::mMultiTouchEnabled
protectedinherited
bool cinder::app::AppBase::Settings::mQuitOnLastWindowClose
protectedinherited
bool cinder::app::AppBase::Settings::mShouldQuit
protectedinherited
friend cinder::app::AppBase::Settings::AppBase
protectedinherited

The documentation for this class was generated from the following file: