<!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>Crystal Space 1.2.1: iImage Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iImage Struct Reference<br>
<small>
[<a class="el" href="group__gfx2d.html">2D</a>]</small>
</h1><!-- doxytag: class="iImage" --><!-- doxytag: inherits="iBase" -->The <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> interface is used to work with image objects.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="image_8h-source.html">igraphic/image.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iImage:</div>
<div class="dynsection">
<p><center><img src="structiImage__inherit__graph.png" border="0" usemap="#iImage__inherit__map" alt="Inheritance graph"></center>
<map name="iImage__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csImageBase, iImage \>" alt="" coords="225,107,543,133"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,107,61,133"><area shape="rect" href="classcsImageBase.html" title="Base class for iImage implementations." alt="" coords="593,107,700,133"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csGLScreenShot, csImageBase \>" alt="" coords="775,5,1180,32"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csImageCubeMapMaker, csImageBase \>" alt="" coords="751,56,1204,83"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csImageMemory, csImageBase \>" alt="" coords="775,107,1180,133"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csImageVolumeMaker, csImageBase \>" alt="" coords="757,157,1197,184"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csScreenShot, csImageBase \>" alt="" coords="784,208,1171,235"><area shape="rect" href="classcsGLScreenShot.html" title="OpenGL screen shot." alt="" coords="1279,5,1407,32"><area shape="rect" href="classcsImageCubeMapMaker.html" title="Wrapper class to create a cube map from a number of 2D images as the cube faces." alt="" coords="1253,56,1432,83"><area shape="rect" href="classcsImageMemory.html" title="Memory image." alt="" coords="1277,107,1408,133"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csCommonImageFile, csImageMemory \>" alt="" coords="1480,107,1936,133"><area shape="rect" href="classcsCommonImageFile.html" title="A base class for image loader plugin iImage implementations." alt="" coords="1984,107,2141,133"><area shape="rect" href="classcsImageVolumeMaker.html" title="Wrapper class to create a volume aka 3D texture from a number of 2D images as the..." alt="" coords="1261,157,1424,184"><area shape="rect" href="classcsScreenShot.html" title="Simple iImage implementation for canvas screenshots." alt="" coords="1288,208,1397,235"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiImage-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#c8bc18376ddca1d07c3711226739cbd4">GetAlpha</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get alpha map for 8-bit paletted image. <a href="#c8bc18376ddca1d07c3711226739cbd4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#af91c32e0a30f974fdcad3919cb5ba66">GetDepth</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image depth (only sensible when the image type is csimg3D). <a href="#af91c32e0a30f974fdcad3919cb5ba66"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#dcfcf95222b2f49662efaf5aca8033c8">GetFormat</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Qyery image format (see CS_IMGFMT_XXX above). <a href="#dcfcf95222b2f49662efaf5aca8033c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#31a45f12e47bbdca9754117200ce9658">GetHeight</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image height. <a href="#31a45f12e47bbdca9754117200ce9658"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#c6ef621537753b4409a003b126d3122c">GetImageData</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get image data: returns either (<a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> *) or (unsigned char *) depending on format. <a href="#c6ef621537753b4409a003b126d3122c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__gfx2d.html#ge62190ffec24a286b2d4b50dcb899469">csImageType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#37f6dc9cf212e9cc0ec34eeb93b12c3b">GetImageType</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the contained image. <a href="#37f6dc9cf212e9cc0ec34eeb93b12c3b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#eb591dea9353b4afc04d012ca0413277">GetKeyColor</a> (int &r, int &g, int &b) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the keycolour stored with the image. <a href="#eb591dea9353b4afc04d012ca0413277"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiImage.html">iImage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#3b83098f175ff487283643be45da9b38">GetMipmap</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> num)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a precomputed mipmap. <a href="#3b83098f175ff487283643be45da9b38"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#0ed17a5a05284bcdc7855238d1aceac3">GetName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get image file name. <a href="#0ed17a5a05284bcdc7855238d1aceac3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="structcsRGBpixel.html">csRGBpixel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#e068da9b43ba09ac4630e2892ff5b623">GetPalette</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get image palette (or 0 if no palette). <a href="#e068da9b43ba09ac4630e2892ff5b623"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiDataBuffer.html">iDataBuffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#865140f81cf37db314331efed7ec1d8a">GetRawData</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the raw data of the image (or 0 if raw data is not provided). <a href="#865140f81cf37db314331efed7ec1d8a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#4ce4fb6f4ceac4e0a917e084080f706d">GetRawFormat</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided). <a href="#4ce4fb6f4ceac4e0a917e084080f706d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiImage.html">iImage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#51536f99e715892c1906811cb3f1ddd0">GetSubImage</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> num)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query a sub image. <a href="#51536f99e715892c1906811cb3f1ddd0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#e46445da6aa7836ce65a1181b9125835">GetWidth</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image width. <a href="#e46445da6aa7836ce65a1181b9125835"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#3a78d763bd95c2bb63bb3d1fc38153b9">HasKeyColor</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if image has a keycolour stored with it. <a href="#3a78d763bd95c2bb63bb3d1fc38153b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#be0ebf813ef5c14192471df9a82bfecc">HasMipmaps</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of mipmaps contained in the image (in case there exist any precalculated mipmaps), in addition to the original image. <a href="#be0ebf813ef5c14192471df9a82bfecc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#83c3d16da129a42d19ce693f28e392e3">HasSubImages</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of sub images, in addition to this image. <a href="#83c3d16da129a42d19ce693f28e392e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiImage.html#fb6d896c16682e094acad01530ec8e6a">SetName</a> (const char *iName)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set image file name. <a href="#fb6d896c16682e094acad01530ec8e6a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> interface is used to work with image objects.
<p>
You cannot manipulate the pixel data of <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> objects directly. To do this, you need to instantiate a your own copy of the image, e.g. by creating a <a class="el" href="classcsImageMemory.html" title="Memory image.">csImageMemory</a> instance (which allows access to the pixel data).<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiImageIO.html#36f654bfa84913494cc45f5e0ca3f50f" title="Load an image from a buffer.">iImageIO::Load()</a></li></ul>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcsImageMemory.html" title="Memory image.">csImageMemory</a>, <a class="el" href="classcsImageManipulate.html" title="Helper class to manipulate iImage objects.">csImageManipulate</a>, <a class="el" href="classcsImageTools.html" title="Some helper functions to deal with iImage objects.">csImageTools</a>, <a class="el" href="classcsImageCubeMapMaker.html" title="Wrapper class to create a cube map from a number of 2D images as the cube faces.">csImageCubeMapMaker</a>, <a class="el" href="classcsImageVolumeMaker.html" title="Wrapper class to create a volume aka 3D texture from a number of 2D images as the...">csImageVolumeMaker</a> </dd></dl>
<p>Definition at line <a class="el" href="image_8h-source.html#l00096">96</a> of file <a class="el" href="image_8h-source.html">image.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c8bc18376ddca1d07c3711226739cbd4"></a><!-- doxytag: member="iImage::GetAlpha" ref="c8bc18376ddca1d07c3711226739cbd4" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a>* iImage::GetAlpha </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get alpha map for 8-bit paletted image.
<p>
RGBA images contains alpha within themself. If image has no alpha map, or the image is in RGBA format, this function will return 0.
<p>Implemented in <a class="el" href="classcsImageBase.html#9088e2e94fb55125292f8bd2e6b71d83">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#daf90be8743b935bcebf931b878c51d4">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#792c385b2e95334f99e2bf0c4f9d73e2">csImageMemory</a>, <a class="el" href="classcsImageVolumeMaker.html#2f88437dcfb8c4a8a61221b102a640f7">csImageVolumeMaker</a>, and <a class="el" href="classcsCommonImageFile.html#52eb4dcce4f38fded746cc8e6df78d33">csCommonImageFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="af91c32e0a30f974fdcad3919cb5ba66"></a><!-- doxytag: member="iImage::GetDepth" ref="af91c32e0a30f974fdcad3919cb5ba66" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iImage::GetDepth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query image depth (only sensible when the image type is csimg3D).
<p>
<p>Implemented in <a class="el" href="classcsImageBase.html#05356f886e5dcb7866294515bf31ed38">csImageBase</a>, <a class="el" href="classcsImageMemory.html#1d0a156069b7eaa44abecd5c96774ec8">csImageMemory</a>, and <a class="el" href="classcsImageVolumeMaker.html#c9864e6490c49cb9af3e4640fb7e54e6">csImageVolumeMaker</a>.</p>
<p>Referenced by <a class="el" href="imagetools_8h-source.html#l00042">csImageTools::ComputeDataSize()</a>.</p>
</div>
</div><p>
<a class="anchor" name="dcfcf95222b2f49662efaf5aca8033c8"></a><!-- doxytag: member="iImage::GetFormat" ref="dcfcf95222b2f49662efaf5aca8033c8" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iImage::GetFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Qyery image format (see CS_IMGFMT_XXX above).
<p>
<p>Implemented in <a class="el" href="classcsImageCubeMapMaker.html#42b0da787053aebbeab41ad8c78c722e">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#c028edc605d3badec020c952e8368dc2">csImageMemory</a>, <a class="el" href="classcsImageVolumeMaker.html#a42e5883f270705815666c3e444910de">csImageVolumeMaker</a>, <a class="el" href="classcsScreenShot.html#be90677cea0bd304532685904d0b92fb">csScreenShot</a>, and <a class="el" href="classcsGLScreenShot.html#76965a2695b8855283dec646377771da">csGLScreenShot</a>.</p>
<p>Referenced by <a class="el" href="imagetools_8h-source.html#l00042">csImageTools::ComputeDataSize()</a>, and <a class="el" href="imageautoconvert_8h-source.html#l00051">CS::ImageAutoConvert::ImageAutoConvert()</a>.</p>
</div>
</div><p>
<a class="anchor" name="31a45f12e47bbdca9754117200ce9658"></a><!-- doxytag: member="iImage::GetHeight" ref="31a45f12e47bbdca9754117200ce9658" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iImage::GetHeight </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query image height.
<p>
<p>Implemented in <a class="el" href="classcsImageCubeMapMaker.html#08b1d618ff2b0cfd6e33efe95beab34e">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#d61754c0e0af35591d725e08a5e72b83">csImageMemory</a>, <a class="el" href="classcsImageVolumeMaker.html#c534fd025a3a75eb984952089dc5d3af">csImageVolumeMaker</a>, <a class="el" href="classcsScreenShot.html#0a2c8bac3fabb723c994324f77a4f29b">csScreenShot</a>, and <a class="el" href="classcsGLScreenShot.html#524cbe56c8437ba44601faedf51881f9">csGLScreenShot</a>.</p>
<p>Referenced by <a class="el" href="imagetools_8h-source.html#l00042">csImageTools::ComputeDataSize()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c6ef621537753b4409a003b126d3122c"></a><!-- doxytag: member="iImage::GetImageData" ref="c6ef621537753b4409a003b126d3122c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const void* iImage::GetImageData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get image data: returns either (<a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> *) or (unsigned char *) depending on format.
<p>
Note that for RGBA images the <a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> structure contains the alpha channel as well, so GetAlpha (see below) method will return 0 (because alpha is not stored separately, as for paletted images).
<p>Implemented in <a class="el" href="classcsImageCubeMapMaker.html#bd77827fc1966df6aec28d3f5b43b857">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#ad1819c50cc745d90b45e513a59bdb9f">csImageMemory</a>, <a class="el" href="classcsImageVolumeMaker.html#e192e3a1098a32850de0c55f19deb7dd">csImageVolumeMaker</a>, <a class="el" href="classcsScreenShot.html#959957f53466a69a1ffd4e11c5957948">csScreenShot</a>, <a class="el" href="classcsCommonImageFile.html#0fc5c8f36c1f8ad9626d339300a8ce11">csCommonImageFile</a>, and <a class="el" href="classcsGLScreenShot.html#45e05911e47d2c1b6bb3f60aefb41ac3">csGLScreenShot</a>.</p>
</div>
</div><p>
<a class="anchor" name="37f6dc9cf212e9cc0ec34eeb93b12c3b"></a><!-- doxytag: member="iImage::GetImageType" ref="37f6dc9cf212e9cc0ec34eeb93b12c3b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__gfx2d.html#ge62190ffec24a286b2d4b50dcb899469">csImageType</a> iImage::GetImageType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the type of the contained image.
<p>
<p>Implemented in <a class="el" href="classcsImageBase.html#851e69042d59791db1276e4daa1280e5">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#57e23729d42b3137d94782b72b66d8e1">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#aa59a1047cdd54de633a79accfca7bc5">csImageMemory</a>, and <a class="el" href="classcsImageVolumeMaker.html#b8be733ec0bdaa934131e00c2afb46c1">csImageVolumeMaker</a>.</p>
</div>
</div><p>
<a class="anchor" name="eb591dea9353b4afc04d012ca0413277"></a><!-- doxytag: member="iImage::GetKeyColor" ref="eb591dea9353b4afc04d012ca0413277" args="(int &r, int &g, int &b) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iImage::GetKeyColor </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>b</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the keycolour stored with the image.
<p>
<p>Implemented in <a class="el" href="classcsImageBase.html#3b394ea924569d578b6b8a7392159b56">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#3e7e0179fea867f85671f8367a83e81b">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#4599b6db9460da15d5f04be8a5fe9ee3">csImageMemory</a>, and <a class="el" href="classcsCommonImageFile.html#3d4f16347be90e13ce89d1d81f8247c7">csCommonImageFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="3b83098f175ff487283643be45da9b38"></a><!-- doxytag: member="iImage::GetMipmap" ref="3b83098f175ff487283643be45da9b38" args="(uint num)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiImage.html">iImage</a>> iImage::GetMipmap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>num</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a precomputed mipmap.
<p>
<em>num</em> specifies which mipmap to return; 0 returns the original image, <em>num</em> <= the return value of <a class="el" href="structiImage.html#be0ebf813ef5c14192471df9a82bfecc" title="Returns the number of mipmaps contained in the image (in case there exist any precalculated...">HasMipmaps()</a> returns that mipmap.
<p>Implemented in <a class="el" href="classcsImageBase.html#65885bfc9872abbc3850437037ddadf7">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#c5f134c33fe9fbfcf62a9585975b502e">csImageCubeMapMaker</a>, and <a class="el" href="classcsImageMemory.html#a1c6e2410cea2aa451d0f6e7dd0a02ba">csImageMemory</a>.</p>
</div>
</div><p>
<a class="anchor" name="0ed17a5a05284bcdc7855238d1aceac3"></a><!-- doxytag: member="iImage::GetName" ref="0ed17a5a05284bcdc7855238d1aceac3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iImage::GetName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get image file name.
<p>
<p>Implemented in <a class="el" href="classcsImageBase.html#cffe6abf869943c09d67a06f62f706e6">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#2b15a9f2e30f90fd82418b9eda0e0b75">csImageCubeMapMaker</a>, and <a class="el" href="classcsImageVolumeMaker.html#86fc346978d9f30e4215572be8ba9ded">csImageVolumeMaker</a>.</p>
</div>
</div><p>
<a class="anchor" name="e068da9b43ba09ac4630e2892ff5b623"></a><!-- doxytag: member="iImage::GetPalette" ref="e068da9b43ba09ac4630e2892ff5b623" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a>* iImage::GetPalette </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get image palette (or 0 if no palette).
<p>
<p>Implemented in <a class="el" href="classcsImageBase.html#b5259fde6544f4ebf4fd6200a75c5efa">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#b8767b4bdbf8d9ef64ed3c5fc8668931">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#678bb2fa71f077c58d30640890ad7b8c">csImageMemory</a>, <a class="el" href="classcsImageVolumeMaker.html#c100fc1164081bf1a6606cc6d0e48734">csImageVolumeMaker</a>, <a class="el" href="classcsScreenShot.html#92cda2de8889a6f5a3b378e872474251">csScreenShot</a>, and <a class="el" href="classcsCommonImageFile.html#930e39e085bc6a905036711f9047788e">csCommonImageFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="865140f81cf37db314331efed7ec1d8a"></a><!-- doxytag: member="iImage::GetRawData" ref="865140f81cf37db314331efed7ec1d8a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiDataBuffer.html">iDataBuffer</a>> iImage::GetRawData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the raw data of the image (or 0 if raw data is not provided).
<p>
<p>Implemented in <a class="el" href="classcsImageBase.html#09cc932884c2812f381df27d2a4d29d4">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#14aaa8b027bc3d77db31bb5808046ce5">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#090a23f2bd3cad916f8f099d3dd2eb6a">csImageMemory</a>, <a class="el" href="classcsImageVolumeMaker.html#b0c93563968e5e6994a25e8f3774e421">csImageVolumeMaker</a>, and <a class="el" href="classcsCommonImageFile.html#ec21772b6225bce4b19c4a5bfeaac688">csCommonImageFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="4ce4fb6f4ceac4e0a917e084080f706d"></a><!-- doxytag: member="iImage::GetRawFormat" ref="4ce4fb6f4ceac4e0a917e084080f706d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iImage::GetRawFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided).
<p>
The format string must be compatible with that supported by <a class="el" href="structiTextureManager.html#c33a27b94680288e287279d7725303dc" title="Create a new texture with the given texture format.">iTextureManager::CreateTexture()</a>. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__gfx3d.html">Texture format strings</a> </dd></dl>
<p>Implemented in <a class="el" href="classcsImageBase.html#bf6f47e3e0c7b6f19f08526abf082b0d">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#6707c60c37d82db16217cf9ae1cb508a">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#5e78e6a1bedf5a2f652791f60a42b2aa">csImageMemory</a>, <a class="el" href="classcsImageVolumeMaker.html#ac94b127bbcae3ffa4b3f57c4fa1c22c">csImageVolumeMaker</a>, and <a class="el" href="classcsCommonImageFile.html#df390477df78180ad356ddd90fe83383">csCommonImageFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="51536f99e715892c1906811cb3f1ddd0"></a><!-- doxytag: member="iImage::GetSubImage" ref="51536f99e715892c1906811cb3f1ddd0" args="(uint num)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiImage.html">iImage</a>> iImage::GetSubImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>num</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query a sub image.
<p>
A value of 0 for <em>num</em> returns the original image, a value larger or equal than the return value of <a class="el" href="structiImage.html#83c3d16da129a42d19ce693f28e392e3" title="Returns the number of sub images, in addition to this image.">HasSubImages()</a> returns that sub image, any other value returns 0.
<p>Implemented in <a class="el" href="classcsImageBase.html#1c9b0cac6e4263c30ea2ef9b2483ac39">csImageBase</a>, and <a class="el" href="classcsImageCubeMapMaker.html#d94bf407ace9f03464dcf19b6a06d3fb">csImageCubeMapMaker</a>.</p>
</div>
</div><p>
<a class="anchor" name="e46445da6aa7836ce65a1181b9125835"></a><!-- doxytag: member="iImage::GetWidth" ref="e46445da6aa7836ce65a1181b9125835" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iImage::GetWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query image width.
<p>
<p>Implemented in <a class="el" href="classcsImageCubeMapMaker.html#00c0fe27b82bbfc21a57cd83a77edf2e">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#f4f7ac725ac7de173b05ba9b64cf7be2">csImageMemory</a>, <a class="el" href="classcsImageVolumeMaker.html#0461e3b10f6f8ba1f1c4764ab8b9e494">csImageVolumeMaker</a>, <a class="el" href="classcsScreenShot.html#68dd4d5cd5a7832689a9b99b79244753">csScreenShot</a>, and <a class="el" href="classcsGLScreenShot.html#21c1660dc928935c88246f576ad73755">csGLScreenShot</a>.</p>
<p>Referenced by <a class="el" href="imagetools_8h-source.html#l00042">csImageTools::ComputeDataSize()</a>.</p>
</div>
</div><p>
<a class="anchor" name="3a78d763bd95c2bb63bb3d1fc38153b9"></a><!-- doxytag: member="iImage::HasKeyColor" ref="3a78d763bd95c2bb63bb3d1fc38153b9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iImage::HasKeyColor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if image has a keycolour stored with it.
<p>
<p>Implemented in <a class="el" href="classcsImageBase.html#0074d236d0bf6c41c5bd71cf471f6506">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#055960080dc6774a34861ee833705283">csImageCubeMapMaker</a>, <a class="el" href="classcsImageMemory.html#3ac872e07d79054d064495b428669dcc">csImageMemory</a>, and <a class="el" href="classcsCommonImageFile.html#421637e134710b348c21c683e4626381">csCommonImageFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="be0ebf813ef5c14192471df9a82bfecc"></a><!-- doxytag: member="iImage::HasMipmaps" ref="be0ebf813ef5c14192471df9a82bfecc" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> iImage::HasMipmaps </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number of mipmaps contained in the image (in case there exist any precalculated mipmaps), in addition to the original image.
<p>
0 means there are no precomputed mipmaps.
<p>Implemented in <a class="el" href="classcsImageBase.html#828abaf036fd86f5be6ababdda0933d2">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#0903f8d02180b8a1b358de9efe228fff">csImageCubeMapMaker</a>, and <a class="el" href="classcsImageMemory.html#556b083728f0a01ebded70e20c137e5b">csImageMemory</a>.</p>
</div>
</div><p>
<a class="anchor" name="83c3d16da129a42d19ce693f28e392e3"></a><!-- doxytag: member="iImage::HasSubImages" ref="83c3d16da129a42d19ce693f28e392e3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> iImage::HasSubImages </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number of sub images, in addition to this image.
<p>
Subimages are usually used for cube map faces.
<p>Implemented in <a class="el" href="classcsImageBase.html#cd8a764af200c94c351677087d66d28e">csImageBase</a>, and <a class="el" href="classcsImageCubeMapMaker.html#52ecf095e206b8a5a9a976d3978fe5ff">csImageCubeMapMaker</a>.</p>
</div>
</div><p>
<a class="anchor" name="fb6d896c16682e094acad01530ec8e6a"></a><!-- doxytag: member="iImage::SetName" ref="fb6d896c16682e094acad01530ec8e6a" args="(const char *iName)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iImage::SetName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iName</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set image file name.
<p>
<p>Implemented in <a class="el" href="classcsImageBase.html#0f830f7221167e2c6094ec8e06e07cab">csImageBase</a>, <a class="el" href="classcsImageCubeMapMaker.html#3759dc12092b59f0889ffb3466d24fbb">csImageCubeMapMaker</a>, and <a class="el" href="classcsImageVolumeMaker.html#016226a450fd922377beaadc22975fc0">csImageVolumeMaker</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>igraphic/<a class="el" href="image_8h-source.html">image.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3109
