<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FIFE: FIFE::SDLImage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FIFE <span id="projectnumber">2008.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('class_f_i_f_e_1_1_s_d_l_image.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">FIFE::SDLImage Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="FIFE::SDLImage" --><!-- doxytag: inherits="FIFE::Image" -->
<p><code>#include <<a class="el" href="sdlimage_8h_source.html">sdlimage.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FIFE::SDLImage:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_s_d_l_image__inherit__graph.png" border="0" usemap="#_f_i_f_e_1_1_s_d_l_image_inherit__map" alt="Inheritance graph"/></div>
<map name="_f_i_f_e_1_1_s_d_l_image_inherit__map" id="_f_i_f_e_1_1_s_d_l_image_inherit__map">
<area shape="rect" id="node2" href="class_f_i_f_e_1_1_image.html" title="{FIFE::Image\n|# m_surface\l# m_xshift\l# m_yshift\l# m_clipstack\l# m_area\l# m_isalphaoptimized\l|+ Image()\l+ Image()\l+ invalidate()\l+ render()\l+ render()\l+ detachSurface()\l+ ~Image()\l+ getSurface()\l+ getWidth()\l+ getHeight()\l+ getArea()\l+ setXShift()\l+ getXShift()\l+ setYShift()\l+ getYShift()\l+ getPixelRGBA()\l+ pushClipArea()\l+ popClipArea()\l+ getClipArea()\l+ setAlphaOptimizerEnabled()\l+ isAlphaOptimizerEnabled()\l# setClipArea()\l# saveAsPng()\l# clearClipArea()\l- reset()\l}" alt="" coords="47,534,241,1122"/><area shape="rect" id="node4" href="class_f_i_f_e_1_1_resource_class.html" title="{FIFE::ResourceClass\n|- m_location\l- m_poolid\l|+ ResourceClass()\l+ ~ResourceClass()\l+ getResourceLocation()\l+ getResourceFile()\l+ setResourceLocation()\l+ setResourceFile()\l+ getPoolId()\l+ setPoolId()\l}" alt="" coords="61,261,227,485"/><area shape="rect" id="node6" href="class_f_i_f_e_1_1_fife_class.html" title="{FIFE::FifeClass\n|- m_fifeid\l- m_refcount\l- m_curid\l|+ FifeClass()\l+ ~FifeClass()\l+ getFifeId()\l+ addRef()\l+ decRef()\l+ getRefCount()\l}" alt="" coords="5,6,120,213"/><area shape="rect" id="node8" href="class_f_i_f_e_1_1_i_resource.html" title="{FIFE::IResource\n||+ ~IResource()\l+ getResourceLocation()\l+ getResourceFile()\l+ setResourceLocation()\l+ setResourceFile()\l+ getPoolId()\l+ setPoolId()\l}" alt="" coords="144,15,309,204"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for FIFE::SDLImage:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_s_d_l_image__coll__graph.png" border="0" usemap="#_f_i_f_e_1_1_s_d_l_image_coll__map" alt="Collaboration graph"/></div>
<map name="_f_i_f_e_1_1_s_d_l_image_coll__map" id="_f_i_f_e_1_1_s_d_l_image_coll__map">
<area shape="rect" id="node2" href="class_f_i_f_e_1_1_image.html" title="{FIFE::Image\n|# m_surface\l# m_xshift\l# m_yshift\l# m_clipstack\l# m_area\l# m_isalphaoptimized\l|+ Image()\l+ Image()\l+ invalidate()\l+ render()\l+ render()\l+ detachSurface()\l+ ~Image()\l+ getSurface()\l+ getWidth()\l+ getHeight()\l+ getArea()\l+ setXShift()\l+ getXShift()\l+ setYShift()\l+ getYShift()\l+ getPixelRGBA()\l+ pushClipArea()\l+ popClipArea()\l+ getClipArea()\l+ setAlphaOptimizerEnabled()\l+ isAlphaOptimizerEnabled()\l# setClipArea()\l# saveAsPng()\l# clearClipArea()\l- reset()\l}" alt="" coords="392,625,587,1213"/><area shape="rect" id="node4" href="class_f_i_f_e_1_1_resource_class.html" title="{FIFE::ResourceClass\n|- m_location\l- m_poolid\l|+ ResourceClass()\l+ ~ResourceClass()\l+ getResourceLocation()\l+ getResourceFile()\l+ setResourceLocation()\l+ setResourceFile()\l+ getPoolId()\l+ setPoolId()\l}" alt="" coords="184,324,349,548"/><area shape="rect" id="node6" href="class_f_i_f_e_1_1_fife_class.html" title="{FIFE::FifeClass\n|- m_fifeid\l- m_refcount\l- m_curid\l|+ FifeClass()\l+ ~FifeClass()\l+ getFifeId()\l+ addRef()\l+ decRef()\l+ getRefCount()\l}" alt="" coords="5,23,120,230"/><area shape="rect" id="node8" href="class_f_i_f_e_1_1_i_resource.html" title="{FIFE::IResource\n||+ ~IResource()\l+ getResourceLocation()\l+ getResourceFile()\l+ setResourceLocation()\l+ setResourceFile()\l+ getPoolId()\l+ setPoolId()\l}" alt="" coords="144,32,309,221"/><area shape="rect" id="node10" href="class_f_i_f_e_1_1_resource_location.html" title="{FIFE::ResourceLocation\n|# m_filename\l# m_type\l|+ ResourceLocation()\l+ ~ResourceLocation()\l+ getFilename()\l+ operator==()\l+ operator\<()\l+ clone()\l+ getType()\l}" alt="" coords="333,23,496,230"/><area shape="rect" id="node12" href="class_f_i_f_e_1_1_rect_type.html" title="{FIFE::RectType\< int \>\n|+ x\l+ y\l+ w\l+ h\l|+ RectType()\l+ right()\l+ bottom()\l+ operator==()\l+ contains()\l+ intersects()\l+ intersectInplace()\l}" alt="" coords="496,315,651,557"/><area shape="rect" id="node14" href="class_f_i_f_e_1_1_rect_type.html" title="{FIFE::RectType\< T \>\n|+ x\l+ y\l+ w\l+ h\l|+ RectType()\l+ right()\l+ bottom()\l+ operator==()\l+ contains()\l+ intersects()\l+ intersectInplace()\l}" alt="" coords="520,6,667,247"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_f_i_f_e_1_1_s_d_l_image-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_s_d_l_image.html#a216eeb04b815c190834ae58ef11de945">invalidate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_s_d_l_image.html#aa3b1386205ff83c70a3f25c5ec2ade4f">render</a> (const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> &rect, SDL_Surface *dst, unsigned char alpha=255)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_s_d_l_image.html#ac568aa1b14e098292a494f722de31874">setClipArea</a> (const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> &cliparea, bool clear)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The SDL implementation of the <code><a class="el" href="class_f_i_f_e_1_1_image.html">Image</a></code> base class. </p>
<p>Definition at line <a class="el" href="sdlimage_8h_source.html#l00040">40</a> of file <a class="el" href="sdlimage_8h_source.html">sdlimage.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a216eeb04b815c190834ae58ef11de945"></a><!-- doxytag: member="FIFE::SDLImage::invalidate" ref="a216eeb04b815c190834ae58ef11de945" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::SDLImage::invalidate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invalidates the <a class="el" href="class_f_i_f_e_1_1_image.html">Image</a> causing it to be reset or re-loaded </p>
<p>Implements <a class="el" href="class_f_i_f_e_1_1_image.html#aac67e6a912c345785bd73f4ab3f954c9">FIFE::Image</a>.</p>
<p>Definition at line <a class="el" href="sdlimage_8h_source.html#l00045">45</a> of file <a class="el" href="sdlimage_8h_source.html">sdlimage.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa3b1386205ff83c70a3f25c5ec2ade4f"></a><!-- doxytag: member="FIFE::SDLImage::render" ref="aa3b1386205ff83c70a3f25c5ec2ade4f" args="(const Rect &rect, SDL_Surface *dst, unsigned char alpha=255)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::SDLImage::render </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> & </td>
<td class="paramname"><em>rect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SDL_Surface * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>alpha</em> = <code>255</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Renders itself to the Destination surface at the rectangle rect.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">rect</td><td>The position and clipping where to draw this image to. </td></tr>
<tr><td class="paramname">target</td><td>Target surface to draw to, e.g. main screen or other image </td></tr>
<tr><td class="paramname">alpha</td><td>The alpha value, with which to draw self. opaque by default. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_f_i_f_e_1_1_image.html#afb5dac51e57bc4fcfe92e907348231ca">FIFE::Image</a>.</p>
<p>Definition at line <a class="el" href="sdlimage_8cpp_source.html#l00309">309</a> of file <a class="el" href="sdlimage_8cpp_source.html">sdlimage.cpp</a>.</p>
<p>References <a class="el" href="rect_8h_source.html#l00162">FIFE::RectType< T >::bottom()</a>, <a class="el" href="rect_8h_source.html#l00093">FIFE::RectType< T >::h</a>, <a class="el" href="rect_8h_source.html#l00157">FIFE::RectType< T >::right()</a>, <a class="el" href="rect_8h_source.html#l00090">FIFE::RectType< T >::w</a>, <a class="el" href="rect_8h_source.html#l00084">FIFE::RectType< T >::x</a>, and <a class="el" href="rect_8h_source.html#l00087">FIFE::RectType< T >::y</a>.</p>
</div>
</div>
<a class="anchor" id="ac568aa1b14e098292a494f722de31874"></a><!-- doxytag: member="FIFE::SDLImage::setClipArea" ref="ac568aa1b14e098292a494f722de31874" args="(const Rect &cliparea, bool clear)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::SDLImage::setClipArea </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> & </td>
<td class="paramname"><em>cliparea</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>clear</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets given clip area into image </p>
<dl class="see"><dt><b>See also:</b></dt><dd>pushClipArea </dd></dl>
<p>Implements <a class="el" href="class_f_i_f_e_1_1_image.html#a19dabd135d26a60c8be22f58e7c7364d">FIFE::Image</a>.</p>
<p>Definition at line <a class="el" href="sdlimage_8cpp_source.html#l00834">834</a> of file <a class="el" href="sdlimage_8cpp_source.html">sdlimage.cpp</a>.</p>
<p>References <a class="el" href="rect_8h_source.html#l00093">FIFE::RectType< T >::h</a>, <a class="el" href="rect_8h_source.html#l00090">FIFE::RectType< T >::w</a>, <a class="el" href="rect_8h_source.html#l00084">FIFE::RectType< T >::x</a>, and <a class="el" href="rect_8h_source.html#l00087">FIFE::RectType< T >::y</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>engine/core/video/sdl/<a class="el" href="sdlimage_8h_source.html">sdlimage.h</a></li>
<li>engine/core/video/sdl/<a class="el" href="sdlimage_8cpp_source.html">sdlimage.cpp</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_f_i_f_e.html">FIFE</a> </li>
<li class="navelem"><a class="el" href="class_f_i_f_e_1_1_s_d_l_image.html">SDLImage</a> </li>
<li class="footer">Generated on Sun Jul 10 2011 for FIFE by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</body>
</html>
