<!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>Irrlicht Engine: irr::gui::IGUIImage Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
<tr valign="middle">
<td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a>
| <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a>
| <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a>
| <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical
List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF">
Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a>
| <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF">
Namespace Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class
members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File
members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
</tr>
</table>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="namespaceirr_1_1gui.html">gui</a>::<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html">IGUIImage</a>
</div>
<div class="contents">
<h1>irr::gui::IGUIImage Class Reference</h1><!-- doxytag: class="irr::gui::IGUIImage" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->
<p>GUI element displaying an image.
<a href="#_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 class="dynheader">
Inheritance diagram for irr::gui::IGUIImage:</div>
<div class="dynsection">
<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" alt="irr::gui::IGUIElement" shape="rect" coords="105,112,305,136"/>
<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" alt="irr::io::IAttributeExchangingObject" shape="rect" coords="0,56,200,80"/>
<area href="classirr_1_1_i_event_receiver.html" alt="irr::IEventReceiver" shape="rect" coords="210,56,410,80"/>
<area href="classirr_1_1_i_reference_counted.html" 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>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><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)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a079a30cd26c749a8a42b4a689678c4dc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a5be6faec4c156fc955c84a5b3f703d63">isAlphaChannelUsed</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the image is using the alpha channel, false if not. <a href="#a5be6faec4c156fc955c84a5b3f703d63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#aca24045ee740242b9c8de73a8f609a27">isImageScaled</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the image is scaled to fit, false if not. <a href="#aca24045ee740242b9c8de73a8f609a27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><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</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the colour of the image. <a href="#ac836018aafc61f6b9fe88acfa2267d8e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><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</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets an image. <a href="#a35a3af4957e42acb183f562d09a4ea63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a642c5683600be82efa0cc04b4236e34d">setScaleImage</a> (bool scale)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets if the image should scale to fit the element. <a href="#a642c5683600be82efa0cc04b4236e34d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image.html#a9426b40769f4ef7614e6a94dcfa67455">setUseAlphaChannel</a> (bool use)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets if the image should use its alpha channel to draw itself. <a href="#a9426b40769f4ef7614e6a94dcfa67455"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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>
<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><td> </td>
</tr>
<tr>
<td></td>
<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="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 colour 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. </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>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
<tr>
<td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
<td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2010 by Nikolaus Gebhardt. Generated
on Sun Oct 24 12:42:04 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a>
(1.6.2)</font></em></small></div></td>
</tr>
</table>
<address style="align: right;">
</address>
</body>
</html>
