<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>SDLmm::VideoInfo class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.8.1 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center> <hr><h1>SDLmm::VideoInfo Class Reference</h1>Video target information. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="sdlmm__videoinfo_8h-source.html">sdlmm_videoinfo.h</a>></code> <p> <a href="classSDLmm_1_1VideoInfo-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a0">GetVideoInfo</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Update the pointer to the video information.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a1">hw_available</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if hardware acceleration is available.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a2">wm_available</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if a window managed is available.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a3">blit_hw</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if hardware to hardware blits are accelerated.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a4">blit_hw_CC</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if hardware to hardware colorkey blits are accelerated.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a5">blit_hw_A</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if hardware to hardware alpha blits are accelerated.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a6">blit_sw</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if software to hardware blits are accelerated.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a7">blit_sw_CC</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if software to hardware colorkey blits are accelerated.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a8">blit_sw_A</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if software to hardware alpha blits are accelerated.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a9">blit_fill</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns true if color fills are accelerated.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>Uint32 </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a10">video_mem</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns the total amount of video memory in kilobytes.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>const <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a11">GetPixelFormat</a> () const</td></tr> <tr><td> </td><td><font size=-1><em>Returns the SDL_PixelFormat struct for the video device.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#a12">GetPixelFormat</a> ()</td></tr> <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> <tr><td nowrap align=right valign=top>const SDL_VideoInfo* </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html#m0">me</a></td></tr> <tr><td> </td><td><font size=-1><em>The video info struct.</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Video target information. <p> This object contains read-only information about the video hardware. If this is called before <a class="el" href="classSDLmm_1_1Display.html#a6">Display::SetVideoMode</a>(), the vfmt member of the returned structure will contain the pixel format of the "best" video mode. <p> <dl compact><dt> <b><a class="el" href="todo.html#_todo000003">Todo: </a></b><dd> Build a status function allowing for easier access to the flags. This can be done using a bitfield which would allow for checking for multiple features at once.</dl> <dl compact><dt> <b>Warning: </b><dd> Before using information from <a class="el" href="classSDLmm_1_1VideoInfo.html">VideoInfo</a>, the video subsystem must already be initialized. </dl><dl compact><dt> <b>See also: </b><dd> <a class="el" href="classSDLmm_1_1Display.html#d1">Display::Init</a>(), <a class="el" href="classSDLmm_1_1Display.html#a6">Display::SetVideoMode</a>() </dl> <p> <hr><h2>Member Function Documentation</h2> <a name="a12" doxytag="SDLmm::VideoInfo::GetPixelFormat"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> SDLmm::VideoInfo::GetPixelFormat ( </b></td> <td valign="bottom"><b> )<code> [inline]</code> </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a11" doxytag="SDLmm::VideoInfo::GetPixelFormat"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> const <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> SDLmm::VideoInfo::GetPixelFormat ( </b></td> <td valign="bottom"><b> ) const<code> [inline]</code> </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns the SDL_PixelFormat struct for the video device. <p> </td> </tr> </table> <a name="a0" doxytag="SDLmm::VideoInfo::GetVideoInfo"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::GetVideoInfo ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Update the pointer to the video information. <p> <dl compact><dt> <b>Returns: </b><dd> If the update fails, <a class="el" href="classSDLmm_1_1VideoInfo.html#m0">VideoInfo::me</a> is set to zero and false is returned. true is returned for success. <p> </dl><dl compact><dt> <b>Note: </b><dd> The pointer stored in this object should be updated automatically so there should be no need for the programmer to call this function manually. </dl> </td> </tr> </table> <a name="a9" doxytag="SDLmm::VideoInfo::blit_fill"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::blit_fill ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if color fills are accelerated. <p> </td> </tr> </table> <a name="a3" doxytag="SDLmm::VideoInfo::blit_hw"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::blit_hw ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if hardware to hardware blits are accelerated. <p> </td> </tr> </table> <a name="a5" doxytag="SDLmm::VideoInfo::blit_hw_A"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::blit_hw_A ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if hardware to hardware alpha blits are accelerated. <p> </td> </tr> </table> <a name="a4" doxytag="SDLmm::VideoInfo::blit_hw_CC"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::blit_hw_CC ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if hardware to hardware colorkey blits are accelerated. <p> </td> </tr> </table> <a name="a6" doxytag="SDLmm::VideoInfo::blit_sw"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::blit_sw ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if software to hardware blits are accelerated. <p> </td> </tr> </table> <a name="a8" doxytag="SDLmm::VideoInfo::blit_sw_A"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::blit_sw_A ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if software to hardware alpha blits are accelerated. <p> </td> </tr> </table> <a name="a7" doxytag="SDLmm::VideoInfo::blit_sw_CC"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::blit_sw_CC ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if software to hardware colorkey blits are accelerated. <p> </td> </tr> </table> <a name="a1" doxytag="SDLmm::VideoInfo::hw_available"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::hw_available ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if hardware acceleration is available. <p> </td> </tr> </table> <a name="a10" doxytag="SDLmm::VideoInfo::video_mem"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> Uint32 SDLmm::VideoInfo::video_mem ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns the total amount of video memory in kilobytes. <p> </td> </tr> </table> <a name="a2" doxytag="SDLmm::VideoInfo::wm_available"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> bool SDLmm::VideoInfo::wm_available ( </b></td> <td valign="bottom"><b> ) </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true if a window managed is available. <p> </td> </tr> </table> <hr><h2>Member Data Documentation</h2> <a name="m0" doxytag="SDLmm::VideoInfo::me"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> const SDL_VideoInfo * SDLmm::VideoInfo::me </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> The video info struct. <p> This struct contains the information about the display. You can access it directly or use the <a class="el" href="classSDLmm_1_1VideoInfo.html">VideoInfo</a> functions like <a class="el" href="classSDLmm_1_1VideoInfo.html#a1">VideoInfo::hw_available</a>(). The data stored in this pointer can be updated (if needed) using <a class="el" href="classSDLmm_1_1VideoInfo.html#a0">VideoInfo::GetVideoInfo</a>(). </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="sdlmm__videoinfo_8h-source.html">sdlmm_videoinfo.h</a><li><a class="el" href="sdlmm__videoinfo_8cpp.html">sdlmm_videoinfo.cpp</a></ul> <hr> <table cellspacing=10 cellpadding=0 border=0 width=100%> <tr valign=middle><td><font size=-1>Documentation automatically generated by <a href="http://www.stack.nl/~dimitri/doxygen/"><img border=0 align=center src="doxygen.gif" alt="doxygen"></a> written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.</font></td> <td align=right><font size=-1>Project hosted at <br><a href="http://sourceforge.net"><img align=middle src="http://sourceforge.net/sflogo.php?group_id=25445&type=1" width="88" height="31" border="0" alt="Hosted by SourceForge"></a></font></td></tr></table>