<html> <head><title>ClanLib Reference: CL_VidMode</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_VidMode</h1><p> <b> Video mode class. </b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Display (Display 2D) <p> #include <ClanLib/display.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_VidMode.html#2402"><tt><font color=blue><b>CL_VidMode</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>width</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>height</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>bpp</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>mode_x</font></tt>=false)</tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_VidMode.html#2403"><tt><font color=blue><b>asString</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> This class is used to describe a videomode in ClanLib.<br><br> CL_VidMode is returned from a display card when a list of video modes are requested by a call to CL_DisplayCard::get_videomodes().<br><br> 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.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="2402"><font size=+1><b>CL_VidMode::CL_VidMode</b></font></a> - Class Constructor.<br><tt></tt> <a href="CL_VidMode.html#2402"><tt><font color=blue><b>CL_VidMode</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>width</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>height</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>bpp</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>mode_x</font></tt>=false)</tt>;<br><blockquote> width - Width of the videomode.<br> height - Height of the videomode.<br> bpp - Depth (8, 16, 24, 32 bpp) of the videomode.<br> mode_x - Use mode x if available.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2403"><font size=+1><b>CL_VidMode::asString</b></font></a> - Converts the video mode description to a string.<br><tt><tt><font color=navy>std::string</font></tt></tt> <a href="CL_VidMode.html#2403"><tt><font color=blue><b>asString</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - A string describing the video mode in human language!</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <a name="2400"><font size=+1><b>CL_VidMode::bpp</b></font></a> - Videomode depth.<br> <tt><tt><font color=purple>int</font></tt> </tt> <tt><a href="CL_VidMode.html#2400"><tt><font color=blue>bpp</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <a name="2399"><font size=+1><b>CL_VidMode::height</b></font></a> - Videomode height.<br> <tt><tt><font color=purple>int</font></tt> </tt> <tt><a href="CL_VidMode.html#2399"><tt><font color=blue>height</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <a name="2401"><font size=+1><b>CL_VidMode::mode_x</b></font></a> - True if modeX.<br> <tt><tt><font color=purple>bool</font></tt> </tt> <tt><a href="CL_VidMode.html#2401"><tt><font color=blue>mode_x</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <a name="2398"><font size=+1><b>CL_VidMode::width</b></font></a> - Videomode width.<br> <tt><tt><font color=purple>int</font></tt> </tt> <tt><a href="CL_VidMode.html#2398"><tt><font color=blue>width</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <hr noshade> </body> </html>
