Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > efd2f02d3f11cbd298bc69a2fbc20533 > files > 426

fife-doc-0.3.2-5.r2.fc15.noarch.rpm

<!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::Image 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&#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_image.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">FIFE::Image Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="FIFE::Image" --><!-- doxytag: inherits="FIFE::ResourceClass,FIFE::AbstractImage" -->
<p><code>#include &lt;<a class="el" href="image_8h_source.html">image.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FIFE::Image:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_image__inherit__graph.png" border="0" usemap="#_f_i_f_e_1_1_image_inherit__map" alt="Inheritance graph"/></div>
<map name="_f_i_f_e_1_1_image_inherit__map" id="_f_i_f_e_1_1_image_inherit__map">
<area shape="rect" id="node9" href="class_f_i_f_e_1_1_g_l_image.html" title="{FIFE::GLImage\n|&#45; m_col_tex_coord\l&#45; m_row_tex_coord\l&#45; m_textureids\l&#45; m_sdlimage\l&#45; m_chunk_size_w\l&#45; m_chunk_size_h\l&#45; m_colorkey\l|+ GLImage()\l+ GLImage()\l+ ~GLImage()\l+ invalidate()\l+ render()\l+ saveImage()\l+ putPixel()\l+ drawLine()\l+ drawTriangle()\l+ drawRectangle()\l+ fillRectangle()\l+ drawQuad()\l+ drawVertex()\l+ drawLightPrimitive()\l# setClipArea()\l&#45; cleanup()\l&#45; resetGlimage()\l&#45; generateGLTexture()\l}" alt="" coords="5,1171,155,1655"/><area shape="rect" id="node11" href="class_f_i_f_e_1_1_s_d_l_image.html" title="{FIFE::SDLImage\n|&#45; m_last_alpha\l&#45; m_finalized\l&#45; m_colorkey\l&#45; m_zoom_surface\l&#45; m_scale_x\l&#45; m_scale_y\l|+ SDLImage()\l+ SDLImage()\l+ ~SDLImage()\l+ invalidate()\l+ render()\l+ saveImage()\l+ putPixel()\l+ drawLine()\l+ drawTriangle()\l+ drawRectangle()\l+ fillRectangle()\l+ drawQuad()\l+ drawVertex()\l+ drawLightPrimitive()\l# setClipArea()\l&#45; finalize()\l&#45; optimize()\l&#45; resetSdlimage()\l}" alt="" coords="179,1180,328,1647"/><area shape="rect" id="node2" href="class_f_i_f_e_1_1_resource_class.html" title="{FIFE::ResourceClass\n|&#45; m_location\l&#45; m_poolid\l|+ ResourceClass()\l+ ~ResourceClass()\l+ getResourceLocation()\l+ getResourceFile()\l+ setResourceLocation()\l+ setResourceFile()\l+ getPoolId()\l+ setPoolId()\l}" alt="" coords="84,261,249,485"/><area shape="rect" id="node4" href="class_f_i_f_e_1_1_fife_class.html" title="{FIFE::FifeClass\n|&#45; m_fifeid\l&#45; m_refcount\l&#45; m_curid\l|+ FifeClass()\l+ ~FifeClass()\l+ getFifeId()\l+ addRef()\l+ decRef()\l+ getRefCount()\l}" alt="" coords="28,6,143,213"/><area shape="rect" id="node6" 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="167,15,332,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::Image:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_image__coll__graph.png" border="0" usemap="#_f_i_f_e_1_1_image_coll__map" alt="Collaboration graph"/></div>
<map name="_f_i_f_e_1_1_image_coll__map" id="_f_i_f_e_1_1_image_coll__map">
<area shape="rect" id="node2" href="class_f_i_f_e_1_1_resource_class.html" title="{FIFE::ResourceClass\n|&#45; m_location\l&#45; 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="node4" href="class_f_i_f_e_1_1_fife_class.html" title="{FIFE::FifeClass\n|&#45; m_fifeid\l&#45; m_refcount\l&#45; 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="node6" 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="node8" 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\&lt;()\l+ clone()\l+ getType()\l}" alt="" coords="333,23,496,230"/><area shape="rect" id="node10" href="class_f_i_f_e_1_1_rect_type.html" title="{FIFE::RectType\&lt; int \&gt;\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="node12" href="class_f_i_f_e_1_1_rect_type.html" title="{FIFE::RectType\&lt; T \&gt;\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_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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_image.html#a3ff36053674d274a137c937415decec4">Image</a> (SDL_Surface *surface)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_image.html#a3f11c9931b97edc8a236b30fc414b832">Image</a> (const uint8_t *data, unsigned int width, unsigned int height)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_image.html#aac67e6a912c345785bd73f4ab3f954c9">invalidate</a> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_image.html#afb5dac51e57bc4fcfe92e907348231ca">render</a> (const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> &amp;rect, SDL_Surface *dst, unsigned char alpha=255)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_image.html#ad6136a54255ce795cd42b3f9b638edd3">render</a> (const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> &amp;rect, unsigned char alpha=255)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SDL_Surface *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_image.html#aef146245c6d9f7e142121bab1f2fbd36">detachSurface</a> ()</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">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_image.html#a19dabd135d26a60c8be22f58e7c7364d">setClipArea</a> (const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> &amp;cliparea, bool clear)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_image.html#ab65d8b30628a314ce2d08d4dc34d602f">clearClipArea</a> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base Class for Images. </p>

<p>Definition at line <a class="el" href="image_8h_source.html#l00138">138</a> of file <a class="el" href="image_8h_source.html">image.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3ff36053674d274a137c937415decec4"></a><!-- doxytag: member="FIFE::Image::Image" ref="a3ff36053674d274a137c937415decec4" args="(SDL_Surface *surface)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FIFE::Image::Image </td>
          <td>(</td>
          <td class="paramtype">SDL_Surface *&#160;</td>
          <td class="paramname"><em>surface</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Takes ownership of the SDL Surface </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">surface</td><td>SDL Surface in RGBA format </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="image_8cpp_source.html#l00037">37</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a3f11c9931b97edc8a236b30fc414b832"></a><!-- doxytag: member="FIFE::Image::Image" ref="a3f11c9931b97edc8a236b30fc414b832" args="(const uint8_t *data, unsigned int width, unsigned int height)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FIFE::Image::Image </td>
          <td>(</td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>height</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>Pointer to the imagedata (needs to be in RGBA, 8 bits per channel). </td></tr>
    <tr><td class="paramname">width</td><td>Width of the image. </td></tr>
    <tr><td class="paramname">height</td><td>Height of the image. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="image_8cpp_source.html#l00042">42</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab65d8b30628a314ce2d08d4dc34d602f"></a><!-- doxytag: member="FIFE::Image::clearClipArea" ref="ab65d8b30628a314ce2d08d4dc34d602f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void FIFE::Image::clearClipArea </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Clears any possible clip areas </p>
<dl class="see"><dt><b>See also:</b></dt><dd>pushClipArea </dd></dl>

<p>Definition at line <a class="el" href="image_8cpp_source.html#l00171">171</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>

<p>References <a class="el" href="class_f_i_f_e_1_1_image.html#a19dabd135d26a60c8be22f58e7c7364d">setClipArea()</a>.</p>

</div>
</div>
<a class="anchor" id="aef146245c6d9f7e142121bab1f2fbd36"></a><!-- doxytag: member="FIFE::Image::detachSurface" ref="aef146245c6d9f7e142121bab1f2fbd36" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SDL_Surface * FIFE::Image::detachSurface </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Removes underlying SDL_Surface from the image (if exists) and returns this </p>
<dl class="note"><dt><b>Note:</b></dt><dd>this effectively causes SDL_Surface not to be freed on destruction </dd></dl>

<p>Definition at line <a class="el" href="image_8cpp_source.html#l00074">74</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aac67e6a912c345785bd73f4ab3f954c9"></a><!-- doxytag: member="FIFE::Image::invalidate" ref="aac67e6a912c345785bd73f4ab3f954c9" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void FIFE::Image::invalidate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [pure 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>Implemented in <a class="el" href="class_f_i_f_e_1_1_g_l_image.html#a114fe0299b2a168b99107e058290d4a9">FIFE::GLImage</a>, and <a class="el" href="class_f_i_f_e_1_1_s_d_l_image.html#a216eeb04b815c190834ae58ef11de945">FIFE::SDLImage</a>.</p>

</div>
</div>
<a class="anchor" id="afb5dac51e57bc4fcfe92e907348231ca"></a><!-- doxytag: member="FIFE::Image::render" ref="afb5dac51e57bc4fcfe92e907348231ca" args="(const Rect &amp;rect, SDL_Surface *dst, unsigned char alpha=255)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void FIFE::Image::render </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> &amp;&#160;</td>
          <td class="paramname"><em>rect</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">SDL_Surface *&#160;</td>
          <td class="paramname"><em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&#160;</td>
          <td class="paramname"><em>alpha</em> = <code>255</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure 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>Implemented in <a class="el" href="class_f_i_f_e_1_1_g_l_image.html#abb2608d313999ceff1908b69888388d6">FIFE::GLImage</a>, and <a class="el" href="class_f_i_f_e_1_1_s_d_l_image.html#aa3b1386205ff83c70a3f25c5ec2ade4f">FIFE::SDLImage</a>.</p>

<p>Referenced by <a class="el" href="cursor_8cpp_source.html#l00145">FIFE::Cursor::draw()</a>, and <a class="el" href="image_8cpp_source.html#l00140">render()</a>.</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_image_afb5dac51e57bc4fcfe92e907348231ca_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_image_afb5dac51e57bc4fcfe92e907348231ca_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_image_afb5dac51e57bc4fcfe92e907348231ca_icgraph" id="class_f_i_f_e_1_1_image_afb5dac51e57bc4fcfe92e907348231ca_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_cursor.html#af570d8c901ab5b833d8cb819b0760fca" title="FIFE::Cursor::draw" alt="" coords="195,5,328,35"/><area shape="rect" id="node7" href="class_f_i_f_e_1_1_image.html#ad6136a54255ce795cd42b3f9b638edd3" title="FIFE::Image::render" alt="" coords="192,59,331,88"/><area shape="rect" id="node5" href="class_f_i_f_e_1_1_engine.html#aaa1ab7210b65c1b610117515a68c7c40" title="FIFE::Engine::pump" alt="" coords="379,5,517,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="ad6136a54255ce795cd42b3f9b638edd3"></a><!-- doxytag: member="FIFE::Image::render" ref="ad6136a54255ce795cd42b3f9b638edd3" args="(const Rect &amp;rect, unsigned char alpha=255)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void FIFE::Image::render </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> &amp;&#160;</td>
          <td class="paramname"><em>rect</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&#160;</td>
          <td class="paramname"><em>alpha</em> = <code>255</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Renders itself to the main screen at the rectangle rect. Convenience function </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">alpha</td><td>The alpha value, with which to draw self. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="image_8cpp_source.html#l00140">140</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>

<p>References <a class="el" href="class_f_i_f_e_1_1_image.html#afb5dac51e57bc4fcfe92e907348231ca">render()</a>.</p>

</div>
</div>
<a class="anchor" id="a19dabd135d26a60c8be22f58e7c7364d"></a><!-- doxytag: member="FIFE::Image::setClipArea" ref="a19dabd135d26a60c8be22f58e7c7364d" args="(const Rect &amp;cliparea, bool clear)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void FIFE::Image::setClipArea </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_f_i_f_e_1_1_rect_type.html">Rect</a> &amp;&#160;</td>
          <td class="paramname"><em>cliparea</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>clear</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [protected, pure 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>Implemented in <a class="el" href="class_f_i_f_e_1_1_g_l_image.html#a7326fc5d66d522c77e6d70d057162683">FIFE::GLImage</a>, and <a class="el" href="class_f_i_f_e_1_1_s_d_l_image.html#ac568aa1b14e098292a494f722de31874">FIFE::SDLImage</a>.</p>

<p>Referenced by <a class="el" href="image_8cpp_source.html#l00171">clearClipArea()</a>.</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_image_a19dabd135d26a60c8be22f58e7c7364d_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_image_a19dabd135d26a60c8be22f58e7c7364d_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_image_a19dabd135d26a60c8be22f58e7c7364d_icgraph" id="class_f_i_f_e_1_1_image_a19dabd135d26a60c8be22f58e7c7364d_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_image.html#ab65d8b30628a314ce2d08d4dc34d602f" title="FIFE::Image::clearClipArea" alt="" coords="224,5,405,35"/></map>
</div>
</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>engine/core/video/<a class="el" href="image_8h_source.html">image.h</a></li>
<li>engine/core/video/<a class="el" href="image_8cpp_source.html">image.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_image.html">Image</a>      </li>
      <li class="footer">Generated on Sun Jul 10 2011 for FIFE by&#160;
<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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</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>