Classes | Enumerations | Variables
clanDisplay Window

## Classes
class | clan::Cursor
| Mouse cursor class. More...
class | clan::DisplayWindow
| Top-level window class. More...
class | clan::DisplayWindowDescription
| Display window description class. More...
struct | clan::DisplayWindowHandle

## Enumerations
enum | clan::StandardCursor { clan::StandardCursor::arrow, clan::StandardCursor::appstarting, clan::StandardCursor::cross, clan::StandardCursor::hand, clan::StandardCursor::ibeam, clan::StandardCursor::no, clan::StandardCursor::size_all, clan::StandardCursor::size_nesw, clan::StandardCursor::size_ns, clan::StandardCursor::size_nwse, clan::StandardCursor::size_we, clan::StandardCursor::uparrow, clan::StandardCursor::wait }
| Standard Cursor. More...
enum | clan::WindowType { clan::WindowType::normal, clan::WindowType::popup, clan::WindowType::tool, clan::WindowType::custom }

## Variables
::Display * | clan::DisplayWindowHandle::display = 0
::Window | clan::DisplayWindowHandle::window = 0

## Construction
| clan::Cursor::Cursor ()
| Constructs a null instance. More...
| clan::Cursor::Cursor (const DisplayWindow &window, const CursorDescription &cursor_description)
| Constructs a Cursor. More...

## Attributes
bool | clan::Cursor::is_null () const
| Returns true if this object is invalid. More...
void | clan::Cursor::throw_if_null () const
| Throw an exception if this object is invalid. More...
CursorProvider * | clan::Cursor::get_provider () const
| Returns the cursor provider. More...

## Construction
| clan::DisplayWindow::DisplayWindow ()
| Constructs a null instance. More...
| clan::DisplayWindow::DisplayWindow (const std::string &title, float width, float height, bool start_fullscreen=false, bool allow_resize=false, int flipping_buffers=2)
| Constructs a window. More...
| clan::DisplayWindow::DisplayWindow (const DisplayWindowDescription &description)
| Constructs a window. More...
| clan::DisplayWindow::DisplayWindow (DisplayWindowProvider *provider)
| Constructs a window. More...
| clan::DisplayWindow::~DisplayWindow ()

## Attributes
Rectf | clan::DisplayWindow::get_geometry () const
| Returns the position and size of the window frame. More...
Rectf | clan::DisplayWindow::get_viewport () const
| Returns the drawable area of the window (excluding window frame). More...
bool | clan::DisplayWindow::is_fullscreen () const
| Returns true if window is currently running fullscreen. More...
bool | clan::DisplayWindow::has_focus () const
| Returns true if window has focus. More...
GraphicContext & | clan::DisplayWindow::get_gc () const
| Return the graphic context for the window. More...
InputContext | clan::DisplayWindow::get_ic () const
| Return the input context for the window. More...
Signal< void()> & | clan::DisplayWindow::sig_lost_focus ()
| Signal emitted when window lost focus. More...
Signal< void()> & | clan::DisplayWindow::sig_got_focus ()
| Signal emitted when window gain focus. More...
Signal< void(float, float)> & | clan::DisplayWindow::sig_resize ()
| Signal emitted when window is resized. More...
Signal< void(const Rectf &)> & | clan::DisplayWindow::sig_paint ()
| Signal emitted when an area of the window is invalidated. More...
Signal< void()> & | clan::DisplayWindow::sig_window_close ()
| Signal emitted when window is closed. More...
Signal< void()> & | clan::DisplayWindow::sig_window_destroy ()
| Signal emitted when window is destroyed. More...
Signal< void()> & | clan::DisplayWindow::sig_window_minimized ()
| Signal emitted when window is minimized. More...
Signal< void()> & | clan::DisplayWindow::sig_window_maximized ()
| Signal emitted when window is maximized. More...
Signal< void()> & | clan::DisplayWindow::sig_window_restored ()
| Signal emitted when window is restored. More...
Signal< void()> & | clan::DisplayWindow::sig_window_moved ()
| Signal emitted after a window has been moved. More...
Signal< void()> & | clan::DisplayWindow::sig_window_flip ()
| Signal emitted when window flip() was called. More...
std::function< void(Rectf &)> & | clan::DisplayWindow::func_window_resize ()
| Callback called when a window is being resized. More...
std::function< bool()> & | clan::DisplayWindow::func_minimize_clicked ()
| Callback called when a window is asked to minimize itself. More...
bool | clan::DisplayWindow::is_null () const
| Returns true if this object is invalid. More...
void | clan::DisplayWindow::throw_if_null () const
| Throw an exception if this object is invalid. More...
bool | clan::DisplayWindow::is_visible () const
| returns true if this display window is visible More...
bool | clan::DisplayWindow::is_minimized () const
| Returns true if the window is minimized. More...
bool | clan::DisplayWindow::is_maximized () const
| Returns true if the window is maximized. More...
DisplayWindowProvider * | clan::DisplayWindow::get_provider () const
| Returns the display window provider. More...
bool | clan::DisplayWindow::is_clipboard_text_available () const
| Returns true if text is available in the clipboard. More...
bool | clan::DisplayWindow::is_clipboard_image_available () const
| Returns true if an image is available in the clipboard. More...
std::string | clan::DisplayWindow::get_clipboard_text () const
| Returns the text stored in the clipboard. More...
PixelBuffer | clan::DisplayWindow::get_clipboard_image () const
| Returns an image stored in the clipboard. More...
Sizef | clan::DisplayWindow::get_minimum_size (bool client_area=false)
| Returns the minimum size the window can be resized to by the application user. More...
Sizef | clan::DisplayWindow::get_maximum_size (bool client_area=false)
| Returns the maximum size the window can be resized to by the application user. More...
std::string | clan::DisplayWindow::get_title () const
| Returns the window title. More...
DisplayWindowHandle | clan::DisplayWindow::get_handle () const

