Reference

CL_VidMode(3)

Video mode class.

NAME

CL_VidMode - Video mode class.

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.

CLASS MEMBERS

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

std::string asString()

MEMBERS WITH DESCRIPTIONS

int width
Description:

Videomode width.

int height
Description:

Videomode height.

int bpp
Description:

Videomode depth.

bool mode_x
Description:

True if modeX.

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

Parameters:
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.

Description:

Class Constructor.

std::string asString()
Description:

Converts the video mode description to a string.

Return value:

A string describing the video mode in human language!

SEE ALSO

All ClanLib API classes can be found in clanlib (3).

AUTHORS

Originally written by Magnus Norddahl <[email protected]> and Martin Starch <[email protected]>. ClanLib is now developed by the ClanLib Development team as an Open Source project.

The ClanLib man pages was created using the Perceps documentation system (another excellent piece of Open Source software, available at http://somewhere.in.the.world.org).

See clanlib (3) to find out how to get a full list of contributors and details on how to submit bug reports, comments etc.