#include <Window.h>
Public Member Functions | |
Format (RendererRef renderer=RendererRef(), DisplayRef display=Display::getMainDisplay(), bool fullScreen=false, Vec2i size=Vec2i(640, 480), Vec2i pos=Vec2i::zero()) | |
DisplayRef | getDisplay () const |
Returns the Display the Window will be created on. Defaults to the primary display. More... | |
void | setDisplay (DisplayRef display) |
Sets the Display the Window will be created on. Defaults to the primary display. More... | |
Format & | display (DisplayRef displayRef) |
Sets the Display the Window will be created on. Defaults to the primary display. More... | |
bool | isFullScreen () const |
Returns whether the Window will be created full-screen. Default is false . More... | |
const FullScreenOptions & | getFullScreenOptions () const |
Returns the options associated with fullscreen at startup. More... | |
void | setFullScreen (bool fullScreen=true, const FullScreenOptions &options=FullScreenOptions()) |
Sets whether the Window will be created full-screen with FullScreenOptions options. Default is false . If true, FullScreenOptions mode defaults to kiosk. More... | |
Format & | fullScreen (bool fs=true) |
Sets whether the Window will be created full-screen. Default is false . More... | |
Vec2i | getSize () const |
Returns the size in points at which the Window will be created. Default is 640 x 480. More... | |
void | setSize (const Vec2i &size) |
Sets the size in points at which the Window will be created. Default is 640 x 480. More... | |
void | setSize (int32_t width, int32_t height) |
Sets the size in points at which the Window will be created. Default is 640 x 480. More... | |
Format & | size (const Vec2i &s) |
Sets the size in points at which the Window will be created. Default is 640 x 480. More... | |
Format & | size (int32_t width, int32_t height) |
Sets the size in points at which the Window will be created. Default is 640 x 480. More... | |
Vec2i | getPos () const |
Returns the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display. More... | |
void | setPos (const Vec2i &pos) |
Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display. More... | |
void | setPos (int32_t x, int32_t y) |
Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display. More... | |
Format & | pos (const Vec2i &pos) |
Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display. More... | |
Format & | pos (int32_t x, int32_t y) |
Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display. More... | |
bool | isPosSpecified () const |
Returns whether a non-default position has been requested for the Window. More... | |
void | unspecifyPos () |
Unspecifies a non-default position for the window, effectively requestion the default position. More... | |
RendererRef | getRenderer () const |
Returns the Renderer which will be instantiated for the Window. Defaults to an instance of the App's default renderer (specified in the app-instantiation macro). More... | |
void | setRenderer (RendererRef renderer) |
Sets the Renderer which will be instantiated for the Window. More... | |
Format & | renderer (RendererRef r) |
Sets the Renderer which will be instantiated for the Window. More... | |
bool | isResizable () const |
Returns whether the Window created will be resizable. Defaults to true . More... | |
void | setResizable (bool resizable=true) |
Sets whether the Window created will be resizable. Defaults to true . More... | |
Format & | resizable (bool res=true) |
Sets whether the Window created will be resizable. Defaults to true . More... | |
bool | isBorderless () const |
Returns whether the Window created will have no border. Defaults to false . More... | |
void | setBorderless (bool borderless=true) |
Sets whether the Window created will have no border. Defaults to false . More... | |
Format & | borderless (bool border=true) |
Sets whether the Window created will have no border. Defaults to false . More... | |
bool | isAlwaysOnTop () const |
Returns whether the Window created will always be above all other windows, including other applications' windows. Defaults to false . More... | |
void | setAlwaysOnTop (bool alwaysOnTop=true) |
Sets whether the Window created will always be above all other windows, including other applications' windows. Defaults to false . More... | |
Format & | alwaysOnTop (bool top=true) |
Sets whether the Window created will always be above all other windows, including other applications' windows. Defaults to false . More... | |
void | enableFullScreenButton (bool enabled=true) |
On Mac OS X enables the native full screen toggle button. Defaults to false . More... | |
Format & | fullScreenButton (bool enabled=true) |
On Mac OS X enables the native full screen toggle button. Defaults to false . More... | |
bool | isFullScreenButtonEnabled () const |
On Mac OS X returns whether the native full screen toggle button is displayed. Defaults to false . More... | |
std::string | getTitle () const |
Returns the title of the Window as a UTF-8 string. More... | |
void | setTitle (const std::string &title) |
Sets the title of the Window as a UTF-8 string. More... | |
Format & | title (const std::string &t) |
Sets the title of the Window as a UTF-8 string. More... | |
bool | isTitleSpecified () const |
Returns whether a non-default title has been requested for the Window. More... | |
void | unspecifyTitle () |
Unspecifies a non-default title for the window, effectively requestion the default title. More... | |
cinder::app::Window::Format::Format | ( | RendererRef | renderer = RendererRef() , |
DisplayRef | display = Display::getMainDisplay() , |
||
bool | fullScreen = false , |
||
Vec2i | size = Vec2i( 640, 480 ) , |
||
Vec2i | pos = Vec2i::zero() |
||
) |
DisplayRef cinder::app::Window::Format::getDisplay | ( | ) | const |
void cinder::app::Window::Format::setDisplay | ( | DisplayRef | display | ) |
Format& cinder::app::Window::Format::display | ( | DisplayRef | displayRef | ) |
bool cinder::app::Window::Format::isFullScreen | ( | ) | const |
Returns whether the Window will be created full-screen. Default is false
.
const FullScreenOptions& cinder::app::Window::Format::getFullScreenOptions | ( | ) | const |
Returns the options associated with fullscreen at startup.
void cinder::app::Window::Format::setFullScreen | ( | bool | fullScreen = true , |
const FullScreenOptions & | options = FullScreenOptions() |
||
) |
Sets whether the Window will be created full-screen with FullScreenOptions options. Default is false
. If true, FullScreenOptions mode defaults to kiosk.
Format& cinder::app::Window::Format::fullScreen | ( | bool | fs = true | ) |
Sets whether the Window will be created full-screen. Default is false
.
Vec2i cinder::app::Window::Format::getSize | ( | ) | const |
Returns the size in points at which the Window will be created. Default is 640 x 480.
Sets the size in points at which the Window will be created. Default is 640 x 480.
void cinder::app::Window::Format::setSize | ( | int32_t | width, |
int32_t | height | ||
) |
Sets the size in points at which the Window will be created. Default is 640 x 480.
Sets the size in points at which the Window will be created. Default is 640 x 480.
Format& cinder::app::Window::Format::size | ( | int32_t | width, |
int32_t | height | ||
) |
Sets the size in points at which the Window will be created. Default is 640 x 480.
Vec2i cinder::app::Window::Format::getPos | ( | ) | const |
Returns the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.
Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.
void cinder::app::Window::Format::setPos | ( | int32_t | x, |
int32_t | y | ||
) |
Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.
Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.
Format& cinder::app::Window::Format::pos | ( | int32_t | x, |
int32_t | y | ||
) |
Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.
bool cinder::app::Window::Format::isPosSpecified | ( | ) | const |
Returns whether a non-default position has been requested for the Window.
void cinder::app::Window::Format::unspecifyPos | ( | ) |
Unspecifies a non-default position for the window, effectively requestion the default position.
RendererRef cinder::app::Window::Format::getRenderer | ( | ) | const |
void cinder::app::Window::Format::setRenderer | ( | RendererRef | renderer | ) |
Format& cinder::app::Window::Format::renderer | ( | RendererRef | r | ) |
bool cinder::app::Window::Format::isResizable | ( | ) | const |
Returns whether the Window created will be resizable. Defaults to true
.
void cinder::app::Window::Format::setResizable | ( | bool | resizable = true | ) |
Sets whether the Window created will be resizable. Defaults to true
.
Format& cinder::app::Window::Format::resizable | ( | bool | res = true | ) |
Sets whether the Window created will be resizable. Defaults to true
.
bool cinder::app::Window::Format::isBorderless | ( | ) | const |
Returns whether the Window created will have no border. Defaults to false
.
void cinder::app::Window::Format::setBorderless | ( | bool | borderless = true | ) |
Sets whether the Window created will have no border. Defaults to false
.
Format& cinder::app::Window::Format::borderless | ( | bool | border = true | ) |
Sets whether the Window created will have no border. Defaults to false
.
bool cinder::app::Window::Format::isAlwaysOnTop | ( | ) | const |
Returns whether the Window created will always be above all other windows, including other applications' windows. Defaults to false
.
void cinder::app::Window::Format::setAlwaysOnTop | ( | bool | alwaysOnTop = true | ) |
Sets whether the Window created will always be above all other windows, including other applications' windows. Defaults to false
.
Format& cinder::app::Window::Format::alwaysOnTop | ( | bool | top = true | ) |
Sets whether the Window created will always be above all other windows, including other applications' windows. Defaults to false
.
void cinder::app::Window::Format::enableFullScreenButton | ( | bool | enabled = true | ) |
On Mac OS X enables the native full screen toggle button. Defaults to false
.
Format& cinder::app::Window::Format::fullScreenButton | ( | bool | enabled = true | ) |
On Mac OS X enables the native full screen toggle button. Defaults to false
.
bool cinder::app::Window::Format::isFullScreenButtonEnabled | ( | ) | const |
On Mac OS X returns whether the native full screen toggle button is displayed. Defaults to false
.
std::string cinder::app::Window::Format::getTitle | ( | ) | const |
Returns the title of the Window as a UTF-8 string.
void cinder::app::Window::Format::setTitle | ( | const std::string & | title | ) |
Sets the title of the Window as a UTF-8 string.
Format& cinder::app::Window::Format::title | ( | const std::string & | t | ) |
Sets the title of the Window as a UTF-8 string.
bool cinder::app::Window::Format::isTitleSpecified | ( | ) | const |
Returns whether a non-default title has been requested for the Window.
void cinder::app::Window::Format::unspecifyTitle | ( | ) |
Unspecifies a non-default title for the window, effectively requestion the default title.