## Operations
Pointf | clan::DisplayWindow::client_to_screen (const Pointf &client)
| Convert from window client coordinates to screen coordinates. More...
Pointf | clan::DisplayWindow::screen_to_client (const Pointf &screen)
| Convert from screen coordinates to client coordinates. More...
void | clan::DisplayWindow::capture_mouse (bool capture)
| Capture/Release the mouse. More...
void | clan::DisplayWindow::request_repaint (const Rectf &rect)
| Invalidates a region of a screen, causing a repaint. More...
void | clan::DisplayWindow::set_title (const std::string &title)
| Change window title. More...
void | clan::DisplayWindow::set_position (const Rectf &pos, bool client_area)
| Set window position and size. More...
void | clan::DisplayWindow::set_position (float x, float y)
| Set window position. More...
void | clan::DisplayWindow::set_enabled (bool enable)
| Set enabled. More...
void | clan::DisplayWindow::set_visible (bool visible, bool activate)
| Set visible. More...
void | clan::DisplayWindow::set_size (float width, float height, bool client_area)
| Resize window. More...
void | clan::DisplayWindow::set_minimum_size (float width, float height, bool client_area)
| Minimum size a window can be resized to by the application user. More...
void | clan::DisplayWindow::set_maximum_size (float width, float height, bool client_area)
| Maximum size a window can be resized to by the application user. More...
void | clan::DisplayWindow::minimize ()
| Minimizes the window. More...
void | clan::DisplayWindow::restore ()
| Restores the window. More...
void | clan::DisplayWindow::maximize ()
| Maximizes the window. More...
void | clan::DisplayWindow::show (bool activate=true)
| Displays the window in its current size and position. More...
void | clan::DisplayWindow::hide ()
| Hides the window. More...
void | clan::DisplayWindow::bring_to_front ()
| Raises the window on top of other windows. More...
void | clan::DisplayWindow::update (const Rectf &rect)
| Copy the specified rectangle area from back buffer to front buffer. More...
void | clan::DisplayWindow::flip (int interval=-1)
| Flip back buffer to front, making changes visible on screen. More...
void | clan::DisplayWindow::show_cursor ()
| Shows the mouse cursor. More...
void | clan::DisplayWindow::set_cursor (const Cursor &cursor)
| Sets the current cursor icon. More...
void | clan::DisplayWindow::set_cursor (StandardCursor type)
| Set cursor. More...
void | clan::DisplayWindow::hide_cursor ()
| Hides the mouse cursor. More...
void | clan::DisplayWindow::set_clipboard_text (const std::string &text)
| Stores text in the clipboard. More...
void | clan::DisplayWindow::set_clipboard_image (const PixelBuffer &buf)
| Stores an image in the clipboard. More...
void | clan::DisplayWindow::set_large_icon (const PixelBuffer &image)
| Sets the large icon used for this window. More...
void | clan::DisplayWindow::set_small_icon (const PixelBuffer &image)
| Sets the small icon used for this window. More...
void | clan::DisplayWindow::enable_alpha_channel (const Rectf &blur_rect)
| Enable alpha channel for this window. More...
void | clan::DisplayWindow::extend_frame_into_client_area (float left, float top, float right, float bottom)
| Exend the window frame into the client area. More...

## Construction
| clan::DisplayWindowDescription::DisplayWindowDescription ()
| Constructs a window description with default values. More...
| clan::DisplayWindowDescription::DisplayWindowDescription (const std::string &title)
| Constructs a window description with default values and a title. More...
| clan::DisplayWindowDescription::DisplayWindowDescription (const std::string &title, const Rectf &position, bool client_area)
| Constructs a window description with default values, a title and a position. More...
| clan::DisplayWindowDescription::DisplayWindowDescription (const std::string &title, const Sizef &size, bool client_area)
| Constructs a window description with default values, a title and a size. More...
| clan::DisplayWindowDescription::DisplayWindowDescription (const Rectf &position, bool client_area)
| Constructs a window description with default values and a position. More...
| clan::DisplayWindowDescription::DisplayWindowDescription (const DisplayWindowDescription &copy)
| Constructs a DisplayWindowDescription. More...
DisplayWindowDescription | clan::DisplayWindowDescription::clone () const
virtual | clan::DisplayWindowDescription::~DisplayWindowDescription ()

