CL_GL1WindowDescription Class Reference
[clanGL1 Display]

OpenGL specific display window description. More...

#include <opengl1_window_description.h>

Inheritance diagram for CL_GL1WindowDescription:

List of all members.

Public Member Functions
Construction
	CL_GL1WindowDescription ()
	Constructs a window description with default values.
	CL_GL1WindowDescription (const CL_DisplayWindowDescription &desc)
	Constructs a GL1WindowDescription.
CL_GL1WindowDescription &	operator= (CL_DisplayWindowDescription &desc)
virtual	~CL_GL1WindowDescription ()
Attributes
bool	get_doublebuffer () const
	Returns true if only double-buffered visuals are considered.
bool	get_stereo () const
	Returns true if only stereo visuals are considered.
int	get_buffer_size () const
	Returns the desired color buffer size.
int	get_red_size () const
	Returns the minimum required red buffer.
int	get_green_size () const
	Returns the minimum required green buffer.
int	get_blue_size () const
	Returns the minimum required blue buffer.
int	get_alpha_size () const
	Returns the minimum required alpha buffer.
int	get_multisampling () const
	Returns the number of samples per pixel.
Operations
void	set_doublebuffer (bool value)
	Sets if only double-buffered visuals are considered.
void	set_stereo (bool value)
	Sets if only stereo visuals are to be considered.
void	set_buffer_size (int value)
	Sets the desired color buffer size.
void	set_red_size (int value)
	Sets the minimum required red buffer.
void	set_green_size (int value)
	Sets the minimum required green buffer.
void	set_blue_size (int value)
	Sets the minimum required blue buffer.
void	set_alpha_size (int value)
	Sets the minimum required alpha buffer.
void	set_multisampling (int value)
	Sets the number of samples per pixel.

---

Detailed Description

OpenGL specific display window description.

Use this class to setup OpenGL specific settings for a top level window:

       CL_GL1WindowDescription desc;
       dest.set_title("OpenGL window with stereo visual");
       desc.set_stereo(true);
       desc.set_stencil_size(4);
       CL_GL1Window window(desc);
       

---

Constructor & Destructor Documentation

CL_GL1WindowDescription::CL_GL1WindowDescription (   )

Constructs a window description with default values.

CL_GL1WindowDescription::CL_GL1WindowDescription (  const CL_DisplayWindowDescription &  desc  )

Constructs a GL1WindowDescription. Parameters: desc  = Display Window Description

virtual CL_GL1WindowDescription::~CL_GL1WindowDescription (   )  [virtual]

---

Member Function Documentation

bool CL_DisplayWindowDescription::get_allow_resize (   )  const [inherited]

Returns true if window should be resizeable.

int CL_GL1WindowDescription::get_alpha_size (   )  const

Returns the minimum required alpha buffer.

int CL_GL1WindowDescription::get_blue_size (   )  const

Returns the minimum required blue buffer.

int CL_DisplayWindowDescription::get_bpp (   )  const [inherited]

Returns the numbers of bytes per pixel in the window.

int CL_GL1WindowDescription::get_buffer_size (   )  const

Returns the desired color buffer size. Ignored in GLX (X11) In WGL (Windows) it specifies the size of the color buffer, excluding the alpha bitplanes.

CL_UnknownSharedPtr CL_DisplayWindowDescription::get_data (  const CL_String &  data_name  )  const [inherited]

Returns the object stored in the given data name.

bool CL_DisplayWindowDescription::get_decorations (   )  const [inherited]

Returns true if the window shall be created with decorations.

int CL_DisplayWindowDescription::get_depth_size (   )  const [inherited]

Returns the minimum required depth buffer.

bool CL_GL1WindowDescription::get_doublebuffer (   )  const

Returns true if only double-buffered visuals are considered. If not enabled, only single-buffered visuals are considered.

int CL_DisplayWindowDescription::get_flipping_buffers (   )  const [inherited]

Returns the amount of flipping buffers to be created.

int CL_GL1WindowDescription::get_green_size (   )  const

Returns the minimum required green buffer.

int CL_GL1WindowDescription::get_multisampling (   )  const

Returns the number of samples per pixel.

CL_DisplayWindow CL_DisplayWindowDescription::get_owner (   )  const [inherited]

Returns the window owning this one.

CL_Rect CL_DisplayWindowDescription::get_position (   )  const [inherited]

Returns the initial position of the window.

bool CL_DisplayWindowDescription::get_position_client_area (   )  const [inherited]

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

int CL_GL1WindowDescription::get_red_size (   )  const

Returns the minimum required red buffer.

int CL_DisplayWindowDescription::get_refresh_rate (   )  const [inherited]

Returns the refresh rate of the displaymode. Specifies the frequency, in hertz (cycles per second). This value is also known as the vertical refresh rate.

CL_Size CL_DisplayWindowDescription::get_size (   )  const [inherited]

Returns the size of the window stored in description.

int CL_DisplayWindowDescription::get_stencil_size (   )  const [inherited]

Returns the minimum required stencil buffer.

bool CL_GL1WindowDescription::get_stereo (   )  const

Returns true if only stereo visuals are considered. If not enabled, only monoscopic visuals are considered.

bool CL_DisplayWindowDescription::get_tablet_context (   )  const [inherited]

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

const CL_String& CL_DisplayWindowDescription::get_title (   )  const [inherited]

Returns the window title stored in the description.

bool CL_DisplayWindowDescription::get_using_gui_window_cache (   )  const [inherited]

Returns true if window from the window cache should be used. (GUI Only). This setting is ignored unless the GUI and CL_GUIWindowManagerSystem are used.

bool CL_DisplayWindowDescription::has_border (   )  const [inherited]

Returns true if the window has a border.

bool CL_DisplayWindowDescription::has_caption (   )  const [inherited]

