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

#import <App.h>

Inherited by cinder::app::AppCocoaTouch::Settings.

List of all members.

Public Member Functions

(bool) - isPrepared
(void) - setWindowSize
 width and height of the window when applicable
(void) - setWindowPos
 Sets the position of the window on the screen.
(void) - setWindowPos
 Sets the position of the window on the screen.
(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) - isBorderless
 Returns whether the window will be created without a border (chrome/frame)
(void) - setBorderless
 Sets the window to be created without a border (chrome/frame)
(bool) - isAlwaysOnTop
 Returns whether the window always remains above all other windows.
(void) - setAlwaysOnTop
 Sets whether the window always remains above all other windows.
(void) - setFrameRate
 The maximum frameRate the update/draw loop will execute at, specified in frames per second. Default value is 30 FPS.
(void) - enablePowerManagement
 a value of true allows screensavers or the system's power management to hide the app. Default value is false.
(bool) - isFullScreen
 is the application set to run at fullscreen
(int) - getWindowWidth
 width of the application's window specified in pixels
(int) - getWindowHeight
 height of the application's window specified in pixels
(Vec2i- getWindowSize
 width and height of the application's window specified in pixels
(Area- getWindowBounds
 the size of the application's window specified in pixels.
(int) - getWindowPosX
 Returns the position of the window in pixels on screen from left in pixels.
(int) - getWindowPosY
 Returns the position of the window on screen from top in pixels.
(Vec2i- getWindowPos
 Returns the position of the window on screen in pixels.
(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)
(float) - getFrameRate
 maximum frameRate of the application specified in frames per second
(bool) - isResizable
 are users allowed to resize the window
(bool) - getPowerManagement
 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

Constructor & Destructor Documentation

- cinder:
- (virtual) app:

Member Function Documentation

- (bool) app: const
- (void) app: (int)  aWindowSizeX
(int)  aWindowSizeY 

width and height of the window when applicable

- (void) app: (int)  windowPositionX
(int)  windowPositionY 

Sets the position of the window on the screen.

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

Sets the position of the window on the screen.

- (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: const

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

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

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

- (bool) app: const

Returns whether the window always remains above all other windows.

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

Sets whether the window always remains above all other windows.

- (void) app: (float)  aFrameRate

The maximum frameRate the update/draw loop will execute at, specified in frames per second. Default value is 30 FPS.

- (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.

- (bool) app: const

is the application set to run at fullscreen

- (int) app: const

width of the application's window specified in pixels

- (int) app: const

height of the application's window specified in pixels

- (Vec2i) app: const

width and height of the application's window specified in pixels

- (Area) app: const

the size of the application's window specified in pixels.

Returns:
cinder::Area( 0, 0, width in pixels, height in pixels )
- (int) app: const

Returns the position of the window in pixels on screen from left in pixels.

- (int) app: const

Returns the position of the window on screen from top in pixels.

- (Vec2i) app: const

Returns the position of the window on screen in pixels.

- (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)

- (float) app: const

maximum frameRate of the application specified in frames per second

- (bool) app: const

are users allowed to resize the window

- (bool) app: const

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


Member Data Documentation

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

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