## Attributes
const std::string & | clan::DisplayWindowDescription::get_title () const
| Returns the window title stored in the description. More...
Sizef | clan::DisplayWindowDescription::get_size () const
| Returns the size of the window stored in description. More...
Rectf | clan::DisplayWindowDescription::get_position () const
| Returns the initial position of the window. More...
bool | clan::DisplayWindowDescription::get_position_client_area () const
| Returns if the client area is used for the initial position of the window. More...
bool | clan::DisplayWindowDescription::is_fullscreen () const
| Returns if window should be initially fullscreen. More...
int | clan::DisplayWindowDescription::get_flipping_buffers () const
| Returns the amount of flipping buffers to be created. More...
int | clan::DisplayWindowDescription::get_swap_interval () const
| Returns the swap interval to be used for the window. More...
bool | clan::DisplayWindowDescription::get_allow_resize () const
| Returns true if window should be resizeable. More...
int | clan::DisplayWindowDescription::get_bpp () const
| Returns the numbers of bytes per pixel in the window. More...
int | clan::DisplayWindowDescription::get_refresh_rate () const
bool | clan::DisplayWindowDescription::is_layered () const
| Returns true if window is layered (black is transparent) More...
DisplayWindowHandle | clan::DisplayWindowDescription::get_handle () const
bool | clan::DisplayWindowDescription::has_caption () const
| Returns true if a title bar is shown. More...
bool | clan::DisplayWindowDescription::has_sysmenu () const
| Returns true if the window has a window menu on its title bar. More...
bool | clan::DisplayWindowDescription::has_minimize_button () const
| Returns true if the window has a minimize button. More...
bool | clan::DisplayWindowDescription::has_maximize_button () const
| Returns true if the window has a maximize button. More...
bool | clan::DisplayWindowDescription::is_visible () const
| Returns true if the window is initially visible. More...
bool | clan::DisplayWindowDescription::is_topmost () const
| Returns true if the window should be placed above all non-topmost windows. More...
bool | clan::DisplayWindowDescription::has_no_activate () const
| Indicates if window is automatically activated or not. More...
bool | clan::DisplayWindowDescription::get_using_gui_window_cache () const
| Returns true if window from the window cache should be used. (GUI Only) More...
bool | clan::DisplayWindowDescription::has_drop_shadow () const
| Returns true if the window is drawn with a drop shadow effect. More...
DisplayWindow | clan::DisplayWindowDescription::get_owner () const
| Returns the window owning this one. More...
bool | clan::DisplayWindowDescription::get_tablet_context () const
| Returns true if a tablet context is to be created for the window. More...
int | clan::DisplayWindowDescription::get_depth_size () const
| Returns the minimum required depth buffer. More...
int | clan::DisplayWindowDescription::get_stencil_size () const
| Returns the minimum required stencil buffer. More...
int | clan::DisplayWindowDescription::get_fullscreen_monitor () const
| Returns the index of the monitor to go fullscreen on. See ScreenInfo. More...
bool | clan::DisplayWindowDescription::get_allow_screensaver () const
| Returns true if the screensaver is allowed. More...
bool | clan::DisplayWindowDescription::is_update_supported () const
| Returns true if DisplayWindow::update should be supported. More...
int | clan::DisplayWindowDescription::get_multisampling () const
| Returns the number of samples per pixel. More...
float | clan::DisplayWindowDescription::get_extend_frame_left () const
float | clan::DisplayWindowDescription::get_extend_frame_top () const
float | clan::DisplayWindowDescription::get_extend_frame_right () const
float | clan::DisplayWindowDescription::get_extend_frame_bottom () const
WindowType | clan::DisplayWindowDescription::get_type () const

