Display window description class. More...
#include <display_window_description.h>
Public Member Functions | |
Construction | |
DisplayWindowDescription () | |
Constructs a window description with default values. More... | |
DisplayWindowDescription (const std::string &title) | |
Constructs a window description with default values and a title. More... | |
DisplayWindowDescription (const std::string &title, const Rectf &position, bool client_area) | |
Constructs a window description with default values, a title and a position. More... | |
DisplayWindowDescription (const std::string &title, const Sizef &size, bool client_area) | |
Constructs a window description with default values, a title and a size. More... | |
DisplayWindowDescription (const Rectf &position, bool client_area) | |
Constructs a window description with default values and a position. More... | |
DisplayWindowDescription (const DisplayWindowDescription ©) | |
Constructs a DisplayWindowDescription. More... | |
DisplayWindowDescription | clone () const |
virtual | ~DisplayWindowDescription () |
Attributes | |
const std::string & | get_title () const |
Returns the window title stored in the description. More... | |
Sizef | get_size () const |
Returns the size of the window stored in description. More... | |
Rectf | get_position () const |
Returns the initial position of the window. More... | |
bool | get_position_client_area () const |
Returns if the client area is used for the initial position of the window. More... | |
bool | is_fullscreen () const |
Returns if window should be initially fullscreen. More... | |
int | get_flipping_buffers () const |
Returns the amount of flipping buffers to be created. More... | |
int | get_swap_interval () const |
Returns the swap interval to be used for the window. More... | |
bool | get_allow_resize () const |
Returns true if window should be resizeable. More... | |
int | get_bpp () const |
Returns the numbers of bytes per pixel in the window. More... | |
int | get_refresh_rate () const |
bool | is_layered () const |
Returns true if window is layered (black is transparent) More... | |
DisplayWindowHandle | get_handle () const |
bool | has_caption () const |
Returns true if a title bar is shown. More... | |
bool | has_sysmenu () const |
Returns true if the window has a window menu on its title bar. More... | |
bool | has_minimize_button () const |
Returns true if the window has a minimize button. More... | |
bool | has_maximize_button () const |
Returns true if the window has a maximize button. More... | |
bool | is_visible () const |
Returns true if the window is initially visible. More... | |
bool | is_topmost () const |
Returns true if the window should be placed above all non-topmost windows. More... | |
bool | has_no_activate () const |
Indicates if window is automatically activated or not. More... | |
bool | get_using_gui_window_cache () const |
Returns true if window from the window cache should be used. (GUI Only) More... | |
bool | has_drop_shadow () const |
Returns true if the window is drawn with a drop shadow effect. More... | |
DisplayWindow | get_owner () const |
Returns the window owning this one. More... | |
bool | get_tablet_context () const |
Returns true if a tablet context is to be created for the window. More... | |
int | get_depth_size () const |
Returns the minimum required depth buffer. More... | |
int | get_stencil_size () const |
Returns the minimum required stencil buffer. More... | |
int | get_fullscreen_monitor () const |
Returns the index of the monitor to go fullscreen on. See ScreenInfo. More... | |
bool | get_allow_screensaver () const |
Returns true if the screensaver is allowed. More... | |
bool | is_update_supported () const |
Returns true if DisplayWindow::update should be supported. More... | |
int | get_multisampling () const |
Returns the number of samples per pixel. More... | |
float | get_extend_frame_left () const |
float | get_extend_frame_top () const |
float | get_extend_frame_right () const |
float | get_extend_frame_bottom () const |
WindowType | get_type () const |
Operations | |
DisplayWindowDescription & | operator= (const DisplayWindowDescription ©) |
Copy assignment operator. More... | |
void | show_caption (bool value=true) |
Controls if a title bar (including frame) is shown or not. More... | |
void | show_sysmenu (bool value=true) |
Sets if the window has a window menu on its title bar. More... | |
void | show_minimize_button (bool value=true) |
Sets if the window has a minimize button. More... | |
void | show_maximize_button (bool value=true) |
Sets if the window has a maximize button. More... | |
void | set_visible (bool value=true) |
Toggles whether the window is created as initially visible. More... | |
void | set_topmost (bool value=true) |
Sets if the window should be placed above all non-topmost windows. More... | |
void | set_no_activate (bool value=true) |
Prevents window from being automatically activated. More... | |
void | set_drop_shadow (bool value=true) |
Enables a drop shadow effect on the window. More... | |
void | set_owner_window (const DisplayWindow &owner) |
Specifies another window which owns this one. More... | |
void | set_title (const std::string &title) |
Sets the title of the window. More... | |
void | set_size (const Sizef &size, bool client_area) |
Sets the size of the window (including window frame). More... | |
void | set_position (const Rectf &position, bool client_area) |
Sets the position of the window (including window frame). More... | |
void | set_fullscreen (bool fullscreen=true, int monitor=0) |
Makes the window initially fullscreen. More... | |
void | set_flipping_buffers (int num_buffers=2) |
Sets the amount of flipping buffers to be used. More... | |
void | set_swap_interval (int interval=-1) |
Sets the swap interval to be used for the window. More... | |
void | set_allow_resize (bool allow_resize=true) |
Sets if windows should be resizable. More... | |
void | set_bpp (int bpp) |
Sets the number of bytes per pixel. More... | |
void | set_refresh_rate (int refresh_rate) |
void | set_tablet_context (bool create) |
Sets to true if a tablet input context should be created for this window. More... | |
void | set_using_gui_window_cache (bool value) |
void | set_layered (bool layered) |
Creates a layered window (complex shaped window) More... | |
void | set_allow_screensaver (bool allow_screensaver=true) |
Allow the screensaver to appear. More... | |
void | set_handle (DisplayWindowHandle handle) |
void | set_depth_size (int value) |
Sets the minimum required depth buffer. More... | |
void | set_stencil_size (int value) |
Sets the minimum required stencil buffer. More... | |
void | set_update_supported (bool value) const |
Controls if DisplayWindow::update is supported. More... | |
void | set_multisampling (int value) |
Sets the number of samples per pixel. More... | |
void | set_extend_frame (float left, float top, float right, float bottom) |
void | set_type (WindowType type) |
Display window description class.
This class allows you to setup a more advanced description when creating a display window.