Entire Class Index | Main Class Index | Cross Index | Global Index

# Class CL_VidMode

Video mode class.
Contained in: global
Derived from: none
Derived by: none
Group: Display (Display 2D)

#include <ClanLib/display.h>

### public function member index:

### Construction:

`` | `CL_VidMode` | `(`int` `width`, `int` `height`, `int` `bpp`, `bool` `mode_x`=false)`;

### Operations:

``std::string`` | `asString` | `()`;

## Description:

This class is used to describe a videomode in ClanLib.
CL_VidMode is returned from a display card when a list of video modes are requested by a call to CL_DisplayCard::get_videomodes().
Note that not all display implementations can give you a list of supported modes. If none are requested, you can select whatever mode you want. This usually happens when the implementation runs in a window and that there's no such thing as a video mode.

## Function Member Descriptions:

CL_VidMode::CL_VidMode - Class Constructor.
`` `CL_VidMode` `(`int` `width`, `int` `height`, `int` `bpp`, `bool` `mode_x`=false)`;

> width - Width of the videomode.
> height - Height of the videomode.
> bpp - Depth (8, 16, 24, 32 bpp) of the videomode.
> mode_x - Use mode x if available.

CL_VidMode::asString - Converts the video mode description to a string.
``std::string`` `asString` `()`;

> Returns - A string describing the video mode in human language!

## Variable Member Descriptions:

CL_VidMode::bpp - Videomode depth.
``int`` ``bpp`;`

CL_VidMode::height - Videomode height.
``int`` ``height`;`

CL_VidMode::mode_x - True if modeX.
``bool`` ``mode_x`;`

CL_VidMode::width - Videomode width.
``int`` ``width`;`