<!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: csImageCubeMapMaker 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>csImageCubeMapMaker Class Reference<br>
<small>
[<a class="el" href="group__gfx.html">Graphics</a>]</small>
</h1><!-- doxytag: class="csImageCubeMapMaker" --><!-- doxytag: inherits="scfImplementationExt0< csImageCubeMapMaker, csImageBase >" -->Wrapper class to create a cube map from a number of 2D images as the cube faces.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="imagecubemapmaker_8h-source.html">csgfx/imagecubemapmaker.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csImageCubeMapMaker:</div>
<div class="dynsection">
<p><center><img src="classcsImageCubeMapMaker__inherit__graph.png" border="0" usemap="#csImageCubeMapMaker__inherit__map" alt="Inheritance graph"></center>
<map name="csImageCubeMapMaker__inherit__map">
<area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csImageCubeMapMaker, csImageBase \>" alt="" coords="5,316,459,343"><area shape="rect" href="classcsImageBase.html" title="Base class for iImage implementations." alt="" coords="179,239,285,265"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csImageBase, iImage \>" alt="" coords="73,161,391,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csImageBase \>" alt="" coords="11,84,269,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="285,7,341,33"><area shape="rect" href="structiImage.html" title="The iImage interface is used to work with image objects." alt="" coords="293,84,357,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="29,7,251,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsImageCubeMapMaker-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="classcsImageCubeMapMaker.html#9bbe71322a6d7ee5839679258d1e2331">csImageCubeMapMaker</a> (<a class="el" href="structiImage.html">iImage</a> *posX, <a class="el" href="structiImage.html">iImage</a> *negX, <a class="el" href="structiImage.html">iImage</a> *posY, <a class="el" href="structiImage.html">iImage</a> *negY, <a class="el" href="structiImage.html">iImage</a> *posZ, <a class="el" href="structiImage.html">iImage</a> *negZ)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new map from separately specified Positive X, Positive Y etc. <a href="#9bbe71322a6d7ee5839679258d1e2331"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageCubeMapMaker.html#ab9722c223df953260a7d4657f93257d">csImageCubeMapMaker</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 the faces from <em>source</em>. <a href="#ab9722c223df953260a7d4657f93257d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageCubeMapMaker.html#b2bf2f56510476e98a5e7dbaa61b85df">csImageCubeMapMaker</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new map without faces set. <a href="#b2bf2f56510476e98a5e7dbaa61b85df"></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="classcsImageCubeMapMaker.html#daf90be8743b935bcebf931b878c51d4">GetAlpha</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get alpha map for 8-bit paletted image. <a href="#daf90be8743b935bcebf931b878c51d4"></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="classcsImageCubeMapMaker.html#42b0da787053aebbeab41ad8c78c722e">GetFormat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Qyery image format (see CS_IMGFMT_XXX above). <a href="#42b0da787053aebbeab41ad8c78c722e"></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="classcsImageCubeMapMaker.html#08b1d618ff2b0cfd6e33efe95beab34e">GetHeight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image height. <a href="#08b1d618ff2b0cfd6e33efe95beab34e"></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="classcsImageCubeMapMaker.html#bd77827fc1966df6aec28d3f5b43b857">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="#bd77827fc1966df6aec28d3f5b43b857"></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="classcsImageCubeMapMaker.html#57e23729d42b3137d94782b72b66d8e1">GetImageType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the contained image. <a href="#57e23729d42b3137d94782b72b66d8e1"></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="classcsImageCubeMapMaker.html#3e7e0179fea867f85671f8367a83e81b">GetKeyColor</a> (int &, int &, int &) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the keycolour stored with the image. <a href="#3e7e0179fea867f85671f8367a83e81b"></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="classcsImageCubeMapMaker.html#c5f134c33fe9fbfcf62a9585975b502e">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="#c5f134c33fe9fbfcf62a9585975b502e"></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="classcsImageCubeMapMaker.html#2b15a9f2e30f90fd82418b9eda0e0b75">GetName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the image. <a href="#2b15a9f2e30f90fd82418b9eda0e0b75"></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="classcsImageCubeMapMaker.html#b8767b4bdbf8d9ef64ed3c5fc8668931">GetPalette</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get image palette (or 0 if no palette). <a href="#b8767b4bdbf8d9ef64ed3c5fc8668931"></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="classcsImageCubeMapMaker.html#14aaa8b027bc3d77db31bb5808046ce5">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="#14aaa8b027bc3d77db31bb5808046ce5"></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="classcsImageCubeMapMaker.html#6707c60c37d82db16217cf9ae1cb508a">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="#6707c60c37d82db16217cf9ae1cb508a"></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="classcsImageCubeMapMaker.html#d94bf407ace9f03464dcf19b6a06d3fb">GetSubImage</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query a sub image. <a href="#d94bf407ace9f03464dcf19b6a06d3fb"></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="classcsImageCubeMapMaker.html#00c0fe27b82bbfc21a57cd83a77edf2e">GetWidth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image width. <a href="#00c0fe27b82bbfc21a57cd83a77edf2e"></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="classcsImageCubeMapMaker.html#055960080dc6774a34861ee833705283">HasKeyColor</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if image has a keycolour stored with it. <a href="#055960080dc6774a34861ee833705283"></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="classcsImageCubeMapMaker.html#0903f8d02180b8a1b358de9efe228fff">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="#0903f8d02180b8a1b358de9efe228fff"></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="classcsImageCubeMapMaker.html#52ecf095e206b8a5a9a976d3978fe5ff">HasSubImages</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of sub images, in addition to this image. <a href="#52ecf095e206b8a5a9a976d3978fe5ff"></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="classcsImageCubeMapMaker.html#3759dc12092b59f0889ffb3466d24fbb">SetName</a> (const char *iName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the image. <a href="#3759dc12092b59f0889ffb3466d24fbb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageCubeMapMaker.html#b5d700b97bf778a3634bc5a01a7179f9">SetSubImage</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> num, <a class="el" href="structiImage.html">iImage</a> *image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a specific face. <a href="#b5d700b97bf778a3634bc5a01a7179f9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageCubeMapMaker.html#48bed2c5638f346ab8c0c9009e109d4e">SubImageSet</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether a face is specified. <a href="#48bed2c5638f346ab8c0c9009e109d4e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classcsImageCubeMapMaker.html#3acb9353eac4fab2640b22ac0556bc38a0f6e2130bea525edc7adac7c788e0be">NUM_FACES</a> = 6
}</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="classcsImageCubeMapMaker.html#20ba82a19e82ddec1f205ed1394297b4">CheckImage</a> (int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ensure that the image at <em>index</em> is valid. <a href="#20ba82a19e82ddec1f205ed1394297b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageCubeMapMaker.html#ff023fa7ed8b6970e2a866a3db2662a9">UpdateName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the image name from the contained images. <a href="#ff023fa7ed8b6970e2a866a3db2662a9"></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="classcsRef.html">csRef</a>< <a class="el" href="structiImage.html">iImage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageCubeMapMaker.html#030f381cbb1af627a4b68fbb55f22eed">cubeImages</a> [NUM_FACES]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The cube face images. <a href="#030f381cbb1af627a4b68fbb55f22eed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageCubeMapMaker.html#0fadbb559afe1c7c18c1df26ebe2105a">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="#0fadbb559afe1c7c18c1df26ebe2105a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Wrapper class to create a cube map from a number of 2D images as the cube faces.
<p>
Ensures that all faces are available when requested, if necessary by creating a new image (the famous and popular image-not-found checkerboard).
<p>Definition at line <a class="el" href="imagecubemapmaker_8h-source.html#l00041">41</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="3acb9353eac4fab2640b22ac0556bc38"></a><!-- doxytag: member="csImageCubeMapMaker::@29" ref="3acb9353eac4fab2640b22ac0556bc38" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum<code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="3acb9353eac4fab2640b22ac0556bc38a0f6e2130bea525edc7adac7c788e0be"></a><!-- doxytag: member="NUM_FACES" ref="3acb9353eac4fab2640b22ac0556bc38a0f6e2130bea525edc7adac7c788e0be" args="" -->NUM_FACES</em> </td><td>
Symbolic name for number of faces of a cube map. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="imagecubemapmaker_8h-source.html#l00045">45</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b2bf2f56510476e98a5e7dbaa61b85df"></a><!-- doxytag: member="csImageCubeMapMaker::csImageCubeMapMaker" ref="b2bf2f56510476e98a5e7dbaa61b85df" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageCubeMapMaker::csImageCubeMapMaker </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new map without faces set.
<p>
</div>
</div><p>
<a class="anchor" name="ab9722c223df953260a7d4657f93257d"></a><!-- doxytag: member="csImageCubeMapMaker::csImageCubeMapMaker" ref="ab9722c223df953260a7d4657f93257d" args="(iImage *source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageCubeMapMaker::csImageCubeMapMaker </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 the faces from <em>source</em>.
<p>
</div>
</div><p>
<a class="anchor" name="9bbe71322a6d7ee5839679258d1e2331"></a><!-- doxytag: member="csImageCubeMapMaker::csImageCubeMapMaker" ref="9bbe71322a6d7ee5839679258d1e2331" args="(iImage *posX, iImage *negX, iImage *posY, iImage *negY, iImage *posZ, iImage *negZ)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csImageCubeMapMaker::csImageCubeMapMaker </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>posX</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>negX</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>posY</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>negY</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>posZ</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>negZ</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 new map from separately specified Positive X, Positive Y etc.
<p>
images.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="20ba82a19e82ddec1f205ed1394297b4"></a><!-- doxytag: member="csImageCubeMapMaker::CheckImage" ref="20ba82a19e82ddec1f205ed1394297b4" args="(int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageCubeMapMaker::CheckImage </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ensure that the image at <em>index</em> is valid.
<p>
</div>
</div><p>
<a class="anchor" name="daf90be8743b935bcebf931b878c51d4"></a><!-- doxytag: member="csImageCubeMapMaker::GetAlpha" ref="daf90be8743b935bcebf931b878c51d4" 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>* csImageCubeMapMaker::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="42b0da787053aebbeab41ad8c78c722e"></a><!-- doxytag: member="csImageCubeMapMaker::GetFormat" ref="42b0da787053aebbeab41ad8c78c722e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csImageCubeMapMaker::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="08b1d618ff2b0cfd6e33efe95beab34e"></a><!-- doxytag: member="csImageCubeMapMaker::GetHeight" ref="08b1d618ff2b0cfd6e33efe95beab34e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csImageCubeMapMaker::GetHeight </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [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>
</div>
</div><p>
<a class="anchor" name="bd77827fc1966df6aec28d3f5b43b857"></a><!-- doxytag: member="csImageCubeMapMaker::GetImageData" ref="bd77827fc1966df6aec28d3f5b43b857" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const void* csImageCubeMapMaker::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="57e23729d42b3137d94782b72b66d8e1"></a><!-- doxytag: member="csImageCubeMapMaker::GetImageType" ref="57e23729d42b3137d94782b72b66d8e1" 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> csImageCubeMapMaker::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="imagecubemapmaker_8h-source.html#l00104">104</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
<p>References <a class="el" href="image_8h-source.html#l00079">csimgCube</a>.</p>
</div>
</div><p>
<a class="anchor" name="3e7e0179fea867f85671f8367a83e81b"></a><!-- doxytag: member="csImageCubeMapMaker::GetKeyColor" ref="3e7e0179fea867f85671f8367a83e81b" args="(int &, int &, int &) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csImageCubeMapMaker::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>Definition at line <a class="el" href="imagecubemapmaker_8h-source.html#l00097">97</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c5f134c33fe9fbfcf62a9585975b502e"></a><!-- doxytag: member="csImageCubeMapMaker::GetMipmap" ref="c5f134c33fe9fbfcf62a9585975b502e" 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>> csImageCubeMapMaker::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> [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="classcsImageCubeMapMaker.html#0903f8d02180b8a1b358de9efe228fff" 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>
</div>
</div><p>
<a class="anchor" name="2b15a9f2e30f90fd82418b9eda0e0b75"></a><!-- doxytag: member="csImageCubeMapMaker::GetName" ref="2b15a9f2e30f90fd82418b9eda0e0b75" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csImageCubeMapMaker::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="classcsImageCubeMapMaker.html#3759dc12092b59f0889ffb3466d24fbb" title="Set the name of the image.">SetName()</a>, the default name will contain the names of the wrapped subimages, separated by ':', in the form <code>posx.png:negx.png:posy.png:negy.png:posz.png:negz.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="imagecubemapmaker_8h-source.html#l00090">90</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b8767b4bdbf8d9ef64ed3c5fc8668931"></a><!-- doxytag: member="csImageCubeMapMaker::GetPalette" ref="b8767b4bdbf8d9ef64ed3c5fc8668931" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a>* csImageCubeMapMaker::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="14aaa8b027bc3d77db31bb5808046ce5"></a><!-- doxytag: member="csImageCubeMapMaker::GetRawData" ref="14aaa8b027bc3d77db31bb5808046ce5" 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>> csImageCubeMapMaker::GetRawData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [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>
</div>
</div><p>
<a class="anchor" name="6707c60c37d82db16217cf9ae1cb508a"></a><!-- doxytag: member="csImageCubeMapMaker::GetRawFormat" ref="6707c60c37d82db16217cf9ae1cb508a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csImageCubeMapMaker::GetRawFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [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>
</div>
</div><p>
<a class="anchor" name="d94bf407ace9f03464dcf19b6a06d3fb"></a><!-- doxytag: member="csImageCubeMapMaker::GetSubImage" ref="d94bf407ace9f03464dcf19b6a06d3fb" 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>> csImageCubeMapMaker::GetSubImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>num</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query a sub image.
<p>
A value of 0 for <em>num</em> returns the original image, a value larger or equal than the return value of <a class="el" href="classcsImageCubeMapMaker.html#52ecf095e206b8a5a9a976d3978fe5ff" title="Returns the number of sub images, in addition to this image.">HasSubImages()</a> returns that sub image, any other value returns 0.
<p>Reimplemented from <a class="el" href="classcsImageBase.html#1c9b0cac6e4263c30ea2ef9b2483ac39">csImageBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="00c0fe27b82bbfc21a57cd83a77edf2e"></a><!-- doxytag: member="csImageCubeMapMaker::GetWidth" ref="00c0fe27b82bbfc21a57cd83a77edf2e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csImageCubeMapMaker::GetWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [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>
</div>
</div><p>
<a class="anchor" name="055960080dc6774a34861ee833705283"></a><!-- doxytag: member="csImageCubeMapMaker::HasKeyColor" ref="055960080dc6774a34861ee833705283" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csImageCubeMapMaker::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>Definition at line <a class="el" href="imagecubemapmaker_8h-source.html#l00096">96</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0903f8d02180b8a1b358de9efe228fff"></a><!-- doxytag: member="csImageCubeMapMaker::HasMipmaps" ref="0903f8d02180b8a1b358de9efe228fff" 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> csImageCubeMapMaker::HasMipmaps </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [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>
</div>
</div><p>
<a class="anchor" name="52ecf095e206b8a5a9a976d3978fe5ff"></a><!-- doxytag: member="csImageCubeMapMaker::HasSubImages" ref="52ecf095e206b8a5a9a976d3978fe5ff" 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> csImageCubeMapMaker::HasSubImages </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 sub images, in addition to this image.
<p>
Subimages are usually used for cube map faces.
<p>Reimplemented from <a class="el" href="classcsImageBase.html#cd8a764af200c94c351677087d66d28e">csImageBase</a>.</p>
<p>Definition at line <a class="el" href="imagecubemapmaker_8h-source.html#l00105">105</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="3759dc12092b59f0889ffb3466d24fbb"></a><!-- doxytag: member="csImageCubeMapMaker::SetName" ref="3759dc12092b59f0889ffb3466d24fbb" args="(const char *iName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csImageCubeMapMaker::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>
<a class="anchor" name="b5d700b97bf778a3634bc5a01a7179f9"></a><!-- doxytag: member="csImageCubeMapMaker::SetSubImage" ref="b5d700b97bf778a3634bc5a01a7179f9" args="(uint num, iImage *image)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageCubeMapMaker::SetSubImage </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>image</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>
Set a specific face.
<p>
</div>
</div><p>
<a class="anchor" name="48bed2c5638f346ab8c0c9009e109d4e"></a><!-- doxytag: member="csImageCubeMapMaker::SubImageSet" ref="48bed2c5638f346ab8c0c9009e109d4e" args="(uint num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csImageCubeMapMaker::SubImageSet </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]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check whether a face is specified.
<p>
The difference from GetSubImage(num) is that <a class="el" href="classcsImageCubeMapMaker.html#d94bf407ace9f03464dcf19b6a06d3fb" title="Query a sub image.">GetSubImage()</a> will always return an image != 0, while <a class="el" href="classcsImageCubeMapMaker.html#48bed2c5638f346ab8c0c9009e109d4e" title="Check whether a face is specified.">SubImageSet()</a> checks whether the internal face reference is 0 or not.
<p>Definition at line <a class="el" href="imagecubemapmaker_8h-source.html#l00116">116</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="ff023fa7ed8b6970e2a866a3db2662a9"></a><!-- doxytag: member="csImageCubeMapMaker::UpdateName" ref="ff023fa7ed8b6970e2a866a3db2662a9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csImageCubeMapMaker::UpdateName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the image name from the contained images.
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="030f381cbb1af627a4b68fbb55f22eed"></a><!-- doxytag: member="csImageCubeMapMaker::cubeImages" ref="030f381cbb1af627a4b68fbb55f22eed" args="[NUM_FACES]" -->
<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="structiImage.html">iImage</a>> <a class="el" href="classcsImageCubeMapMaker.html#030f381cbb1af627a4b68fbb55f22eed">csImageCubeMapMaker::cubeImages</a>[NUM_FACES]<code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The cube face images.
<p>
<p>Definition at line <a class="el" href="imagecubemapmaker_8h-source.html#l00051">51</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0fadbb559afe1c7c18c1df26ebe2105a"></a><!-- doxytag: member="csImageCubeMapMaker::manualName" ref="0fadbb559afe1c7c18c1df26ebe2105a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsImageCubeMapMaker.html#0fadbb559afe1c7c18c1df26ebe2105a">csImageCubeMapMaker::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="imagecubemapmaker_8h-source.html#l00056">56</a> of file <a class="el" href="imagecubemapmaker_8h-source.html">imagecubemapmaker.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="imagecubemapmaker_8h-source.html">imagecubemapmaker.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
>
662
