---
name: "CL_VidMode"
section: "3"
platform: "linux"
package: "clanlib0-common-dev"
version: "0.4.4-8"
release: "Debian 3.0 (Woody)"
platforms: ["linux"]
url: "https://new.carta.tech/CL_VidMode"
---

# 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 \<*mbn@dark.x.dtu.dk*\> and Martin Starch \<*starch@dark.x.dtu.dk*\>. 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.