## Operations
DisplayWindowDescription & | clan::DisplayWindowDescription::operator= (const DisplayWindowDescription &copy)
| Copy assignment operator. More...
void | clan::DisplayWindowDescription::show_caption (bool value=true)
| Controls if a title bar (including frame) is shown or not. More...
void | clan::DisplayWindowDescription::show_sysmenu (bool value=true)
| Sets if the window has a window menu on its title bar. More...
void | clan::DisplayWindowDescription::show_minimize_button (bool value=true)
| Sets if the window has a minimize button. More...
void | clan::DisplayWindowDescription::show_maximize_button (bool value=true)
| Sets if the window has a maximize button. More...
void | clan::DisplayWindowDescription::set_visible (bool value=true)
| Toggles whether the window is created as initially visible. More...
void | clan::DisplayWindowDescription::set_topmost (bool value=true)
| Sets if the window should be placed above all non-topmost windows. More...
void | clan::DisplayWindowDescription::set_no_activate (bool value=true)
| Prevents window from being automatically activated. More...
void | clan::DisplayWindowDescription::set_drop_shadow (bool value=true)
| Enables a drop shadow effect on the window. More...
void | clan::DisplayWindowDescription::set_owner_window (const DisplayWindow &owner)
| Specifies another window which owns this one. More...
void | clan::DisplayWindowDescription::set_title (const std::string &title)
| Sets the title of the window. More...
void | clan::DisplayWindowDescription::set_size (const Sizef &size, bool client_area)
| Sets the size of the window (including window frame). More...
void | clan::DisplayWindowDescription::set_position (const Rectf &position, bool client_area)
| Sets the position of the window (including window frame). More...
void | clan::DisplayWindowDescription::set_fullscreen (bool fullscreen=true, int monitor=0)
| Makes the window initially fullscreen. More...
void | clan::DisplayWindowDescription::set_flipping_buffers (int num_buffers=2)
| Sets the amount of flipping buffers to be used. More...
void | clan::DisplayWindowDescription::set_swap_interval (int interval=-1)
| Sets the swap interval to be used for the window. More...
void | clan::DisplayWindowDescription::set_allow_resize (bool allow_resize=true)
| Sets if windows should be resizable. More...
void | clan::DisplayWindowDescription::set_bpp (int bpp)
| Sets the number of bytes per pixel. More...
void | clan::DisplayWindowDescription::set_refresh_rate (int refresh_rate)
void | clan::DisplayWindowDescription::set_tablet_context (bool create)
| Sets to true if a tablet input context should be created for this window. More...
void | clan::DisplayWindowDescription::set_using_gui_window_cache (bool value)
void | clan::DisplayWindowDescription::set_layered (bool layered)
| Creates a layered window (complex shaped window) More...
void | clan::DisplayWindowDescription::set_allow_screensaver (bool allow_screensaver=true)
| Allow the screensaver to appear. More...
void | clan::DisplayWindowDescription::set_handle (DisplayWindowHandle handle)
void | clan::DisplayWindowDescription::set_depth_size (int value)
| Sets the minimum required depth buffer. More...
void | clan::DisplayWindowDescription::set_stencil_size (int value)
| Sets the minimum required stencil buffer. More...
void | clan::DisplayWindowDescription::set_update_supported (bool value) const
| Controls if DisplayWindow::update is supported. More...
void | clan::DisplayWindowDescription::set_multisampling (int value)
| Sets the number of samples per pixel. More...
void | clan::DisplayWindowDescription::set_extend_frame (float left, float top, float right, float bottom)
void | clan::DisplayWindowDescription::set_type (WindowType type)

## Detailed Description

## Enumeration Type Documentation

enum clan::StandardCursor
| strong

Standard Cursor.

Enumerator
arrow |
appstarting |
cross |
hand |
ibeam |
no |
size_all |
size_nesw |
size_ns |
size_nwse |
size_we |
uparrow |
wait |

enum clan::WindowType
| strong

Enumerator
normal |
popup |
tool |
custom |

## Function Documentation

clan::Cursor::Cursor | ( |  | ) |

Constructs a null instance.

clan::Cursor::Cursor | ( | const DisplayWindow & | window,
|  | const CursorDescription & | cursor_description
| ) |  |

Constructs a Cursor.

Parameters

  window | = Display Window
  cursor_description | = Sprite Description
  hotspot | = Point

clan::DisplayWindow::DisplayWindow | ( |  | ) |

Constructs a null instance.

clan::DisplayWindow::DisplayWindow | ( | const std::string & | title,
|  | float | width,
|  | float | height,
|  | bool | start_fullscreen = `false`,
|  | bool | allow_resize = `false`,
|  | int | flipping_buffers = `2`
| ) |  |

Constructs a window.

Parameters

  title | = Titlebar text.
  width | = Width in pixels of window.
  height | = Height in pixels of window.
  start_fullscreen | = If true, window will go fullscreen.
  allow_resize | = If true, window will have resize grabbers and can be resized.
  flipping_buffers | = Number of flipping buffers in system. Default is that there is a front buffer and a back buffer.
  target | = Display target used to create the window.

clan::DisplayWindow::DisplayWindow | ( | const DisplayWindowDescription & | description | ) |

Constructs a window.

Parameters

  description | = Structure that describes how to create the display window.
  target | = Display target used to create the window.

clan::DisplayWindow::DisplayWindow | ( | DisplayWindowProvider * | provider | ) |

Constructs a window.

Parameters

  provider | = Display target implementation object.

clan::DisplayWindowDescription::DisplayWindowDescription | ( |  | ) |

