CL_DisplayWindowMode Class Reference
[clanDisplay Window]

Display window mode class. More...

#include <display_window_mode.h>

List of all members.

Public Member Functions
Construction
	CL_DisplayWindowMode (const CL_Size &res, int bpp, int refresh_rate)
	Constructs a DisplayWindowMode.
	CL_DisplayWindowMode (const CL_DisplayWindowMode &copy)
	Constructs a DisplayWindowMode.
virtual	~CL_DisplayWindowMode ()
Attributes
CL_Size	get_resolution () const
	Returns the resolution of the displaymode.
int	get_bpp () const
	Returns the numbers of bytes per pixel of the displaymode.
int	get_refresh_rate () const
	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_String	get_string () const
	Returns the information as a string in the format "640x480x32@60".
Operations
CL_DisplayWindowMode &	operator= (const CL_DisplayWindowMode &copy)
	Copy assignment operator.
Static Public Member Functions
Statics
static std::vector< CL_DisplayWindowMode > &	get_display_modes ()
	Returns a list over all available display modes.

---

Detailed Description

Display window mode class.

This class contains information about one display window mode available. It also contains a static function to get a list of all available display modes.

Code example which dumps a list over all available modes:

    std::vector<CL_DisplayWindowMode> &modes = CL_DisplayWindowMode::get_display_modes();
    for(std::size_t i=0; i < modes.size(); ++i)
        std::cout << modes[i].get_string() << std::endl;
    

---

Constructor & Destructor Documentation

CL_DisplayWindowMode::CL_DisplayWindowMode (  const CL_Size &  res, int  bpp, int  refresh_rate )

Constructs a DisplayWindowMode. Parameters: res  = Size bpp  = value refresh_rate  = value

CL_DisplayWindowMode::CL_DisplayWindowMode (  const CL_DisplayWindowMode &  copy  )

Constructs a DisplayWindowMode. Parameters: copy  = Display Window Mode

virtual CL_DisplayWindowMode::~CL_DisplayWindowMode (   )  [virtual]

---

Member Function Documentation

int CL_DisplayWindowMode::get_bpp (   )  const

Returns the numbers of bytes per pixel of the displaymode.

static std::vector<CL_DisplayWindowMode>& CL_DisplayWindowMode::get_display_modes (   )  [static]

Returns a list over all available display modes.

int CL_DisplayWindowMode::get_refresh_rate (   )  const

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_DisplayWindowMode::get_resolution (   )  const

Returns the resolution of the displaymode.

CL_String CL_DisplayWindowMode::get_string (   )  const

Returns the information as a string in the format "640x480x32@60".

CL_DisplayWindowMode& CL_DisplayWindowMode::operator= (  const CL_DisplayWindowMode &  copy  )

Copy assignment operator.

---

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

• display_window_mode.h

---