<!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: csImageVolumeMaker 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>csImageVolumeMaker Class Reference<br> <small> [<a class="el" href="group__gfx.html">Graphics</a>]</small> </h1><!-- doxytag: class="csImageVolumeMaker" --><!-- doxytag: inherits="scfImplementationExt0< csImageVolumeMaker, csImageBase >" -->Wrapper class to create a volume aka 3D texture from a number of 2D images as the volume slices. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="imagevolumemaker_8h-source.html">csgfx/imagevolumemaker.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for csImageVolumeMaker:</div> <div class="dynsection"> <p><center><img src="classcsImageVolumeMaker__inherit__graph.png" border="0" usemap="#csImageVolumeMaker__inherit__map" alt="Inheritance graph"></center> <map name="csImageVolumeMaker__inherit__map"> <area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csImageVolumeMaker, csImageBase \>" alt="" coords="7,316,447,343"><area shape="rect" href="classcsImageBase.html" title="Base class for iImage implementations." alt="" coords="173,239,280,265"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csImageBase, iImage \>" alt="" coords="68,161,385,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csImageBase \>" alt="" coords="5,84,264,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="280,7,336,33"><area shape="rect" href="structiImage.html" title="The iImage interface is used to work with image objects." alt="" coords="288,84,352,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="24,7,245,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classcsImageVolumeMaker-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#072f08caac7add2b0a1bffd7789cb626">csImageVolumeMaker</a> (<a class="el" href="structiImage.html">iImage</a> *source)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new map and copy slices from <em>source</em>. <a href="#072f08caac7add2b0a1bffd7789cb626"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#0a642a07da789eed0ca2ea5608543404">csImageVolumeMaker</a> (int format=-1, int width=-1, int height=-1)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new map without slices set. <a href="#0a642a07da789eed0ca2ea5608543404"></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="classcsImageVolumeMaker.html#2f88437dcfb8c4a8a61221b102a640f7">GetAlpha</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get alpha map for 8-bit paletted image. <a href="#2f88437dcfb8c4a8a61221b102a640f7"></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="classcsImageVolumeMaker.html#c9864e6490c49cb9af3e4640fb7e54e6">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="#c9864e6490c49cb9af3e4640fb7e54e6"></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="classcsImageVolumeMaker.html#a42e5883f270705815666c3e444910de">GetFormat</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Qyery image format (see CS_IMGFMT_XXX above). <a href="#a42e5883f270705815666c3e444910de"></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="classcsImageVolumeMaker.html#c534fd025a3a75eb984952089dc5d3af">GetHeight</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Query image height. <a href="#c534fd025a3a75eb984952089dc5d3af"></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="classcsImageVolumeMaker.html#e192e3a1098a32850de0c55f19deb7dd">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="#e192e3a1098a32850de0c55f19deb7dd"></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="classcsImageVolumeMaker.html#b8be733ec0bdaa934131e00c2afb46c1">GetImageType</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the contained image. <a href="#b8be733ec0bdaa934131e00c2afb46c1"></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="classcsImageVolumeMaker.html#86fc346978d9f30e4215572be8ba9ded">GetName</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the image. <a href="#86fc346978d9f30e4215572be8ba9ded"></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="classcsImageVolumeMaker.html#c100fc1164081bf1a6606cc6d0e48734">GetPalette</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get image palette (or 0 if no palette). <a href="#c100fc1164081bf1a6606cc6d0e48734"></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="classcsImageVolumeMaker.html#b0c93563968e5e6994a25e8f3774e421">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="#b0c93563968e5e6994a25e8f3774e421"></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="classcsImageVolumeMaker.html#ac94b127bbcae3ffa4b3f57c4fa1c22c">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="#ac94b127bbcae3ffa4b3f57c4fa1c22c"></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="classcsImageVolumeMaker.html#0461e3b10f6f8ba1f1c4764ab8b9e494">GetWidth</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Query image width. <a href="#0461e3b10f6f8ba1f1c4764ab8b9e494"></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="classcsImageVolumeMaker.html#016226a450fd922377beaadc22975fc0">SetName</a> (const char *iName)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the image. <a href="#016226a450fd922377beaadc22975fc0"></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="classcsImageVolumeMaker.html#013963f218a36f33fee355d1423c52c6">AppendPending</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert all added images to the right format and update <em>data</em>. <a href="#013963f218a36f33fee355d1423c52c6"></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="classcsImageVolumeMaker.html#8cde2f473cf82c64262a7a23bddae455">alpha</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Image alpha. <a href="#8cde2f473cf82c64262a7a23bddae455"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#beb7366a3b8b416b5cf15b9dce43f1a2">data</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Image data. <a href="#beb7366a3b8b416b5cf15b9dce43f1a2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#db0d7f9d04b25b0a957de0dc61b103c2">Depth</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Depth of the image. <a href="#db0d7f9d04b25b0a957de0dc61b103c2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#2782ba64808d656e68fca54dddd0f0b1">Format</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Format of the image. <a href="#2782ba64808d656e68fca54dddd0f0b1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#d302f2049847e7bea00574dcad91b5f0">Height</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Height of the image. <a href="#d302f2049847e7bea00574dcad91b5f0"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#08aaed75878ad8407007915e54afd5b3">manualName</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the name was manually overridden (in this case it is not updated when the contained images are changed). <a href="#08aaed75878ad8407007915e54afd5b3"></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="classcsImageVolumeMaker.html#d789e2fe0a4e20001c975cca9ab7fd28">palette</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Image palette. <a href="#d789e2fe0a4e20001c975cca9ab7fd28"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsRefArray.html">csRefArray</a>< <a class="el" href="structiImage.html">iImage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#6461292e62adfef4e969416c63b199db">pendingImages</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Array of images that were added, but not yet processed into the image data. <a href="#6461292e62adfef4e969416c63b199db"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html#deb644840a5e36cc5ba12d35279dbe54">Width</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Width of the image. <a href="#deb644840a5e36cc5ba12d35279dbe54"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Wrapper class to create a volume aka 3D texture from a number of 2D images as the volume slices. <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00040">40</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="0a642a07da789eed0ca2ea5608543404"></a><!-- doxytag: member="csImageVolumeMaker::csImageVolumeMaker" ref="0a642a07da789eed0ca2ea5608543404" args="(int format=-1, int width=-1, int height=-1)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csImageVolumeMaker::csImageVolumeMaker </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>format</em> = <code>-1</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>width</em> = <code>-1</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>height</em> = <code>-1</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 new map without slices set. <p> Format, width, height are, unless specified, taken from the first image added. </div> </div><p> <a class="anchor" name="072f08caac7add2b0a1bffd7789cb626"></a><!-- doxytag: member="csImageVolumeMaker::csImageVolumeMaker" ref="072f08caac7add2b0a1bffd7789cb626" args="(iImage *source)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csImageVolumeMaker::csImageVolumeMaker </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 a new map and copy slices from <em>source</em>. <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="013963f218a36f33fee355d1423c52c6"></a><!-- doxytag: member="csImageVolumeMaker::AppendPending" ref="013963f218a36f33fee355d1423c52c6" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csImageVolumeMaker::AppendPending </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Convert all added images to the right format and update <em>data</em>. <p> </div> </div><p> <a class="anchor" name="2f88437dcfb8c4a8a61221b102a640f7"></a><!-- doxytag: member="csImageVolumeMaker::GetAlpha" ref="2f88437dcfb8c4a8a61221b102a640f7" 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>* csImageVolumeMaker::GetAlpha </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [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> </div> </div><p> <a class="anchor" name="c9864e6490c49cb9af3e4640fb7e54e6"></a><!-- doxytag: member="csImageVolumeMaker::GetDepth" ref="c9864e6490c49cb9af3e4640fb7e54e6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csImageVolumeMaker::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="imagevolumemaker_8h-source.html#l00090">90</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="a42e5883f270705815666c3e444910de"></a><!-- doxytag: member="csImageVolumeMaker::GetFormat" ref="a42e5883f270705815666c3e444910de" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csImageVolumeMaker::GetFormat </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [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> </div> </div><p> <a class="anchor" name="c534fd025a3a75eb984952089dc5d3af"></a><!-- doxytag: member="csImageVolumeMaker::GetHeight" ref="c534fd025a3a75eb984952089dc5d3af" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csImageVolumeMaker::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="imagevolumemaker_8h-source.html#l00089">89</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="e192e3a1098a32850de0c55f19deb7dd"></a><!-- doxytag: member="csImageVolumeMaker::GetImageData" ref="e192e3a1098a32850de0c55f19deb7dd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const void* csImageVolumeMaker::GetImageData </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [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> </div> </div><p> <a class="anchor" name="b8be733ec0bdaa934131e00c2afb46c1"></a><!-- doxytag: member="csImageVolumeMaker::GetImageType" ref="b8be733ec0bdaa934131e00c2afb46c1" 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> csImageVolumeMaker::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="imagevolumemaker_8h-source.html#l00107">107</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> <p>References <a class="el" href="image_8h-source.html#l00073">csimg3D</a>.</p> </div> </div><p> <a class="anchor" name="86fc346978d9f30e4215572be8ba9ded"></a><!-- doxytag: member="csImageVolumeMaker::GetName" ref="86fc346978d9f30e4215572be8ba9ded" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* csImageVolumeMaker::GetName </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 name of the image. <p> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Unless the name was manually overridden with <a class="el" href="classcsImageVolumeMaker.html#016226a450fd922377beaadc22975fc0" title="Set the name of the image.">SetName()</a>, the default name will contain the names of the wrapped slices, separated by ':', in the form <code>slice1.png:slice2.png:...</code>. </dd></dl> <p>Reimplemented from <a class="el" href="classcsImageBase.html#cffe6abf869943c09d67a06f62f706e6">csImageBase</a>.</p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00099">99</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="c100fc1164081bf1a6606cc6d0e48734"></a><!-- doxytag: member="csImageVolumeMaker::GetPalette" ref="c100fc1164081bf1a6606cc6d0e48734" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a>* csImageVolumeMaker::GetPalette </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [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> </div> </div><p> <a class="anchor" name="b0c93563968e5e6994a25e8f3774e421"></a><!-- doxytag: member="csImageVolumeMaker::GetRawData" ref="b0c93563968e5e6994a25e8f3774e421" 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>> csImageVolumeMaker::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>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00106">106</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="ac94b127bbcae3ffa4b3f57c4fa1c22c"></a><!-- doxytag: member="csImageVolumeMaker::GetRawFormat" ref="ac94b127bbcae3ffa4b3f57c4fa1c22c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* csImageVolumeMaker::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>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00105">105</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="0461e3b10f6f8ba1f1c4764ab8b9e494"></a><!-- doxytag: member="csImageVolumeMaker::GetWidth" ref="0461e3b10f6f8ba1f1c4764ab8b9e494" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csImageVolumeMaker::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="imagevolumemaker_8h-source.html#l00088">88</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="016226a450fd922377beaadc22975fc0"></a><!-- doxytag: member="csImageVolumeMaker::SetName" ref="016226a450fd922377beaadc22975fc0" args="(const char *iName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void csImageVolumeMaker::SetName </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>iName</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the name of the image. <p> <p>Reimplemented from <a class="el" href="classcsImageBase.html#0f830f7221167e2c6094ec8e06e07cab">csImageBase</a>.</p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="8cde2f473cf82c64262a7a23bddae455"></a><!-- doxytag: member="csImageVolumeMaker::alpha" ref="8cde2f473cf82c64262a7a23bddae455" 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="classcsImageVolumeMaker.html#8cde2f473cf82c64262a7a23bddae455">csImageVolumeMaker::alpha</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Image alpha. <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00068">68</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="beb7366a3b8b416b5cf15b9dce43f1a2"></a><!-- doxytag: member="csImageVolumeMaker::data" ref="beb7366a3b8b416b5cf15b9dce43f1a2" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* <a class="el" href="classcsImageVolumeMaker.html#beb7366a3b8b416b5cf15b9dce43f1a2">csImageVolumeMaker::data</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Image data. <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00064">64</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="db0d7f9d04b25b0a957de0dc61b103c2"></a><!-- doxytag: member="csImageVolumeMaker::Depth" ref="db0d7f9d04b25b0a957de0dc61b103c2" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classcsImageVolumeMaker.html#db0d7f9d04b25b0a957de0dc61b103c2">csImageVolumeMaker::Depth</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Depth of the image. <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00059">59</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="2782ba64808d656e68fca54dddd0f0b1"></a><!-- doxytag: member="csImageVolumeMaker::Format" ref="2782ba64808d656e68fca54dddd0f0b1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classcsImageVolumeMaker.html#2782ba64808d656e68fca54dddd0f0b1">csImageVolumeMaker::Format</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Format of the image. <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00061">61</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="d302f2049847e7bea00574dcad91b5f0"></a><!-- doxytag: member="csImageVolumeMaker::Height" ref="d302f2049847e7bea00574dcad91b5f0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classcsImageVolumeMaker.html#d302f2049847e7bea00574dcad91b5f0">csImageVolumeMaker::Height</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Height of the image. <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00057">57</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="08aaed75878ad8407007915e54afd5b3"></a><!-- doxytag: member="csImageVolumeMaker::manualName" ref="08aaed75878ad8407007915e54afd5b3" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classcsImageVolumeMaker.html#08aaed75878ad8407007915e54afd5b3">csImageVolumeMaker::manualName</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Whether the name was manually overridden (in this case it is not updated when the contained images are changed). <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00048">48</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="d789e2fe0a4e20001c975cca9ab7fd28"></a><!-- doxytag: member="csImageVolumeMaker::palette" ref="d789e2fe0a4e20001c975cca9ab7fd28" 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="classcsImageVolumeMaker.html#d789e2fe0a4e20001c975cca9ab7fd28">csImageVolumeMaker::palette</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Image palette. <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00066">66</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="6461292e62adfef4e969416c63b199db"></a><!-- doxytag: member="csImageVolumeMaker::pendingImages" ref="6461292e62adfef4e969416c63b199db" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsRefArray.html">csRefArray</a><<a class="el" href="structiImage.html">iImage</a>> <a class="el" href="classcsImageVolumeMaker.html#6461292e62adfef4e969416c63b199db">csImageVolumeMaker::pendingImages</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Array of images that were added, but not yet processed into the image data. <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00053">53</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.h</a>.</p> </div> </div><p> <a class="anchor" name="deb644840a5e36cc5ba12d35279dbe54"></a><!-- doxytag: member="csImageVolumeMaker::Width" ref="deb644840a5e36cc5ba12d35279dbe54" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classcsImageVolumeMaker.html#deb644840a5e36cc5ba12d35279dbe54">csImageVolumeMaker::Width</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Width of the image. <p> <p>Definition at line <a class="el" href="imagevolumemaker_8h-source.html#l00055">55</a> of file <a class="el" href="imagevolumemaker_8h-source.html">imagevolumemaker.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="imagevolumemaker_8h-source.html">imagevolumemaker.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>