Returns true if a title bar is shown.

bool CL_DisplayWindowDescription::has_drop_shadow (   )  const [inherited]

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

bool CL_DisplayWindowDescription::has_maximize_button (   )  const [inherited]

Returns true if the window has a maximize button.

bool CL_DisplayWindowDescription::has_minimize_button (   )  const [inherited]

Returns true if the window has a minimize button.

bool CL_DisplayWindowDescription::has_sysmenu (   )  const [inherited]

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

bool CL_DisplayWindowDescription::is_fullscreen (   )  const [inherited]

Returns if window should be initially fullscreen.

bool CL_DisplayWindowDescription::is_layered (   )  const [inherited]

Returns true if window is layered (black is transparent).

bool CL_DisplayWindowDescription::is_tool_window (   )  const [inherited]

Returns true if the window is a tool window.

bool CL_DisplayWindowDescription::is_topmost (   )  const [inherited]

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

bool CL_DisplayWindowDescription::is_visible (   )  const [inherited]

Returns true if the window is initially visible.

CL_GL1WindowDescription& CL_GL1WindowDescription::operator= (  CL_DisplayWindowDescription &  desc  )

void CL_DisplayWindowDescription::set_allow_resize (  bool  allow_resize  )  [inherited]

Sets if windows should be resizable.

void CL_GL1WindowDescription::set_alpha_size (  int  value  )

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

void CL_GL1WindowDescription::set_blue_size (  int  value  )

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

void CL_DisplayWindowDescription::set_bpp (  int  bpp  )  [inherited]

Sets the number of bytes per pixel.

void CL_GL1WindowDescription::set_buffer_size (  int  value  )

Sets the desired color buffer size. Ignored in GLX (X11) In WGL (Windows) it specifies the size of the color buffer, excluding the alpha bitplanes.

void CL_DisplayWindowDescription::set_data (  const CL_String &  data_name, const CL_UnknownSharedPtr &  ptr )  [inherited]

Store object in description.

void CL_DisplayWindowDescription::set_decorations (  bool  decorations  )  [inherited]

Sets if windows should have decorations.

void CL_DisplayWindowDescription::set_depth_size (  int  value  )  [inherited]

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 CL_GL1WindowDescription::set_doublebuffer (  bool  value  )

Sets if only double-buffered visuals are considered. If not enabled, only single-buffered visuals are considered.

void CL_DisplayWindowDescription::set_drop_shadow (  bool  value = true  )  [inherited]

Enables a drop shadow effect on the window.

void CL_DisplayWindowDescription::set_flipping_buffers (  int  num_buffers = 2  )  [inherited]

Sets the amount of flipping buffers to be used.

void CL_DisplayWindowDescription::set_fullscreen (  bool  fullscreen = true  )  [inherited]

Makes the window initially fullscreen.

void CL_GL1WindowDescription::set_green_size (  int  value  )

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

void CL_DisplayWindowDescription::set_layered (  bool  layered  )  [inherited]

Creates a layered window (complex shaped window) (black is transparent).

void CL_GL1WindowDescription::set_multisampling (  int  value  )

Sets the number of samples per pixel.

void CL_DisplayWindowDescription::set_owner_window (  const CL_DisplayWindow &  owner  )  [inherited]

Specifies another window which owns this one.

void CL_DisplayWindowDescription::set_position (  const CL_Rect &  position, bool  client_area )  [inherited]

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: size  = Window size client_area  = false = include the window frame. true = exclude the window frame

void CL_GL1WindowDescription::set_red_size (  int  value  )

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

void CL_DisplayWindowDescription::set_refresh_rate (  int  refresh_rate  )  [inherited]

Set the refresh rate of the displaymode. Specifies the frequency, in hertz (cycles per second). This value is also known as the vertical refresh rate.

void CL_DisplayWindowDescription::set_size (  const CL_Size &  size, bool  client_area )  [inherited]

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 CL_DisplayWindowDescription::set_stencil_size (  int  value  )  [inherited]

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 CL_GL1WindowDescription::set_stereo (  bool  value  )

Sets if only stereo visuals are to be considered. If not enabled, only monoscopic visuals are considered.

void CL_DisplayWindowDescription::set_tablet_context (  bool  create  )  [inherited]

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

void CL_DisplayWindowDescription::set_title (  const CL_String &  title  )  [inherited]

Sets the title of the window.

void CL_DisplayWindowDescription::set_tool_window (  bool  value = true  )  [inherited]

Flags the window to be a tool window to the windowing system.

void CL_DisplayWindowDescription::set_topmost (  bool  value = true  )  [inherited]

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

void CL_DisplayWindowDescription::set_using_gui_window_cache (  bool  value  )  [inherited]

Uses a window from the window cache (GUI Only). Creating a window in Windows XP is slow (about 100 ms). Use cached windows for menus and dialogs to avoid sluggish operation in XP. This setting is ignored unless the GUI and CL_GUIWindowManagerSystem are used.

void CL_DisplayWindowDescription::set_visible (  bool  value = true  )  [inherited]

Toggles whether the window is created as initially visible.

void CL_DisplayWindowDescription::show_border (  bool  value = true  )  [inherited]

Sets if the window has a border.

void CL_DisplayWindowDescription::show_caption (  bool  value = true  )  [inherited]

Controls if a title bar is shown or not.

void CL_DisplayWindowDescription::show_maximize_button (  bool  value = true  )  [inherited]

Sets if the window has a maximize button.

void CL_DisplayWindowDescription::show_minimize_button (  bool  value = true  )  [inherited]

Sets if the window has a minimize button.

void CL_DisplayWindowDescription::show_sysmenu (  bool  value = true  )  [inherited]

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

---

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

• opengl1_window_description.h

---