<!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: csImageMemory Class 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>csImageMemory Class Reference<br>
<small>
[<a class="el" href="group__gfx.html">Graphics</a>]</small>
</h1><!-- doxytag: class="csImageMemory" --><!-- doxytag: inherits="scfImplementationExt0< csImageMemory, csImageBase >" -->Memory image.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="imagememory_8h-source.html">csgfx/imagememory.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csImageMemory:</div>
<div class="dynsection">
<p><center><img src="classcsImageMemory__inherit__graph.png" border="0" usemap="#csImageMemory__inherit__map" alt="Inheritance graph"></center>
<map name="csImageMemory__inherit__map">
<area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csCommonImageFile, csImageMemory \>" alt="" coords="5,471,461,497"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csImageMemory, csImageBase \>" alt="" coords="31,316,436,343"><area shape="rect" href="classcsImageBase.html" title="Base class for iImage implementations." alt="" coords="180,239,287,265"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csImageBase, iImage \>" alt="" coords="75,161,392,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csImageBase \>" alt="" coords="12,84,271,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="287,7,343,33"><area shape="rect" href="structiImage.html" title="The iImage interface is used to work with image objects." alt="" coords="295,84,359,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="31,7,252,33"><area shape="rect" href="classcsCommonImageFile.html" title="A base class for image loader plugin iImage implementations." alt="" coords="155,548,312,575"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsImageMemory-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"><a class="anchor" name="cf6e1d49a6f2ed6546fe3d5c51bb11d0"></a><!-- doxytag: member="csImageMemory::ApplyKeycolor" ref="cf6e1d49a6f2ed6546fe3d5c51bb11d0" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#cf6e1d49a6f2ed6546fe3d5c51bb11d0">ApplyKeycolor</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#04dac16891c1aace0177b49da0831f61">ApplyKeyColor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply the keycolor, that is, set all pixels which match the keycolor to 0. <a href="#04dac16891c1aace0177b49da0831f61"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#e2ea3219ce32aa79f12e4e5f9fdcd836">CheckAlpha</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if all alpha values are "non-transparent" and if so, discard alpha. <a href="#e2ea3219ce32aa79f12e4e5f9fdcd836"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#a6b4a6764b8e26f756a6215b7a119e6f">Clear</a> (const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> &colour)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears image to colour. Only works for truecolor images. <a href="#a6b4a6764b8e26f756a6215b7a119e6f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6c2bf263283224faebc2f25ab4f5232"></a><!-- doxytag: member="csImageMemory::ClearKeycolor" ref="e6c2bf263283224faebc2f25ab4f5232" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#e6c2bf263283224faebc2f25ab4f5232">ClearKeycolor</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#7f275eba09445db90755268b26aaba36">ClearKeyColor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the keycolor. <a href="#7f275eba09445db90755268b26aaba36"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#9c0af2658e099b8ee77e44c3e82957b7">ConvertFromPal8</a> (<a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> *<a class="el" href="structiImage.html">iImage</a>, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> *alpha, const <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> *iPalette, int nPalColors=256)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to convert an 8-bit indexed image into requested format. <a href="#9c0af2658e099b8ee77e44c3e82957b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#0e9ddd476e7d0b11e6534e816a6471bb">ConvertFromPal8</a> (<a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> *<a class="el" href="structiImage.html">iImage</a>, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> *alpha, <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> *iPalette, int nPalColors=256)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to convert an 8-bit indexed image into requested format. <a href="#0e9ddd476e7d0b11e6534e816a6471bb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#b19aa3b8fab76128f61eed2facf386d6">ConvertFromRGBA</a> (<a class="el" href="structcsRGBpixel.html">csRGBpixel</a> *<a class="el" href="structiImage.html">iImage</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to convert an truecolor RGB image into requested format. <a href="#b19aa3b8fab76128f61eed2facf386d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#b10e64493f06406d0491eb36a7a7b400">Copy</a> (<a class="el" href="structiImage.html">iImage</a> *srcImage, int x, int y, int width, int height)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy an image as subpart into this image. <a href="#b10e64493f06406d0491eb36a7a7b400"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#5ca4c758ad1a006618fc5771e8f858e9">CopyScale</a> (<a class="el" href="structiImage.html">iImage</a> *srcImage, int x, int y, int width, int height)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy an image as subpart into this image with scaling <em>sImage</em> to the given size. <a href="#5ca4c758ad1a006618fc5771e8f858e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#75da373784c2a91d73da0f8193c31bef">CopyTile</a> (<a class="el" href="structiImage.html">iImage</a> *srcImage, int x, int y, int width, int height)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy an image as subpart into this image and tile and scale <em>sImage</em> to the given size. <a href="#75da373784c2a91d73da0f8193c31bef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#a178d643df48667f30f266e57a278673">csImageMemory</a> (<a class="el" href="structiImage.html">iImage</a> *source, int newFormat)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance that copies the pixel data from another <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> object, and also change the data format. <a href="#a178d643df48667f30f266e57a278673"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#c8d4ec9f822a6d0310f3de207bda9c74">csImageMemory</a> (<a class="el" href="structiImage.html">iImage</a> *source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance that copies the pixel data from another <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> object. <a href="#c8d4ec9f822a6d0310f3de207bda9c74"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#34d4ed5bf5d44c3c86dd805630a49623">csImageMemory</a> (int width, int height, const void *buffer, int format=CS_IMGFMT_TRUECOLOR, const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> *palette=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance from a pixel buffer with these dimensions. <a href="#34d4ed5bf5d44c3c86dd805630a49623"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#bc0ec0141d209074783e13cfbc3d3fba">csImageMemory</a> (int width, int height, void *buffer, bool destroy, int format=CS_IMGFMT_TRUECOLOR, <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> *palette=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance for this pixel buffer with these dimensions. <a href="#bc0ec0141d209074783e13cfbc3d3fba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#81cecd2ad140d14abcd468b8623110d2">csImageMemory</a> (int width, int height, int depth, int format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a blank image of these dimensions and the specified format. <a href="#81cecd2ad140d14abcd468b8623110d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#37cc4d56a6658e1c53b00f80ef9ae355">csImageMemory</a> (int width, int height, int format=CS_IMGFMT_TRUECOLOR)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a blank image of these dimensions and the specified format. <a href="#37cc4d56a6658e1c53b00f80ef9ae355"></a><br></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="classcsImageMemory.html#792c385b2e95334f99e2bf0c4f9d73e2">GetAlpha</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get alpha map for 8-bit paletted image. <a href="#792c385b2e95334f99e2bf0c4f9d73e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#9646bf443e67279e6caf424ff6c97061">GetAlphaPtr</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the alpha data that can be changed. <a href="#9646bf443e67279e6caf424ff6c97061"></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="classcsImageMemory.html#1d0a156069b7eaa44abecd5c96774ec8">GetDepth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image depth (only sensible when the image type is csimg3D). <a href="#1d0a156069b7eaa44abecd5c96774ec8"></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="classcsImageMemory.html#c028edc605d3badec020c952e8368dc2">GetFormat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Qyery image format (see CS_IMGFMT_XXX above). <a href="#c028edc605d3badec020c952e8368dc2"></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="classcsImageMemory.html#d61754c0e0af35591d725e08a5e72b83">GetHeight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image height. <a href="#d61754c0e0af35591d725e08a5e72b83"></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="classcsImageMemory.html#ad1819c50cc745d90b45e513a59bdb9f">GetImageData</a> ()</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="#ad1819c50cc745d90b45e513a59bdb9f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#58aa18774e821efe4873462800c6d5cd">GetImagePtr</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the image data that can be changed. <a href="#58aa18774e821efe4873462800c6d5cd"></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="classcsImageMemory.html#aa59a1047cdd54de633a79accfca7bc5">GetImageType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the contained image. <a href="#aa59a1047cdd54de633a79accfca7bc5"></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="classcsImageMemory.html#4599b6db9460da15d5f04be8a5fe9ee3">GetKeyColor</a> (int &r, int &g, int &b) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the keycolour stored with the image. <a href="#4599b6db9460da15d5f04be8a5fe9ee3"></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="classcsImageMemory.html#a1c6e2410cea2aa451d0f6e7dd0a02ba">GetMipmap</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a precomputed mipmap. <a href="#a1c6e2410cea2aa451d0f6e7dd0a02ba"></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="classcsImageMemory.html#678bb2fa71f077c58d30640890ad7b8c">GetPalette</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get image palette (or 0 if no palette). <a href="#678bb2fa71f077c58d30640890ad7b8c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#5f22433b9c886da004fb0f40db441a90">GetPalettePtr</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the palette data that can be changed. <a href="#5f22433b9c886da004fb0f40db441a90"></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="classcsImageMemory.html#090a23f2bd3cad916f8f099d3dd2eb6a">GetRawData</a> () const </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="#090a23f2bd3cad916f8f099d3dd2eb6a"></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="classcsImageMemory.html#5e78e6a1bedf5a2f652791f60a42b2aa">GetRawFormat</a> () const </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="#5e78e6a1bedf5a2f652791f60a42b2aa"></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="classcsImageMemory.html#f4f7ac725ac7de173b05ba9b64cf7be2">GetWidth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image width. <a href="#f4f7ac725ac7de173b05ba9b64cf7be2"></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="classcsImageMemory.html#3ac872e07d79054d064495b428669dcc">HasKeyColor</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if image has a keycolour stored with it. <a href="#3ac872e07d79054d064495b428669dcc"></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="classcsImageMemory.html#556b083728f0a01ebded70e20c137e5b">HasMipmaps</a> () const </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="#556b083728f0a01ebded70e20c137e5b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#92e0decf253e0f2a2461ebc461a0400d">SetFormat</a> (int iFormat)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert the image to another format. <a href="#92e0decf253e0f2a2461ebc461a0400d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fa755d9cadd06c12cb96acdbc38fdf3c"></a><!-- doxytag: member="csImageMemory::SetImageType" ref="fa755d9cadd06c12cb96acdbc38fdf3c" args="(csImageType type)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#fa755d9cadd06c12cb96acdbc38fdf3c">SetImageType</a> (<a class="el" href="group__gfx2d.html#ge62190ffec24a286b2d4b50dcb899469">csImageType</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5145c5529aae5cc80b6dbd377150082d"></a><!-- doxytag: member="csImageMemory::SetKeycolor" ref="5145c5529aae5cc80b6dbd377150082d" args="(int r, int g, int b)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#5145c5529aae5cc80b6dbd377150082d">SetKeycolor</a> (int r, int g, int b)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#98dfb5ddc11fce88fe67fbacce67331c">SetKeyColor</a> (int r, int g, int b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the keycolor. <a href="#98dfb5ddc11fce88fe67fbacce67331c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#b43fe5b3a31798925bb9d7fd1eda9f1c">SetMipmap</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> num, <a class="el" href="structiImage.html">iImage</a> *mip)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a mipmap of this image. <a href="#b43fe5b3a31798925bb9d7fd1eda9f1c"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#6f47b25b0d1255973e73b3f9e98776eb">AllocImage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate the pixel data buffers. <a href="#6f47b25b0d1255973e73b3f9e98776eb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#c8f4e626efc70c742042ff13a8a348c9">csImageMemory</a> (int iFormat)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classcsImageMemory.html" title="Memory image.">csImageMemory</a> constructor, only set a format, no dimensions. <a href="#c8f4e626efc70c742042ff13a8a348c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#81340987e6ae88ebcad2dd4ff69ee7c0">EnsureImage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate the pixel data buffers if they aren't already. <a href="#81340987e6ae88ebcad2dd4ff69ee7c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#5401d557b31ab8efc36e431f80d857a6">FreeImage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free all image data: pixels and palette. <a href="#5401d557b31ab8efc36e431f80d857a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#f83a38e474bc96ff8c4c12c95eb7dcb2">SetDimensions</a> (int newWidth, int newHeight)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the width and height. <a href="#f83a38e474bc96ff8c4c12c95eb7dcb2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#9979218f2a691ff36cba4d97d62c036d">Alpha</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The alpha map. <a href="#9979218f2a691ff36cba4d97d62c036d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiDataBuffer.html">iDataBuffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#88c6fea768b5fe1b17616db0f3b732d5">databuf</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The image data. <a href="#88c6fea768b5fe1b17616db0f3b732d5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#c67fbce54b8e730054de6c8c10e237f0">Depth</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Depth of image. <a href="#c67fbce54b8e730054de6c8c10e237f0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#22e40494a158c8e86e58ff9c0de20499">destroy_image</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If true when these interfaces are destroyed the image is also. <a href="#22e40494a158c8e86e58ff9c0de20499"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#26d6970ed3aead8041541b79dd4fceb9">Format</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image format (see CS_IMGFMT_XXX above). <a href="#26d6970ed3aead8041541b79dd4fceb9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#b8f33633a3b616cafa2e4b3c3cc30ca9">has_keycolour</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">if it has a keycolour. <a href="#b8f33633a3b616cafa2e4b3c3cc30ca9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#57e394f49c5ff61e51213ad237080076">Height</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Height of image. <a href="#57e394f49c5ff61e51213ad237080076"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__gfx2d.html#ge62190ffec24a286b2d4b50dcb899469">csImageType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#6d11c9f42b9d6e418fffa7ff4c4ea2ce">imageType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type of the contained images. <a href="#6d11c9f42b9d6e418fffa7ff4c4ea2ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#b99f16a832ce81a6f6a9fa5910a1a832">keycolour</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">keycolour value <a href="#b99f16a832ce81a6f6a9fa5910a1a832"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsArray.html">csArray</a>< <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiImage.html">iImage</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#8980c55d0d30d32464e58ad670e6b9da">mipmaps</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mip map images. <a href="#8980c55d0d30d32464e58ad670e6b9da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#ffa2f27da71b0b5cef79beca7cb2932f">Palette</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The image palette or 0. <a href="#ffa2f27da71b0b5cef79beca7cb2932f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html#2c424ba4d7f434605e91a39baf20a4b1">Width</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Width of image. <a href="#2c424ba4d7f434605e91a39baf20a4b1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Memory image.
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00040">40</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c8f4e626efc70c742042ff13a8a348c9"></a><!-- doxytag: member="csImageMemory::csImageMemory" ref="c8f4e626efc70c742042ff13a8a348c9" args="(int iFormat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageMemory::csImageMemory </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iFormat</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classcsImageMemory.html" title="Memory image.">csImageMemory</a> constructor, only set a format, no dimensions.
<p>
Intended to be used by loaders which later call <a class="el" href="classcsImageMemory.html#f83a38e474bc96ff8c4c12c95eb7dcb2" title="Set the width and height.">SetDimensions()</a>.
</div>
</div><p>
<a class="anchor" name="37cc4d56a6658e1c53b00f80ef9ae355"></a><!-- doxytag: member="csImageMemory::csImageMemory" ref="37cc4d56a6658e1c53b00f80ef9ae355" args="(int width, int height, int format=CS_IMGFMT_TRUECOLOR)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageMemory::csImageMemory </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>format</em> = <code>CS_IMGFMT_TRUECOLOR</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a blank image of these dimensions and the specified format.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>Width of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>Height of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>Image format. Default: <a class="el" href="group__gfx2d.html#g791c191ba6818e10601813fe27d9ce6f" title="Truecolor format (r/g/b/unused resp.">CS_IMGFMT_TRUECOLOR</a> </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="81cecd2ad140d14abcd468b8623110d2"></a><!-- doxytag: member="csImageMemory::csImageMemory" ref="81cecd2ad140d14abcd468b8623110d2" args="(int width, int height, int depth, int format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageMemory::csImageMemory </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>depth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>format</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a blank image of these dimensions and the specified format.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>Width of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>Height of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>depth</em> </td><td>Height of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>Image format. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="bc0ec0141d209074783e13cfbc3d3fba"></a><!-- doxytag: member="csImageMemory::csImageMemory" ref="bc0ec0141d209074783e13cfbc3d3fba" args="(int width, int height, void *buffer, bool destroy, int format=CS_IMGFMT_TRUECOLOR, csRGBpixel *palette=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageMemory::csImageMemory </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>destroy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>format</em> = <code>CS_IMGFMT_TRUECOLOR</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> * </td>
<td class="paramname"> <em>palette</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an instance for this pixel buffer with these dimensions.
<p>
If destroy is set to true then the supplied buffer will be destroyed when the instance is. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>Width of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>Height of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>Data containing initial data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destroy</em> </td><td>Destroy the buffer when the Image is destroyed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>Image format. Data in <ul>
<li>buffer must be in this format. Default: <a class="el" href="group__gfx2d.html#g791c191ba6818e10601813fe27d9ce6f" title="Truecolor format (r/g/b/unused resp.">CS_IMGFMT_TRUECOLOR</a> </li>
</ul>
</td></tr>
<tr><td valign="top"></td><td valign="top"><em>palette</em> </td><td>Palette for indexed images. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="34d4ed5bf5d44c3c86dd805630a49623"></a><!-- doxytag: member="csImageMemory::csImageMemory" ref="34d4ed5bf5d44c3c86dd805630a49623" args="(int width, int height, const void *buffer, int format=CS_IMGFMT_TRUECOLOR, const csRGBpixel *palette=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageMemory::csImageMemory </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>format</em> = <code>CS_IMGFMT_TRUECOLOR</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> * </td>
<td class="paramname"> <em>palette</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an instance from a pixel buffer with these dimensions.
<p>
A copy of the pixel data is made. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>Width of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>Height of the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>Data containing initial data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>Image format. Data in <ul>
<li>buffer must be in this format. Default: <a class="el" href="group__gfx2d.html#g791c191ba6818e10601813fe27d9ce6f" title="Truecolor format (r/g/b/unused resp.">CS_IMGFMT_TRUECOLOR</a> </li>
</ul>
</td></tr>
<tr><td valign="top"></td><td valign="top"><em>palette</em> </td><td>Palette for indexed images. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c8d4ec9f822a6d0310f3de207bda9c74"></a><!-- doxytag: member="csImageMemory::csImageMemory" ref="c8d4ec9f822a6d0310f3de207bda9c74" args="(iImage *source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageMemory::csImageMemory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>source</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an instance that copies the pixel data from another <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> object.
<p>
</div>
</div><p>
<a class="anchor" name="a178d643df48667f30f266e57a278673"></a><!-- doxytag: member="csImageMemory::csImageMemory" ref="a178d643df48667f30f266e57a278673" args="(iImage *source, int newFormat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageMemory::csImageMemory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>newFormat</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an instance that copies the pixel data from another <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> object, and also change the data format.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6f47b25b0d1255973e73b3f9e98776eb"></a><!-- doxytag: member="csImageMemory::AllocImage" ref="6f47b25b0d1255973e73b3f9e98776eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::AllocImage </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate the pixel data buffers.
<p>
</div>
</div><p>
<a class="anchor" name="04dac16891c1aace0177b49da0831f61"></a><!-- doxytag: member="csImageMemory::ApplyKeyColor" ref="04dac16891c1aace0177b49da0831f61" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csImageMemory::ApplyKeyColor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Apply the keycolor, that is, set all pixels which match the keycolor to 0.
<p>
</div>
</div><p>
<a class="anchor" name="e2ea3219ce32aa79f12e4e5f9fdcd836"></a><!-- doxytag: member="csImageMemory::CheckAlpha" ref="e2ea3219ce32aa79f12e4e5f9fdcd836" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::CheckAlpha </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if all alpha values are "non-transparent" and if so, discard alpha.
<p>
</div>
</div><p>
<a class="anchor" name="a6b4a6764b8e26f756a6215b7a119e6f"></a><!-- doxytag: member="csImageMemory::Clear" ref="a6b4a6764b8e26f756a6215b7a119e6f" args="(const csRGBpixel &colour)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::Clear </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> & </td>
<td class="paramname"> <em>colour</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clears image to colour. Only works for truecolor images.
<p>
</div>
</div><p>
<a class="anchor" name="7f275eba09445db90755268b26aaba36"></a><!-- doxytag: member="csImageMemory::ClearKeyColor" ref="7f275eba09445db90755268b26aaba36" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csImageMemory::ClearKeyColor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove the keycolor.
<p>
</div>
</div><p>
<a class="anchor" name="9c0af2658e099b8ee77e44c3e82957b7"></a><!-- doxytag: member="csImageMemory::ConvertFromPal8" ref="9c0af2658e099b8ee77e44c3e82957b7" args="(uint8 *iImage, uint8 *alpha, const csRGBcolor *iPalette, int nPalColors=256)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::ConvertFromPal8 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td>
<td class="paramname"> <em>iImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td>
<td class="paramname"> <em>alpha</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> * </td>
<td class="paramname"> <em>iPalette</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nPalColors</em> = <code>256</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used to convert an 8-bit indexed image into requested format.
<p>
Pass a pointer to color indices, a pointer to the alpha mask and a pointer to the palette, and you're done. NOTE: the pointer should be allocated with new uint8 [] and you should not free it after calling this function: the function will free the buffer itself if it is appropriate (or wont if the buffer size/contents are appropriate for target format). Same about palette and alpha.
</div>
</div><p>
<a class="anchor" name="0e9ddd476e7d0b11e6534e816a6471bb"></a><!-- doxytag: member="csImageMemory::ConvertFromPal8" ref="0e9ddd476e7d0b11e6534e816a6471bb" args="(uint8 *iImage, uint8 *alpha, csRGBpixel *iPalette, int nPalColors=256)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::ConvertFromPal8 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td>
<td class="paramname"> <em>iImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td>
<td class="paramname"> <em>alpha</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> * </td>
<td class="paramname"> <em>iPalette</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nPalColors</em> = <code>256</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used to convert an 8-bit indexed image into requested format.
<p>
Pass a pointer to color indices, a pointer to the alpha mask and a pointer to the palette, and you're done. NOTE: the pointer should be allocated with new uint8 [] and you should not free it after calling this function: the function will free the buffer itself if it is appropriate (or wont if the buffer size/contents are appropriate for target format). Same about palette and alpha.
</div>
</div><p>
<a class="anchor" name="b19aa3b8fab76128f61eed2facf386d6"></a><!-- doxytag: member="csImageMemory::ConvertFromRGBA" ref="b19aa3b8fab76128f61eed2facf386d6" args="(csRGBpixel *iImage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::ConvertFromRGBA </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> * </td>
<td class="paramname"> <em>iImage</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used to convert an truecolor RGB image into requested format.
<p>
If the image loader cannot handle conversion itself, and the image file is in a format that is different from the requested one, load the image in <a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> format and pass the pointer to this function which will handle the RGB -> target format conversion. NOTE: the pointer should be allocated with new <a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> [] and you should not free it after calling this function: the function will free the buffer itself if it is appropriate (or wont if the buffer size/contents are appropriate for target format).
</div>
</div><p>
<a class="anchor" name="b10e64493f06406d0491eb36a7a7b400"></a><!-- doxytag: member="csImageMemory::Copy" ref="b10e64493f06406d0491eb36a7a7b400" args="(iImage *srcImage, int x, int y, int width, int height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csImageMemory::Copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>srcImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy an image as subpart into this image.
<p>
</div>
</div><p>
<a class="anchor" name="5ca4c758ad1a006618fc5771e8f858e9"></a><!-- doxytag: member="csImageMemory::CopyScale" ref="5ca4c758ad1a006618fc5771e8f858e9" args="(iImage *srcImage, int x, int y, int width, int height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csImageMemory::CopyScale </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>srcImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy an image as subpart into this image with scaling <em>sImage</em> to the given size.
<p>
</div>
</div><p>
<a class="anchor" name="75da373784c2a91d73da0f8193c31bef"></a><!-- doxytag: member="csImageMemory::CopyTile" ref="75da373784c2a91d73da0f8193c31bef" args="(iImage *srcImage, int x, int y, int width, int height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csImageMemory::CopyTile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>srcImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy an image as subpart into this image and tile and scale <em>sImage</em> to the given size.
<p>
</div>
</div><p>
<a class="anchor" name="81340987e6ae88ebcad2dd4ff69ee7c0"></a><!-- doxytag: member="csImageMemory::EnsureImage" ref="81340987e6ae88ebcad2dd4ff69ee7c0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::EnsureImage </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate the pixel data buffers if they aren't already.
<p>
</div>
</div><p>
<a class="anchor" name="5401d557b31ab8efc36e431f80d857a6"></a><!-- doxytag: member="csImageMemory::FreeImage" ref="5401d557b31ab8efc36e431f80d857a6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::FreeImage </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Free all image data: pixels and palette.
<p>
Takes care of image data format.
</div>
</div><p>
<a class="anchor" name="792c385b2e95334f99e2bf0c4f9d73e2"></a><!-- doxytag: member="csImageMemory::GetAlpha" ref="792c385b2e95334f99e2bf0c4f9d73e2" args="()" -->
<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>* csImageMemory::GetAlpha </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, 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>Reimplemented from <a class="el" href="classcsImageBase.html#9088e2e94fb55125292f8bd2e6b71d83">csImageBase</a>.</p>
<p>Reimplemented in <a class="el" href="classcsCommonImageFile.html#52eb4dcce4f38fded746cc8e6df78d33">csCommonImageFile</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00201">201</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9646bf443e67279e6caf424ff6c97061"></a><!-- doxytag: member="csImageMemory::GetAlphaPtr" ref="9646bf443e67279e6caf424ff6c97061" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a>* csImageMemory::GetAlphaPtr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to the alpha data that can be changed.
<p>
</div>
</div><p>
<a class="anchor" name="1d0a156069b7eaa44abecd5c96774ec8"></a><!-- doxytag: member="csImageMemory::GetDepth" ref="1d0a156069b7eaa44abecd5c96774ec8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csImageMemory::GetDepth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query image depth (only sensible when the image type is csimg3D).
<p>
<p>Reimplemented from <a class="el" href="classcsImageBase.html#05356f886e5dcb7866294515bf31ed38">csImageBase</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00185">185</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c028edc605d3badec020c952e8368dc2"></a><!-- doxytag: member="csImageMemory::GetFormat" ref="c028edc605d3badec020c952e8368dc2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csImageMemory::GetFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Qyery image format (see CS_IMGFMT_XXX above).
<p>
<p>Implements <a class="el" href="structiImage.html#dcfcf95222b2f49662efaf5aca8033c8">iImage</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00199">199</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="d61754c0e0af35591d725e08a5e72b83"></a><!-- doxytag: member="csImageMemory::GetHeight" ref="d61754c0e0af35591d725e08a5e72b83" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csImageMemory::GetHeight </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query image height.
<p>
<p>Implements <a class="el" href="structiImage.html#31a45f12e47bbdca9754117200ce9658">iImage</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00184">184</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="ad1819c50cc745d90b45e513a59bdb9f"></a><!-- doxytag: member="csImageMemory::GetImageData" ref="ad1819c50cc745d90b45e513a59bdb9f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const void* csImageMemory::GetImageData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, 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>Implements <a class="el" href="structiImage.html#c6ef621537753b4409a003b126d3122c">iImage</a>.</p>
<p>Reimplemented in <a class="el" href="classcsCommonImageFile.html#0fc5c8f36c1f8ad9626d339300a8ce11">csCommonImageFile</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00182">182</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="58aa18774e821efe4873462800c6d5cd"></a><!-- doxytag: member="csImageMemory::GetImagePtr" ref="58aa18774e821efe4873462800c6d5cd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* csImageMemory::GetImagePtr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to the image data that can be changed.
<p>
</div>
</div><p>
<a class="anchor" name="aa59a1047cdd54de633a79accfca7bc5"></a><!-- doxytag: member="csImageMemory::GetImageType" ref="aa59a1047cdd54de633a79accfca7bc5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__gfx2d.html#ge62190ffec24a286b2d4b50dcb899469">csImageType</a> csImageMemory::GetImageType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the type of the contained image.
<p>
<p>Reimplemented from <a class="el" href="classcsImageBase.html#851e69042d59791db1276e4daa1280e5">csImageBase</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00238">238</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="4599b6db9460da15d5f04be8a5fe9ee3"></a><!-- doxytag: member="csImageMemory::GetKeyColor" ref="4599b6db9460da15d5f04be8a5fe9ee3" args="(int &r, int &g, int &b) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csImageMemory::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> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the keycolour stored with the image.
<p>
<p>Reimplemented from <a class="el" href="classcsImageBase.html#3b394ea924569d578b6b8a7392159b56">csImageBase</a>.</p>
<p>Reimplemented in <a class="el" href="classcsCommonImageFile.html#3d4f16347be90e13ce89d1d81f8247c7">csCommonImageFile</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00205">205</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a1c6e2410cea2aa451d0f6e7dd0a02ba"></a><!-- doxytag: member="csImageMemory::GetMipmap" ref="a1c6e2410cea2aa451d0f6e7dd0a02ba" args="(uint num)" -->
<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>> csImageMemory::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> [inline, 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="classcsImageMemory.html#556b083728f0a01ebded70e20c137e5b" title="Returns the number of mipmaps contained in the image (in case there exist any precalculated...">HasMipmaps()</a> returns that mipmap.
<p>Reimplemented from <a class="el" href="classcsImageBase.html#65885bfc9872abbc3850437037ddadf7">csImageBase</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00247">247</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="678bb2fa71f077c58d30640890ad7b8c"></a><!-- doxytag: member="csImageMemory::GetPalette" ref="678bb2fa71f077c58d30640890ad7b8c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a>* csImageMemory::GetPalette </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get image palette (or 0 if no palette).
<p>
<p>Reimplemented from <a class="el" href="classcsImageBase.html#b5259fde6544f4ebf4fd6200a75c5efa">csImageBase</a>.</p>
<p>Reimplemented in <a class="el" href="classcsCommonImageFile.html#930e39e085bc6a905036711f9047788e">csCommonImageFile</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00200">200</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5f22433b9c886da004fb0f40db441a90"></a><!-- doxytag: member="csImageMemory::GetPalettePtr" ref="5f22433b9c886da004fb0f40db441a90" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a>* csImageMemory::GetPalettePtr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to the palette data that can be changed.
<p>
</div>
</div><p>
<a class="anchor" name="090a23f2bd3cad916f8f099d3dd2eb6a"></a><!-- doxytag: member="csImageMemory::GetRawData" ref="090a23f2bd3cad916f8f099d3dd2eb6a" args="() const " -->
<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>> csImageMemory::GetRawData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, 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>Reimplemented from <a class="el" href="classcsImageBase.html#09cc932884c2812f381df27d2a4d29d4">csImageBase</a>.</p>
<p>Reimplemented in <a class="el" href="classcsCommonImageFile.html#ec21772b6225bce4b19c4a5bfeaac688">csCommonImageFile</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00194">194</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5e78e6a1bedf5a2f652791f60a42b2aa"></a><!-- doxytag: member="csImageMemory::GetRawFormat" ref="5e78e6a1bedf5a2f652791f60a42b2aa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csImageMemory::GetRawFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, 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>Reimplemented from <a class="el" href="classcsImageBase.html#bf6f47e3e0c7b6f19f08526abf082b0d">csImageBase</a>.</p>
<p>Reimplemented in <a class="el" href="classcsCommonImageFile.html#df390477df78180ad356ddd90fe83383">csCommonImageFile</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00187">187</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
<p>References <a class="el" href="image_8h-source.html#l00044">CS_IMGFMT_MASK</a>, and <a class="el" href="image_8h-source.html#l00051">CS_IMGFMT_TRUECOLOR</a>.</p>
</div>
</div><p>
<a class="anchor" name="f4f7ac725ac7de173b05ba9b64cf7be2"></a><!-- doxytag: member="csImageMemory::GetWidth" ref="f4f7ac725ac7de173b05ba9b64cf7be2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csImageMemory::GetWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query image width.
<p>
<p>Implements <a class="el" href="structiImage.html#e46445da6aa7836ce65a1181b9125835">iImage</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00183">183</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="3ac872e07d79054d064495b428669dcc"></a><!-- doxytag: member="csImageMemory::HasKeyColor" ref="3ac872e07d79054d064495b428669dcc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csImageMemory::HasKeyColor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if image has a keycolour stored with it.
<p>
<p>Reimplemented from <a class="el" href="classcsImageBase.html#0074d236d0bf6c41c5bd71cf471f6506">csImageBase</a>.</p>
<p>Reimplemented in <a class="el" href="classcsCommonImageFile.html#421637e134710b348c21c683e4626381">csCommonImageFile</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00203">203</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="556b083728f0a01ebded70e20c137e5b"></a><!-- doxytag: member="csImageMemory::HasMipmaps" ref="556b083728f0a01ebded70e20c137e5b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> csImageMemory::HasMipmaps </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, 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>Reimplemented from <a class="el" href="classcsImageBase.html#828abaf036fd86f5be6ababdda0933d2">csImageBase</a>.</p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00241">241</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f83a38e474bc96ff8c4c12c95eb7dcb2"></a><!-- doxytag: member="csImageMemory::SetDimensions" ref="f83a38e474bc96ff8c4c12c95eb7dcb2" args="(int newWidth, int newHeight)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::SetDimensions </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>newWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>newHeight</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the width and height.
<p>
This will also free the 'image' buffer to hold the pixel data, but it will NOT allocate a new buffer (thus `image' is 0 after calling this function). You should pass an appropiate pointer to one of ConvertXXX functions below, define the image itself (or assign something to `Image' manually), or call <a class="el" href="classcsImageMemory.html#81340987e6ae88ebcad2dd4ff69ee7c0" title="Allocate the pixel data buffers if they aren't already.">EnsureImage()</a>.
</div>
</div><p>
<a class="anchor" name="92e0decf253e0f2a2461ebc461a0400d"></a><!-- doxytag: member="csImageMemory::SetFormat" ref="92e0decf253e0f2a2461ebc461a0400d" args="(int iFormat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageMemory::SetFormat </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iFormat</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert the image to another format.
<p>
This method will allocate a respective color component if it was not allocated before. For example, you can use this method to add alpha channel to paletted images, to allocate a image for CS_IMGFMT_NONE alphamaps or vice versa, to remove the image and leave alphamap alone. This routine may be used as well for removing alpha channel.
</div>
</div><p>
<a class="anchor" name="98dfb5ddc11fce88fe67fbacce67331c"></a><!-- doxytag: member="csImageMemory::SetKeyColor" ref="98dfb5ddc11fce88fe67fbacce67331c" args="(int r, int g, int b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csImageMemory::SetKeyColor </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%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the keycolor.
<p>
</div>
</div><p>
<a class="anchor" name="b43fe5b3a31798925bb9d7fd1eda9f1c"></a><!-- doxytag: member="csImageMemory::SetMipmap" ref="b43fe5b3a31798925bb9d7fd1eda9f1c" args="(uint num, iImage *mip)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csImageMemory::SetMipmap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>mip</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a mipmap of this image.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>You can set any mipmap except number 0 to your liking, however, no sanity checking is performed! That is, you can set mipmaps to 0, leave out mipmaps and provide more mipmaps than the image really needs - this can be problematic as most clients will expect non-null mipmaps. (Note however that trailing 0 mipmaps will not be reported.) </dd></dl>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00261">261</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="9979218f2a691ff36cba4d97d62c036d"></a><!-- doxytag: member="csImageMemory::Alpha" ref="9979218f2a691ff36cba4d97d62c036d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a>* <a class="el" href="classcsImageMemory.html#9979218f2a691ff36cba4d97d62c036d">csImageMemory::Alpha</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The alpha map.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00070">70</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="88c6fea768b5fe1b17616db0f3b732d5"></a><!-- doxytag: member="csImageMemory::databuf" ref="88c6fea768b5fe1b17616db0f3b732d5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiDataBuffer.html">iDataBuffer</a>> <a class="el" href="classcsImageMemory.html#88c6fea768b5fe1b17616db0f3b732d5">csImageMemory::databuf</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The image data.
<p>
A value of 0 means the Image contents are "undefined". However, this is an internal state only. No operation should fail due undefined image data (although the data may stay undefined).
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00066">66</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c67fbce54b8e730054de6c8c10e237f0"></a><!-- doxytag: member="csImageMemory::Depth" ref="c67fbce54b8e730054de6c8c10e237f0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classcsImageMemory.html#c67fbce54b8e730054de6c8c10e237f0">csImageMemory::Depth</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Depth of image.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00059">59</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="22e40494a158c8e86e58ff9c0de20499"></a><!-- doxytag: member="csImageMemory::destroy_image" ref="22e40494a158c8e86e58ff9c0de20499" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsImageMemory.html#22e40494a158c8e86e58ff9c0de20499">csImageMemory::destroy_image</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If true when these interfaces are destroyed the image is also.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00078">78</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="26d6970ed3aead8041541b79dd4fceb9"></a><!-- doxytag: member="csImageMemory::Format" ref="26d6970ed3aead8041541b79dd4fceb9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classcsImageMemory.html#26d6970ed3aead8041541b79dd4fceb9">csImageMemory::Format</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Image format (see CS_IMGFMT_XXX above).
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00072">72</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b8f33633a3b616cafa2e4b3c3cc30ca9"></a><!-- doxytag: member="csImageMemory::has_keycolour" ref="b8f33633a3b616cafa2e4b3c3cc30ca9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsImageMemory.html#b8f33633a3b616cafa2e4b3c3cc30ca9">csImageMemory::has_keycolour</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
if it has a keycolour.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00074">74</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="57e394f49c5ff61e51213ad237080076"></a><!-- doxytag: member="csImageMemory::Height" ref="57e394f49c5ff61e51213ad237080076" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classcsImageMemory.html#57e394f49c5ff61e51213ad237080076">csImageMemory::Height</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Height of image.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00057">57</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="6d11c9f42b9d6e418fffa7ff4c4ea2ce"></a><!-- doxytag: member="csImageMemory::imageType" ref="6d11c9f42b9d6e418fffa7ff4c4ea2ce" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gfx2d.html#ge62190ffec24a286b2d4b50dcb899469">csImageType</a> <a class="el" href="classcsImageMemory.html#6d11c9f42b9d6e418fffa7ff4c4ea2ce">csImageMemory::imageType</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Type of the contained images.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00080">80</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b99f16a832ce81a6f6a9fa5910a1a832"></a><!-- doxytag: member="csImageMemory::keycolour" ref="b99f16a832ce81a6f6a9fa5910a1a832" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> <a class="el" href="classcsImageMemory.html#b99f16a832ce81a6f6a9fa5910a1a832">csImageMemory::keycolour</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
keycolour value
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00076">76</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8980c55d0d30d32464e58ad670e6b9da"></a><!-- doxytag: member="csImageMemory::mipmaps" ref="8980c55d0d30d32464e58ad670e6b9da" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsArray.html">csArray</a><<a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiImage.html">iImage</a>> > <a class="el" href="classcsImageMemory.html#8980c55d0d30d32464e58ad670e6b9da">csImageMemory::mipmaps</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mip map images.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00085">85</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="ffa2f27da71b0b5cef79beca7cb2932f"></a><!-- doxytag: member="csImageMemory::Palette" ref="ffa2f27da71b0b5cef79beca7cb2932f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a>* <a class="el" href="classcsImageMemory.html#ffa2f27da71b0b5cef79beca7cb2932f">csImageMemory::Palette</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The image palette or 0.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00068">68</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2c424ba4d7f434605e91a39baf20a4b1"></a><!-- doxytag: member="csImageMemory::Width" ref="2c424ba4d7f434605e91a39baf20a4b1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classcsImageMemory.html#2c424ba4d7f434605e91a39baf20a4b1">csImageMemory::Width</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Width of image.
<p>
<p>Definition at line <a class="el" href="imagememory_8h-source.html#l00055">55</a> of file <a class="el" href="imagememory_8h-source.html">imagememory.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csgfx/<a class="el" href="imagememory_8h-source.html">imagememory.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
>
669
