<!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>Irrlicht 3D Engine: irr::gui::IGUIImage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Irrlicht 3D Engine
</div>
</td>
<td> <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>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="dynsections.js"></script>
</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('classirr_1_1gui_1_1_i_g_u_i_image.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">irr::gui::IGUIImage Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="irr::gui::IGUIImage" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->
<p>GUI element displaying an image.
<a href="classirr_1_1gui_1_1_i_g_u_i_image.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_i_g_u_i_image_8h_source.html">IGUIImage.h</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::gui::IGUIImage:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classirr_1_1gui_1_1_i_g_u_i_image.png" usemap="#irr::gui::IGUIImage_map" alt=""/>
<map id="irr::gui::IGUIImage_map" name="irr::gui::IGUIImage_map">
<area href="classirr_1_1gui_1_1_i_g_u_i_element.html" title="Base class of all GUI elements." alt="irr::gui::IGUIElement" shape="rect" coords="105,112,305,136"/>
<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" title="An object which is able to serialize and deserialize its attributes into an attributes object..." alt="irr::io::IAttributeExchangingObject" shape="rect" coords="0,56,200,80"/>
<area href="classirr_1_1_i_event_receiver.html" title="Interface of an object which can receive events." alt="irr::IEventReceiver" shape="rect" coords="210,56,410,80"/>
<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,200,24"/>
</map>
</div></div>
<p><a href="classirr_1_1gui_1_1_i_g_u_i_image-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a079a30cd26c749a8a42b4a689678c4dc">IGUIImage</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *environment, <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *parent, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> id, <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > rectangle)
<dl class="el"><dd class="mdescRight">constructor <a href="#a079a30cd26c749a8a42b4a689678c4dc"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a46a6dc23dd045cb65247344bf71078e4">getColor</a> () const =0
<dl class="el"><dd class="mdescRight">Gets the color of the image. <a href="#a46a6dc23dd045cb65247344bf71078e4"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a5ed7402ca9d9810d320ff11f1251e8c0">getImage</a> () const =0
<dl class="el"><dd class="mdescRight">Gets the image texture. <a href="#a5ed7402ca9d9810d320ff11f1251e8c0"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a5be6faec4c156fc955c84a5b3f703d63">isAlphaChannelUsed</a> () const =0
<dl class="el"><dd class="mdescRight">Returns true if the image is using the alpha channel, false if not. <a href="#a5be6faec4c156fc955c84a5b3f703d63"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#aca24045ee740242b9c8de73a8f609a27">isImageScaled</a> () const =0
<dl class="el"><dd class="mdescRight">Returns true if the image is scaled to fit, false if not. <a href="#aca24045ee740242b9c8de73a8f609a27"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#ac836018aafc61f6b9fe88acfa2267d8e">setColor</a> (<a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> color)=0
<dl class="el"><dd class="mdescRight">Sets the color of the image. <a href="#ac836018aafc61f6b9fe88acfa2267d8e"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a35a3af4957e42acb183f562d09a4ea63">setImage</a> (<a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> *image)=0
<dl class="el"><dd class="mdescRight">Sets an image texture. <a href="#a35a3af4957e42acb183f562d09a4ea63"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a642c5683600be82efa0cc04b4236e34d">setScaleImage</a> (bool scale)=0
<dl class="el"><dd class="mdescRight">Sets if the image should scale to fit the element. <a href="#a642c5683600be82efa0cc04b4236e34d"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a9426b40769f4ef7614e6a94dcfa67455">setUseAlphaChannel</a> (bool use)=0
<dl class="el"><dd class="mdescRight">Sets if the image should use its alpha channel to draw itself. <a href="#a9426b40769f4ef7614e6a94dcfa67455"></a><br/></dl></ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>GUI element displaying an image. </p>
<p>Definition at line <a class="el" href="_i_g_u_i_image_8h_source.html#l00020">20</a> of file <a class="el" href="_i_g_u_i_image_8h_source.html">IGUIImage.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a079a30cd26c749a8a42b4a689678c4dc"></a><!-- doxytag: member="irr::gui::IGUIImage::IGUIImage" ref="a079a30cd26c749a8a42b4a689678c4dc" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">irr::gui::IGUIImage::IGUIImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> * </td>
<td class="paramname"><em>environment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> * </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > </td>
<td class="paramname"><em>rectangle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>constructor </p>
<p>Definition at line <a class="el" href="_i_g_u_i_image_8h_source.html#l00025">25</a> of file <a class="el" href="_i_g_u_i_image_8h_source.html">IGUIImage.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a46a6dc23dd045cb65247344bf71078e4"></a><!-- doxytag: member="irr::gui::IGUIImage::getColor" ref="a46a6dc23dd045cb65247344bf71078e4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> irr::gui::IGUIImage::getColor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the color of the image. </p>
</div>
</div>
<a class="anchor" id="a5ed7402ca9d9810d320ff11f1251e8c0"></a><!-- doxytag: member="irr::gui::IGUIImage::getImage" ref="a5ed7402ca9d9810d320ff11f1251e8c0" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a>* irr::gui::IGUIImage::getImage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the image texture. </p>
</div>
</div>
<a class="anchor" id="a5be6faec4c156fc955c84a5b3f703d63"></a><!-- doxytag: member="irr::gui::IGUIImage::isAlphaChannelUsed" ref="a5be6faec4c156fc955c84a5b3f703d63" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUIImage::isAlphaChannelUsed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the image is using the alpha channel, false if not. </p>
</div>
</div>
<a class="anchor" id="aca24045ee740242b9c8de73a8f609a27"></a><!-- doxytag: member="irr::gui::IGUIImage::isImageScaled" ref="aca24045ee740242b9c8de73a8f609a27" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUIImage::isImageScaled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the image is scaled to fit, false if not. </p>
</div>
</div>
<a class="anchor" id="ac836018aafc61f6b9fe88acfa2267d8e"></a><!-- doxytag: member="irr::gui::IGUIImage::setColor" ref="ac836018aafc61f6b9fe88acfa2267d8e" args="(video::SColor color)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIImage::setColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> </td>
<td class="paramname"><em>color</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the color of the image. </p>
</div>
</div>
<a class="anchor" id="a35a3af4957e42acb183f562d09a4ea63"></a><!-- doxytag: member="irr::gui::IGUIImage::setImage" ref="a35a3af4957e42acb183f562d09a4ea63" args="(video::ITexture *image)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIImage::setImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_texture.html">video::ITexture</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets an image texture. </p>
</div>
</div>
<a class="anchor" id="a642c5683600be82efa0cc04b4236e34d"></a><!-- doxytag: member="irr::gui::IGUIImage::setScaleImage" ref="a642c5683600be82efa0cc04b4236e34d" args="(bool scale)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIImage::setScaleImage </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>scale</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets if the image should scale to fit the element. </p>
</div>
</div>
<a class="anchor" id="a9426b40769f4ef7614e6a94dcfa67455"></a><!-- doxytag: member="irr::gui::IGUIImage::setUseAlphaChannel" ref="a9426b40769f4ef7614e6a94dcfa67455" args="(bool use)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIImage::setUseAlphaChannel </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>use</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets if the image should use its alpha channel to draw itself. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_g_u_i_image_8h_source.html">IGUIImage.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
<li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a> </li>
<li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html">IGUIImage</a> </li>
<!-- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</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>
<li class="footer">
<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:44 for Irrlicht 3D Engine by
<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
</ul>
</div>
</body>
</html>
