Public Member Functions | Protected Attributes | Friends
cinder::app::App::Settings Class Reference

#import <App.h>

List of all members.

Public Member Functions

(bool) - isPrepared
(void) - setWindowSize
 Sets the size of the default window measured in pixels.
(void) - setWindowSize
 Sets the size of the default window measured in pixels.
(Vec2i- getWindowSize
 Gets the size of the default window measured in pixels.
(Vec2i- getWindowPos
 Returns the position of the default window in screen coordinates measured in pixels.
(void) - setWindowPos
 Sets the position of the default window in screen coordinates measured in pixels.
(void) - setWindowPos
 Sets the position of the default window in screen coordinates measured in pixels.
(bool) - isWindowPosSpecified
 Returns whether a non-default window position has been requested.
(void) - unspecifyWindowPos
 Marks the window position setting as unspecified, effectively requesting the default.
(bool) - isFullScreen
 Returns whether the default window is fullscreen.
(void) - setFullScreen
 Sets whether the default window is fullscreen at startup with FullScreenOptions options. Kiosk Mode is enabled by default.
(bool) - isResizable
 Returns whether the default window is resizable.
(void) - setResizable
 Sets the default window to be resizable or not.
(bool) - isBorderless
 Returns whether the default window will be created without a border (chrome/frame)
(void) - setBorderless
 Sets the default window to be created without a border (chrome/frame)
(bool) - isAlwaysOnTop
 Returns whether the default window always remains above all other windows.
(void) - setAlwaysOnTop
 Sets whether the default window always remains above all other windows.
(DisplayRef- getDisplay
 Returns the display for the default window.
(void) - setDisplay
 Sets the display for the default window.
(void) - prepareWindow
(std::vector< Window::Format > &) - getWindowFormats
(const std::vector
< Window::Format > &) 
- getWindowFormats
(void) - enableHighDensityDisplay
 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) - isHighDensityDisplayEnabled
 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) - getDefaultWindowFormat
 Returns the Window::Format which will be used if no calls are made to prepareWindow
(void) - setDefaultWindowFormat
 Sets the Window::Format which will be used if no calls are made to prepareWindow
(void) - enableMultiTouch
 Registers the app to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile.
(bool) - isMultiTouchEnabled
 Returns whether the app is registered to receive multiTouch events from the operating system. Disabled by default on desktop platforms, enabled on mobile.
(void) - enablePowerManagement
 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) - isPowerManagementEnabled
 is power management enabled, allowing screensavers and the system's power management to hide the application
(const std::string &) - getTitle
 the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)
(void) - setTitle
 the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)
(void) - setFrameRate
 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) - disableFrameRate
 Disables the frameRate limiting, which is on by default. Restore using setFrameRate. See also enableVerticalSync().
(bool) - isFrameRateEnabled
 Returns whether frameRate limiting is enabled. On by default, at 60 FPS.
(float) - getFrameRate
 maximum frameRate of the application specified in frames per second
() - 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

Constructor & Destructor Documentation

- cinder:
- (virtual) app:

Member Function Documentation

- (bool) app: const
- (void) app: (int)  windowSizeX
(int)  windowSizeY 

Sets the size of the default window measured in pixels.

- (void) app: (const Vec2i &)  size

Sets the size of the default window measured in pixels.

- (Vec2i) app: const

Gets the size of the default window measured in pixels.

- (Vec2i) app: const

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

- (void) app: (int)  windowPosX
(int)  windowPosY 

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

- (void) app: (const Vec2i &)  windowPos

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

- (bool) app: const

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

- (void) app:

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

- (bool) app:

Returns whether the default window is fullscreen.

- (void) app: (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) app: const

Returns whether the default window is resizable.

- (void) app: (bool)  resizable = true

Sets the default window to be resizable or not.

- (bool) app: const

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

- (void) app: (bool)  borderless = true

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

- (bool) app: const

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

- (void) app: (bool)  alwaysOnTop = true

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

- (DisplayRef) app: const

Returns the display for the default window.

- (void) app: (DisplayRef display

Sets the display for the default window.

- (void) app: (const Window::Format &)  format
- std:
- (const vector<)Window: const
- (void) app: (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) app: 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: const

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

- (void) app: (const Window::Format &)  format

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

- (void) app: (bool)  enable = true

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

- (bool) app: 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) app: (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) app: const

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

- (const string&) cinder: const

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

- (void) app: (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) app: (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) app:

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

- (bool) app: const

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

- (float) app: const

maximum frameRate of the application specified in frames per second


Friends And Related Function Documentation

- (friend class) App [friend]

Member Data Documentation

- (bool) app: [protected]
- std: [protected]
- Window: [protected]
- (bool) app: [protected]
- (float) app: [protected]
- (bool) app: [protected]
- (bool) app: [protected]
- (bool) app: [protected]
- std: [protected]

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