Constructs a window description with default values.

clan::DisplayWindowDescription::DisplayWindowDescription | ( | const std::string & | title | ) |

Constructs a window description with default values and a title.

clan::DisplayWindowDescription::DisplayWindowDescription | ( | const std::string & | title,
|  | const Rectf & | position,
|  | bool | client_area
| ) |  |

Constructs a window description with default values, a title and a position.

clan::DisplayWindowDescription::DisplayWindowDescription | ( | const std::string & | title,
|  | const Sizef & | size,
|  | bool | client_area
| ) |  |

Constructs a window description with default values, a title and a size.

clan::DisplayWindowDescription::DisplayWindowDescription | ( | const Rectf & | position,
|  | bool | client_area
| ) |  |

Constructs a window description with default values and a position.

clan::DisplayWindowDescription::DisplayWindowDescription | ( | const DisplayWindowDescription & | copy | ) |

Constructs a DisplayWindowDescription.

Parameters

  copy | = Display Window Description

clan::DisplayWindow::~DisplayWindow | ( |  | ) |

virtual clan::DisplayWindowDescription::~DisplayWindowDescription | ( |  | ) |
| virtual

void clan::DisplayWindow::bring_to_front | ( |  | ) |

Raises the window on top of other windows.

void clan::DisplayWindow::capture_mouse | ( | bool | capture | ) |

Capture/Release the mouse.

Pointf clan::DisplayWindow::client_to_screen | ( | const Pointf & | client | ) |

Convert from window client coordinates to screen coordinates.

DisplayWindowDescription clan::DisplayWindowDescription::clone | ( |  | ) | const

void clan::DisplayWindow::enable_alpha_channel | ( | const Rectf & | blur_rect | ) |

Enable alpha channel for this window.

This is only supported on Windows Vista and above (Else use Layered windows instead)

Parameters

  blur_rect | = Blur rectangle. If size = 0, then the entire window is used

void clan::DisplayWindow::extend_frame_into_client_area | ( | float | left,
|  | float | top,
|  | float | right,
|  | float | bottom
| ) |  |

Exend the window frame into the client area.

Only implemented on win32

void clan::DisplayWindow::flip | ( | int | interval = `-1` | ) |

Flip back buffer to front, making changes visible on screen.

The parameter interval specifies the minimum number of video frames that are displayed before a buffer swap will occur.

If interval is set to a value of 0, buffer swaps are not synchronized to a video frame.

If interval is set to a value of -1 (the default), then it will use the buffer swap used for previous flip. If its the first flip, it will use the system default.

Parameters

  interval | = See note

std::function<bool()>& clan::DisplayWindow::func_minimize_clicked | ( |  | ) |

Callback called when a window is asked to minimize itself.

std::function<void(Rectf &)>& clan::DisplayWindow::func_window_resize | ( |  | ) |

Callback called when a window is being resized.

bool clan::DisplayWindowDescription::get_allow_resize | ( |  | ) | const

Returns true if window should be resizeable.

bool clan::DisplayWindowDescription::get_allow_screensaver | ( |  | ) | const

Returns true if the screensaver is allowed.

int clan::DisplayWindowDescription::get_bpp | ( |  | ) | const

Returns the numbers of bytes per pixel in the window.

PixelBuffer clan::DisplayWindow::get_clipboard_image | ( |  | ) | const

Returns an image stored in the clipboard.

Returns a null pixelbuffer if no image is available.

std::string clan::DisplayWindow::get_clipboard_text | ( |  | ) | const

Returns the text stored in the clipboard.

int clan::DisplayWindowDescription::get_depth_size | ( |  | ) | const

Returns the minimum required depth buffer.

float clan::DisplayWindowDescription::get_extend_frame_bottom | ( |  | ) | const

float clan::DisplayWindowDescription::get_extend_frame_left | ( |  | ) | const

float clan::DisplayWindowDescription::get_extend_frame_right | ( |  | ) | const

float clan::DisplayWindowDescription::get_extend_frame_top | ( |  | ) | const

int clan::DisplayWindowDescription::get_flipping_buffers | ( |  | ) | const

Returns the amount of flipping buffers to be created.

int clan::DisplayWindowDescription::get_fullscreen_monitor | ( |  | ) | const

Returns the index of the monitor to go fullscreen on. See ScreenInfo.

GraphicContext& clan::DisplayWindow::get_gc | ( |  | ) | const

Return the graphic context for the window.

Rectf clan::DisplayWindow::get_geometry | ( |  | ) | const

Returns the position and size of the window frame.

DisplayWindowHandle clan::DisplayWindowDescription::get_handle | ( |  | ) | const

Returns an platform-specific internal display window handle object.

DisplayWindowHandle clan::DisplayWindow::get_handle | ( |  | ) | const

Returns an platform-specific internal display window handle object.

InputContext clan::DisplayWindow::get_ic | ( |  | ) | const

