<!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 Namespace 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 Namespace Reference</h1>The namespace for the SDLmm library.
<a href="#_details">More...</a>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1Audio.html">SDLmm::Audio</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1BaseSurface.html">SDLmm::BaseSurface</a></td></tr>
<tr><td> </td><td><font size=-1><em>An abstract base class for graphical surfaces.</em> <a href="classSDLmm_1_1BaseSurface.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1CD.html">SDLmm::CD</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1ColorRGB.html">SDLmm::ColorRGB</a></td></tr>
<tr><td> </td><td><font size=-1><em>A small usefull class representing an RGB color.</em> <a href="classSDLmm_1_1ColorRGB.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1ColorRGBA.html">SDLmm::ColorRGBA</a></td></tr>
<tr><td> </td><td><font size=-1><em>A small usefull class representing an RGBA color.</em> <a href="classSDLmm_1_1ColorRGBA.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1Display.html">SDLmm::Display</a></td></tr>
<tr><td> </td><td><font size=-1><em>The video frame buffer surface.</em> <a href="classSDLmm_1_1Display.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1Event.html">SDLmm::Event</a></td></tr>
<tr><td> </td><td><font size=-1><em>The general <a class="el" href="classSDLmm_1_1Event.html">Event</a> class.</em> <a href="classSDLmm_1_1Event.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html">SDLmm::EventHandler</a></td></tr>
<tr><td> </td><td><font size=-1><em>The base class used for custom <a class="el" href="classSDLmm_1_1Event.html">Event</a> handlers.</em> <a href="classSDLmm_1_1EventHandler.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1Joystick.html">SDLmm::Joystick</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html">SDLmm::PixelFormat</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html">SDLmm::SPoint</a></td></tr>
<tr><td> </td><td><font size=-1><em>A small usefull class representing a point in 2 dimensional space.</em> <a href="classSDLmm_1_1SPoint.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1SRect.html">SDLmm::SRect</a></td></tr>
<tr><td> </td><td><font size=-1><em>This enhanced version of <em><a class="el" href="structSDL__Rect.html">SDL_Rect</a></em> includes a number of handy short-hand constructors. Since the class is derived from the <a class="el" href="structSDL__Rect.html">SDL_Rect</a> struct, it can be used in any context where an <em><a class="el" href="structSDL__Rect.html">SDL_Rect</a></em> is valid.</em> <a href="classSDLmm_1_1SRect.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1Surface.html">SDLmm::Surface</a></td></tr>
<tr><td> </td><td><font size=-1><em>A graphical surface structure which is used to store graphical data.</em> <a href="classSDLmm_1_1Surface.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1Timer.html">SDLmm::Timer</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classSDLmm_1_1VideoInfo.html">SDLmm::VideoInfo</a></td></tr>
<tr><td> </td><td><font size=-1><em>Video target information.</em> <a href="classSDLmm_1_1VideoInfo.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef Uint32 </td><td valign=bottom><a class="el" href="namespace__SDLmm.html#a0">Color</a></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="namespace__SDLmm.html#a1">Init</a> (Uint32 flags)</td></tr>
<tr><td> </td><td><font size=-1><em>Initializes SDL.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="namespace__SDLmm.html#a2">Quit</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Shut down SDL.</em> <a href="#a2">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="namespace__SDLmm.html#a3">WasInit</a> (Uint32 flags)</td></tr>
<tr><td> </td><td><font size=-1><em>Check which subsystems are initialized.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const char* </td><td valign=bottom><a class="el" href="namespace__SDLmm.html#a4">GetError</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Get the latest error message.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const char* </td><td valign=bottom><a class="el" href="namespace__SDLmm.html#a5">version</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Return the SDLmm library version.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The namespace for the SDLmm library.<hr><h2>Typedef Documentation</h2>
<a name="a0" doxytag="SDLmm::Color"></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>
typedef Uint32 SDLmm::Color
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a4" doxytag="SDLmm::GetError"></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 char * SDLmm::GetError (
</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>
Get the latest error message.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
The error message for the last SDL function that failed. </dl> </td>
</tr>
</table>
<a name="a1" doxytag="SDLmm::Init"></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::Init (
</b></td>
<td valign="bottom"><b>
Uint32 <em>flags</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initializes SDL.
<p>
This method should be called before utilizing any other SDL or SDLmm functionality. The flags parameter specifies what part(s) of SDL to initialize (see the SDL documentation for details). <dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>flags</em>
</td><td>
the subsystems to initalize </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true on success, false on error
<p>
</dl><dl compact><dt>
<b>Note: </b><dd>
In SDLmm the preferred way of initiating subsystem is to use the <a class="el" href="namespace__SDLmm.html#a1">Init</a>() function in the subsystem classes. I.e to initialize audio and video, run <a class="el" href="classSDLmm_1_1Display.html#d1">Display::Init</a>() and <a class="el" href="classSDLmm_1_1Audio.html#d0">Audio::Init</a>(). Also note that instantiating an object might be enough (for example creating a <a class="el" href="classSDLmm_1_1VideoInfo.html">VideoInfo</a> instance will initialize the video subsystem). </dl> </td>
</tr>
</table>
<a name="a2" doxytag="SDLmm::Quit"></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>
void SDLmm::Quit (
</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>
Shut down SDL.
<p>
<a class="el" href="namespace__SDLmm.html#a2">Quit</a>() shuts down all SDL subsystems and frees the resources allocated to them. This should always be called before you exit. For the sake of simplicity you can set <a class="el" href="namespace__SDLmm.html#a2">Quit</a>() as your atexit call, like this:
<p>
<div class="fragment"><pre> <a class="code" href="namespace__SDLmm.html#a1">SDLmm::Init</a>(SDL_INIT_VIDEO|SDL_INIT_AUDIO);
atexit(SDLmm::Quit);</pre></div> </td>
</tr>
</table>
<a name="a3" doxytag="SDLmm::WasInit"></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::WasInit (
</b></td>
<td valign="bottom"><b>
Uint32 <em>flags</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Check which subsystems are initialized.
<p>
This allows you to see which SDL subsytems have been initialized. <dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>flags</em>
</td><td>
bitwise OR'd combination of the subsystems you wish to check </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
A bitwised OR'd combination of the initialized subsystems. </dl> </td>
</tr>
</table>
<a name="a5" doxytag="SDLmm::version"></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 char * SDLmm::version (
</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>
Return the SDLmm library version.
<p>
</td>
</tr>
</table>
<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>
distrib
>
PLD
>
ac
>
amd64
>
media
>
dist
>
by-pkgid
>
d1f0df1429f50a2dc3896b450131d5eb
>
files
>
84
