CL_DisplayWindow - ClanLib Game SDK

Home | All Classes | Grouped Classes | Index | Search

# Class CL_DisplayWindow

Toplevel window class. More...

Derived from: none
Derived by: CL_OpenGLWindow
Group: Display (Display 2D)

#include <ClanLib/display.h>

Construction:

CL_DisplayWindow | Constructs a window.

Attributes:

get_width | Returns the current width of the window.
get_height | Returns the current height of the window.
is_fullscreen | Returns true if window is currently running fullscreen.
has_focus | Returns true if window has focus.
get_buffer | Returns the pixel buffer for the specified flipping buffer.
get_buffer_count | Returns the amount of flipping buffers being used.
get_front_buffer | Returns the current flipping buffer being used as the front buffer.
get_back_buffer | Returns the current flipping buffer being used as the back buffer.
get_gc | Returns the graphic context of the current back buffer.
get_ic | Returns the input context of this window.

Operations:

operator = | Copy assignment operator.
set_fullscreen | Change window to running fullscreen mode.
set_windowed | Change window to running windowed mode.
set_title | Change window title.
set_position | Set window position and size.
set_size | Resize window.
set_buffer_count | Changes the amount of pixel buffers used in the flipping system.
update | Copy the specified rectangle area from back buffer to front buffer.
flip | Flip back buffer to front, making changes visible on screen.
set_cursor | Sets the mouse cursor shape.
show_cursor | Shows the mouse cursor.
hide_cursor | Hides the mouse cursor.

Signals:

sig_lost_focus | Signal emitted when window lost focus.
sig_got_focus | Signal emitted when window gain focus.
sig_resize | Signal emitted when window is resized.
sig_paint | Signal emitted when an area of the window is invalidated.
sig_window_close | Signal emitted when window is closed.

Implementation:

impl |

Detailed description:

!group=Display/Display 2D! !header=display.h!

CL_DisplayWindow represents a window in your windowing system (Windows, X11). You need to create at least one display window in order to draw graphics in ClanLib.

Questions or comments, write to the ClanLib mailing list.