Return the input context for the window.

Sizef clan::DisplayWindow::get_maximum_size | ( | bool | client_area = `false` | ) |

Returns the maximum size the window can be resized to by the application user.

Sizef clan::DisplayWindow::get_minimum_size | ( | bool | client_area = `false` | ) |

Returns the minimum size the window can be resized to by the application user.

int clan::DisplayWindowDescription::get_multisampling | ( |  | ) | const

Returns the number of samples per pixel.

DisplayWindow clan::DisplayWindowDescription::get_owner | ( |  | ) | const

Returns the window owning this one.

Rectf clan::DisplayWindowDescription::get_position | ( |  | ) | const

Returns the initial position of the window.

bool clan::DisplayWindowDescription::get_position_client_area | ( |  | ) | const

Returns if the client area is used for the initial position of the window.

CursorProvider* clan::Cursor::get_provider | ( |  | ) | const

Returns the cursor provider.

DisplayWindowProvider* clan::DisplayWindow::get_provider | ( |  | ) | const

Returns the display window provider.

int clan::DisplayWindowDescription::get_refresh_rate | ( |  | ) | const

Returns the refresh rate of the DisplayMode in Hertz (cycles per second). This value is also known as the vertical refresh rate.

Sizef clan::DisplayWindowDescription::get_size | ( |  | ) | const

Returns the size of the window stored in description.

int clan::DisplayWindowDescription::get_stencil_size | ( |  | ) | const

Returns the minimum required stencil buffer.

int clan::DisplayWindowDescription::get_swap_interval | ( |  | ) | const

Returns the swap interval to be used for the window.

bool clan::DisplayWindowDescription::get_tablet_context | ( |  | ) | const

Returns true if a tablet context is to be created for the window.

const std::string& clan::DisplayWindowDescription::get_title | ( |  | ) | const

Returns the window title stored in the description.

std::string clan::DisplayWindow::get_title | ( |  | ) | const

Returns the window title.

WindowType clan::DisplayWindowDescription::get_type | ( |  | ) | const

bool clan::DisplayWindowDescription::get_using_gui_window_cache | ( |  | ) | const

Returns true if window from the window cache should be used. (GUI Only)

This setting is ignored unless the GUI and GUIWindowManagerSystem are used.

Rectf clan::DisplayWindow::get_viewport | ( |  | ) | const

Returns the drawable area of the window (excluding window frame).

bool clan::DisplayWindowDescription::has_caption | ( |  | ) | const

Returns true if a title bar is shown.

bool clan::DisplayWindowDescription::has_drop_shadow | ( |  | ) | const

Returns true if the window is drawn with a drop shadow effect.

bool clan::DisplayWindow::has_focus | ( |  | ) | const

Returns true if window has focus.

bool clan::DisplayWindowDescription::has_maximize_button | ( |  | ) | const

Returns true if the window has a maximize button.

bool clan::DisplayWindowDescription::has_minimize_button | ( |  | ) | const

Returns true if the window has a minimize button.

bool clan::DisplayWindowDescription::has_no_activate | ( |  | ) | const

Indicates if window is automatically activated or not.

bool clan::DisplayWindowDescription::has_sysmenu | ( |  | ) | const

Returns true if the window has a window menu on its title bar.

void clan::DisplayWindow::hide | ( |  | ) |

Hides the window.

void clan::DisplayWindow::hide_cursor | ( |  | ) |

Hides the mouse cursor.

bool clan::DisplayWindow::is_clipboard_image_available | ( |  | ) | const

Returns true if an image is available in the clipboard.

bool clan::DisplayWindow::is_clipboard_text_available | ( |  | ) | const

Returns true if text is available in the clipboard.

bool clan::DisplayWindowDescription::is_fullscreen | ( |  | ) | const

Returns if window should be initially fullscreen.

bool clan::DisplayWindow::is_fullscreen | ( |  | ) | const

Returns true if window is currently running fullscreen.

bool clan::DisplayWindowDescription::is_layered | ( |  | ) | const

Returns true if window is layered (black is transparent)

bool clan::DisplayWindow::is_maximized | ( |  | ) | const

Returns true if the window is maximized.

bool clan::DisplayWindow::is_minimized | ( |  | ) | const

Returns true if the window is minimized.

bool clan::Cursor::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::DisplayWindow::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::DisplayWindowDescription::is_topmost | ( |  | ) | const

Returns true if the window should be placed above all non-topmost windows.

bool clan::DisplayWindowDescription::is_update_supported | ( |  | ) | const

Returns true if DisplayWindow::update should be supported.

bool clan::DisplayWindowDescription::is_visible | ( |  | ) | const

Returns true if the window is initially visible.

bool clan::DisplayWindow::is_visible | ( |  | ) | const

returns true if this display window is visible

void clan::DisplayWindow::maximize | ( |  | ) |

Maximizes the window.

void clan::DisplayWindow::minimize | ( |  | ) |

Minimizes the window.

DisplayWindowDescription& clan::DisplayWindowDescription::operator= | ( | const DisplayWindowDescription & | copy | ) |

Copy assignment operator.

void clan::DisplayWindow::request_repaint | ( | const Rectf & | rect | ) |

Invalidates a region of a screen, causing a repaint.

void clan::DisplayWindow::restore | ( |  | ) |

Restores the window.

Pointf clan::DisplayWindow::screen_to_client | ( | const Pointf & | screen | ) |

Convert from screen coordinates to client coordinates.

void clan::DisplayWindowDescription::set_allow_resize | ( | bool | allow_resize = `true` | ) |

Sets if windows should be resizable.

void clan::DisplayWindowDescription::set_allow_screensaver | ( | bool | allow_screensaver = `true` | ) |

Allow the screensaver to appear.

Parameters

  allow_screensaver | = Allow the allow_screensaver (default is true)

void clan::DisplayWindowDescription::set_bpp | ( | int | bpp | ) |

Sets the number of bytes per pixel.

void clan::DisplayWindow::set_clipboard_image | ( | const PixelBuffer & | buf | ) |

Stores an image in the clipboard.

void clan::DisplayWindow::set_clipboard_text | ( | const std::string & | text | ) |

Stores text in the clipboard.

void clan::DisplayWindow::set_cursor | ( | const Cursor & | cursor | ) |

Sets the current cursor icon.

void clan::DisplayWindow::set_cursor | ( | StandardCursor | type | ) |

Set cursor.

Parameters

  type | = Standard Cursor

void clan::DisplayWindowDescription::set_depth_size | ( | int | value | ) |

Sets the minimum required depth buffer.

If this value is zero, the smallest available depth buffer is preferred. Otherwise, the largest available depth buffer of at least the minimum size is preferred.

void clan::DisplayWindowDescription::set_drop_shadow | ( | bool | value = `true` | ) |

Enables a drop shadow effect on the window.

void clan::DisplayWindow::set_enabled | ( | bool | enable | ) |

Set enabled.

Parameters

  enable | = bool

void clan::DisplayWindowDescription::set_extend_frame | ( | float | left,
|  | float | top,
|  | float | right,
|  | float | bottom
| ) |  |

void clan::DisplayWindowDescription::set_flipping_buffers | ( | int | num_buffers = `2` | ) |

Sets the amount of flipping buffers to be used.

void clan::DisplayWindowDescription::set_fullscreen | ( | bool | fullscreen = `true`,
|  | int | monitor = `0`
| ) |  |

Makes the window initially fullscreen.

void clan::DisplayWindowDescription::set_handle | ( | DisplayWindowHandle | handle | ) |

Sets the platform-specific internal display window handle object.

void clan::DisplayWindow::set_large_icon | ( | const PixelBuffer & | image | ) |

Sets the large icon used for this window.

void clan::DisplayWindowDescription::set_layered | ( | bool | layered | ) |

Creates a layered window (complex shaped window)

void clan::DisplayWindow::set_maximum_size | ( | float | width,
|  | float | height,
|  | bool | client_area
| ) |  |

Maximum size a window can be resized to by the application user.

void clan::DisplayWindow::set_minimum_size | ( | float | width,
|  | float | height,
|  | bool | client_area
| ) |  |

Minimum size a window can be resized to by the application user.

void clan::DisplayWindowDescription::set_multisampling | ( | int | value | ) |

Sets the number of samples per pixel.

void clan::DisplayWindowDescription::set_no_activate | ( | bool | value = `true` | ) |

Prevents window from being automatically activated.

void clan::DisplayWindowDescription::set_owner_window | ( | const DisplayWindow & | owner | ) |

Specifies another window which owns this one.

void clan::DisplayWindowDescription::set_position | ( | const Rectf & | position,
|  | bool | client_area
| ) |  |

Sets the position of the window (including window frame).

The default position, is centred on the screen. If this is wanted, use set_size() instead

Parameters

  position | = Window position
  client_area | = false = include the window frame. true = exclude the window frame

void clan::DisplayWindow::set_position | ( | const Rectf & | pos,
|  | bool | client_area
| ) |  |

Set window position and size.

Parameters

  pos | = Window position and size.
  client_area | = true - Position relative to window client area

void clan::DisplayWindow::set_position | ( | float | x,
|  | float | y
| ) |  |

Set window position.

Parameters

  x | Window x position on desktop.
  y | Window y position on desktop.

void clan::DisplayWindowDescription::set_refresh_rate | ( | int | refresh_rate | ) |

Sets the refresh rate of the DisplayMode in Hertz (cycles per second). This value is also known as the vertical refresh rate.

void clan::DisplayWindowDescription::set_size | ( | const Sizef & | size,
|  | bool | client_area
| ) |  |

Sets the size of the window (including window frame).

Parameters

  size | = Window size
  client_area | = false = include the window frame. true = exclude the window frame

void clan::DisplayWindow::set_size | ( | float | width,
|  | float | height,
|  | bool | client_area
| ) |  |

Resize window.

Parameters

  width | = New width of window in pixels.
  height | = New height of window in pixels.
  client_area | = true - relative to the window client area

void clan::DisplayWindow::set_small_icon | ( | const PixelBuffer & | image | ) |

Sets the small icon used for this window.

void clan::DisplayWindowDescription::set_stencil_size | ( | int | value | ) |

Sets the minimum required stencil buffer.

If this value is zero, the smallest available stencil buffer is preferred. Otherwise, the largest available stencil buffer of at least the minimum size is preferred.

void clan::DisplayWindowDescription::set_swap_interval | ( | int | interval = `-1` | ) |

Sets the swap interval to be used for the window.

void clan::DisplayWindowDescription::set_tablet_context | ( | bool | create | ) |

Sets to true if a tablet input context should be created for this window.

void clan::DisplayWindowDescription::set_title | ( | const std::string & | title | ) |

Sets the title of the window.

void clan::DisplayWindow::set_title | ( | const std::string & | title | ) |

Change window title.

void clan::DisplayWindowDescription::set_topmost | ( | bool | value = `true` | ) |

Sets if the window should be placed above all non-topmost windows.

void clan::DisplayWindowDescription::set_type | ( | WindowType | type | ) |

void clan::DisplayWindowDescription::set_update_supported | ( | bool | value | ) | const

Controls if DisplayWindow::update is supported.

The Direct3D target needs to know at window creation time if the application intends to update the screen by calling DisplayWindow::update.

void clan::DisplayWindowDescription::set_using_gui_window_cache | ( | bool | value | ) |

Set to use a window from the window cache (GUI Only). Creating a window in Windows XP is slow (~100 ms). Using cached windows for menus and dialogs may make things run faster on Windows XP. This setting is ignored unless the GUI and GUIWindowManagerSystem are used.

void clan::DisplayWindowDescription::set_visible | ( | bool | value = `true` | ) |

Toggles whether the window is created as initially visible.

void clan::DisplayWindow::set_visible | ( | bool | visible,
|  | bool | activate
| ) |  |

Set visible.

Parameters

  visible | = bool
  activate | = bool

void clan::DisplayWindow::show | ( | bool | activate = `true` | ) |

Displays the window in its current size and position.

void clan::DisplayWindowDescription::show_caption | ( | bool | value = `true` | ) |

Controls if a title bar (including frame) is shown or not.

void clan::DisplayWindow::show_cursor | ( |  | ) |

Shows the mouse cursor.

void clan::DisplayWindowDescription::show_maximize_button | ( | bool | value = `true` | ) |

Sets if the window has a maximize button.

void clan::DisplayWindowDescription::show_minimize_button | ( | bool | value = `true` | ) |

Sets if the window has a minimize button.

void clan::DisplayWindowDescription::show_sysmenu | ( | bool | value = `true` | ) |

Sets if the window has a window menu on its title bar.

Signal<void()>& clan::DisplayWindow::sig_got_focus | ( |  | ) |

Signal emitted when window gain focus.

Signal<void()>& clan::DisplayWindow::sig_lost_focus | ( |  | ) |

Signal emitted when window lost focus.

Signal<void(const Rectf &)>& clan::DisplayWindow::sig_paint | ( |  | ) |

Signal emitted when an area of the window is invalidated.

Signal<void(float, float)>& clan::DisplayWindow::sig_resize | ( |  | ) |

Signal emitted when window is resized.

Signal<void()>& clan::DisplayWindow::sig_window_close | ( |  | ) |

Signal emitted when window is closed.

Signal<void()>& clan::DisplayWindow::sig_window_destroy | ( |  | ) |

Signal emitted when window is destroyed.

Signal<void()>& clan::DisplayWindow::sig_window_flip | ( |  | ) |

Signal emitted when window flip() was called.

Signal<void()>& clan::DisplayWindow::sig_window_maximized | ( |  | ) |

Signal emitted when window is maximized.

Signal<void()>& clan::DisplayWindow::sig_window_minimized | ( |  | ) |

Signal emitted when window is minimized.

Signal<void()>& clan::DisplayWindow::sig_window_moved | ( |  | ) |

Signal emitted after a window has been moved.

Signal<void()>& clan::DisplayWindow::sig_window_restored | ( |  | ) |

Signal emitted when window is restored.

void clan::Cursor::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::DisplayWindow::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::DisplayWindow::update | ( | const Rectf & | rect | ) |

Copy the specified rectangle area from back buffer to front buffer.

Parameters

  rect | Area that should be copied.

## Variable Documentation

::Display* clan::DisplayWindowHandle::display = 0

::Window clan::DisplayWindowHandle::window = 0