diff options
| author | manuel <manuel@nc8430.lan> | 2009-05-02 18:58:26 +0200 |
|---|---|---|
| committer | manuel <manuel@nc8430.lan> | 2009-05-02 18:58:26 +0200 |
| commit | 93a6590af7f866838d883d92fac655251685c3d7 (patch) | |
| tree | 57401b84345a4a36cee8cca2731fe567577f29e2 /ue2/doxygen/classCPixmap.html | |
| parent | bc94c4be2e7e37f1f3e8892dc115e61ed6b640e7 (diff) | |
| download | ooprog-93a6590af7f866838d883d92fac655251685c3d7.tar.gz ooprog-93a6590af7f866838d883d92fac655251685c3d7.tar.bz2 ooprog-93a6590af7f866838d883d92fac655251685c3d7.zip | |
adding doxygen files
Diffstat (limited to 'ue2/doxygen/classCPixmap.html')
| -rw-r--r-- | ue2/doxygen/classCPixmap.html | 596 |
1 files changed, 596 insertions, 0 deletions
diff --git a/ue2/doxygen/classCPixmap.html b/ue2/doxygen/classCPixmap.html new file mode 100644 index 0000000..cb1d740 --- /dev/null +++ b/ue2/doxygen/classCPixmap.html | |||
| @@ -0,0 +1,596 @@ | |||
| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> | ||
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> | ||
| 3 | <title>imgsynth2: CPixmap Class Reference</title> | ||
| 4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> | ||
| 5 | <link href="tabs.css" rel="stylesheet" type="text/css"> | ||
| 6 | </head><body> | ||
| 7 | <!-- Generated by Doxygen 1.5.3 --> | ||
| 8 | <div class="tabs"> | ||
| 9 | <ul> | ||
| 10 | <li><a href="index.html"><span>Main Page</span></a></li> | ||
| 11 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> | ||
| 12 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> | ||
| 13 | <li><a href="files.html"><span>Files</span></a></li> | ||
| 14 | </ul> | ||
| 15 | </div> | ||
| 16 | <div class="tabs"> | ||
| 17 | <ul> | ||
| 18 | <li><a href="annotated.html"><span>Class List</span></a></li> | ||
| 19 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> | ||
| 20 | <li><a href="functions.html"><span>Class Members</span></a></li> | ||
| 21 | </ul> | ||
| 22 | </div> | ||
| 23 | <h1>CPixmap Class Reference</h1><!-- doxytag: class="CPixmap" --><!-- doxytag: inherits="CBitmap" -->Implementation of <a class="el" href="classCFile.html" title="Abstract class for handling files. Needed for generic use in CScriptparser.">CFile</a> handling Pixmap file format. | ||
| 24 | <a href="#_details">More...</a> | ||
| 25 | <p> | ||
| 26 | <code>#include <<a class="el" href="cpixmap_8h-source.html">cpixmap.h</a>></code> | ||
| 27 | <p> | ||
| 28 | <div class="dynheader"> | ||
| 29 | Inheritance diagram for CPixmap:</div> | ||
| 30 | <div class="dynsection"> | ||
| 31 | |||
| 32 | <p><center><img src="classCPixmap.png" usemap="#CPixmap_map" border="0" alt=""></center> | ||
| 33 | <map name="CPixmap_map"> | ||
| 34 | <area href="classCBitmap.html" alt="CBitmap" shape="rect" coords="0,56,61,80"> | ||
| 35 | <area href="classCFile.html" alt="CFile" shape="rect" coords="0,0,61,24"> | ||
| 36 | </map> | ||
| 37 | </div> | ||
| 38 | |||
| 39 | <p> | ||
| 40 | <a href="classCPixmap-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> | ||
| 41 | <tr><td></td></tr> | ||
| 42 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> | ||
| 43 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#32f42f22fc98398d87946895139d0b60">CPixmap</a> ()</td></tr> | ||
| 44 | |||
| 45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default ctor. <a href="#32f42f22fc98398d87946895139d0b60"></a><br></td></tr> | ||
| 46 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#6bba8999f9c8bfd410561bc62a4fd6fc">~CPixmap</a> ()</td></tr> | ||
| 47 | |||
| 48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default dtor. <a href="#6bba8999f9c8bfd410561bc62a4fd6fc"></a><br></td></tr> | ||
| 49 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#ef3b715729ca384e6817a3fcdddfa261">read</a> (std::ifstream &in)</td></tr> | ||
| 50 | |||
| 51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Reads Pixmap from filestream. On error an exception is thrown. <a href="#ef3b715729ca384e6817a3fcdddfa261"></a><br></td></tr> | ||
| 52 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#507d5a88f8af0e41e418108e01572f13">write</a> (std::ofstream &out)</td></tr> | ||
| 53 | |||
| 54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Writes Pixmap to filestream. <a href="#507d5a88f8af0e41e418108e01572f13"></a><br></td></tr> | ||
| 55 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#740486bba3c8ea24f306a7b8248652e2">getPixelDataSize</a> ()</td></tr> | ||
| 56 | |||
| 57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return size of pixelbuffer. <a href="#740486bba3c8ea24f306a7b8248652e2"></a><br></td></tr> | ||
| 58 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#3f50d434556073a883bb5a2650cf2f71">getHeight</a> ()</td></tr> | ||
| 59 | |||
| 60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return height of bitmap in pixel. <a href="#3f50d434556073a883bb5a2650cf2f71"></a><br></td></tr> | ||
| 61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#f3419c1f68c7aa2c69d1e83b2ee6be8c">getWidth</a> ()</td></tr> | ||
| 62 | |||
| 63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return width of bitmap in pixel. <a href="#f3419c1f68c7aa2c69d1e83b2ee6be8c"></a><br></td></tr> | ||
| 64 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#fc2876d5d93122f22eb1759381030980">hasColorTable</a> ()</td></tr> | ||
| 65 | |||
| 66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Check if bitmap has a colortable (we don't support this yet for windows bitmaps). <a href="#fc2876d5d93122f22eb1759381030980"></a><br></td></tr> | ||
| 67 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#0cbf88af3060d338b1d288cb930c8b49">isMirrored</a> ()</td></tr> | ||
| 68 | |||
| 69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Windows Bitmaps can be stored upside down. <a href="#0cbf88af3060d338b1d288cb930c8b49"></a><br></td></tr> | ||
| 70 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> | ||
| 71 | <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#0d93bfe35b557f3827f90aa81685aff4">getLine</a> (std::ifstream &in, bool ignore_comments=true)</td></tr> | ||
| 72 | |||
| 73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">read trimmed line (terminated by <br> | ||
| 74 | ) from filestream <a href="#0d93bfe35b557f3827f90aa81685aff4"></a><br></td></tr> | ||
| 75 | <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#4fea1d2e3e528e660f48f37fa91aedae">getCArrayLine</a> (std::ifstream &in)</td></tr> | ||
| 76 | |||
| 77 | <tr><td class="mdescLeft"> </td><td class="mdescRight">read trimmed c-arrayline from filestream <a href="#4fea1d2e3e528e660f48f37fa91aedae"></a><br></td></tr> | ||
| 78 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#51b3aeac4afa31c11188cf844a40f0fc">getXPMColorID</a> (unsigned int index, unsigned int length)</td></tr> | ||
| 79 | |||
| 80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">get xpm color identifier, generated using an index <a href="#51b3aeac4afa31c11188cf844a40f0fc"></a><br></td></tr> | ||
| 81 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> | ||
| 82 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structCPixmap_1_1PIXMAP__FILEHEADER.html">PIXMAP_FILEHEADER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#5ca3e44f4f5a3d7a94d0f7a83d30eb2b">m_fileheader</a></td></tr> | ||
| 83 | |||
| 84 | <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#ac8ee30e3375e15684c1263d7c9b8dd4">m_imagename</a></td></tr> | ||
| 85 | |||
| 86 | <tr><td colspan="2"><br><h2>Classes</h2></td></tr> | ||
| 87 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structCPixmap_1_1PIXMAP__FILEHEADER.html">PIXMAP_FILEHEADER</a></td></tr> | ||
| 88 | |||
| 89 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Pixmap Header structure. <a href="structCPixmap_1_1PIXMAP__FILEHEADER.html#_details">More...</a><br></td></tr> | ||
| 90 | </table> | ||
| 91 | <hr><a name="_details"></a><h2>Detailed Description</h2> | ||
| 92 | Implementation of <a class="el" href="classCFile.html" title="Abstract class for handling files. Needed for generic use in CScriptparser.">CFile</a> handling Pixmap file format. | ||
| 93 | <p> | ||
| 94 | In order to support operations on pixmaps in color mode an implementations of <a class="el" href="classCPixelFormat.html" title="Abstract class for handling different color bitcount of Bitmaps.">CPixelFormat</a> is used. These classe are allowed to modify the pixmap header, pixelbuffer and color table directly.<p> | ||
| 95 | On error <a class="el" href="classCFile_1_1FileError.html" title="Exception thrown by implemententations of CFile.">CFile::FileError</a> is thrown. <hr><h2>Constructor & Destructor Documentation</h2> | ||
| 96 | <a class="anchor" name="32f42f22fc98398d87946895139d0b60"></a><!-- doxytag: member="CPixmap::CPixmap" ref="32f42f22fc98398d87946895139d0b60" args="()" --> | ||
| 97 | <div class="memitem"> | ||
| 98 | <div class="memproto"> | ||
| 99 | <table class="memname"> | ||
| 100 | <tr> | ||
| 101 | <td class="memname">CPixmap::CPixmap </td> | ||
| 102 | <td>(</td> | ||
| 103 | <td class="paramname"> </td> | ||
| 104 | <td> ) </td> | ||
| 105 | <td width="100%"></td> | ||
| 106 | </tr> | ||
| 107 | </table> | ||
| 108 | </div> | ||
| 109 | <div class="memdoc"> | ||
| 110 | |||
| 111 | <p> | ||
| 112 | Default ctor. | ||
| 113 | <p> | ||
| 114 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd><a class="el" href="classCPixmap.html" title="Implementation of CFile handling Pixmap file format.">CPixmap</a> </dd></dl> | ||
| 115 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 116 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 117 | <tr><td valign="top"></td><td valign="top"><em>-</em> </td><td></td></tr> | ||
| 118 | </table> | ||
| 119 | </dl> | ||
| 120 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl> | ||
| 121 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 122 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 123 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 124 | <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> | ||
| 125 | </table> | ||
| 126 | </dl> | ||
| 127 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 128 | |||
| 129 | </div> | ||
| 130 | </div><p> | ||
| 131 | <a class="anchor" name="6bba8999f9c8bfd410561bc62a4fd6fc"></a><!-- doxytag: member="CPixmap::~CPixmap" ref="6bba8999f9c8bfd410561bc62a4fd6fc" args="()" --> | ||
| 132 | <div class="memitem"> | ||
| 133 | <div class="memproto"> | ||
| 134 | <table class="memname"> | ||
| 135 | <tr> | ||
| 136 | <td class="memname">CPixmap::~CPixmap </td> | ||
| 137 | <td>(</td> | ||
| 138 | <td class="paramname"> </td> | ||
| 139 | <td> ) </td> | ||
| 140 | <td width="100%"><code> [inline]</code></td> | ||
| 141 | </tr> | ||
| 142 | </table> | ||
| 143 | </div> | ||
| 144 | <div class="memdoc"> | ||
| 145 | |||
| 146 | <p> | ||
| 147 | Default dtor. | ||
| 148 | <p> | ||
| 149 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CPixmap </dd></dl> | ||
| 150 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 151 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 152 | <tr><td valign="top"></td><td valign="top"><em>-</em> </td><td></td></tr> | ||
| 153 | </table> | ||
| 154 | </dl> | ||
| 155 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl> | ||
| 156 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 157 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 158 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 159 | <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> | ||
| 160 | </table> | ||
| 161 | </dl> | ||
| 162 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 163 | |||
| 164 | </div> | ||
| 165 | </div><p> | ||
| 166 | <hr><h2>Member Function Documentation</h2> | ||
| 167 | <a class="anchor" name="ef3b715729ca384e6817a3fcdddfa261"></a><!-- doxytag: member="CPixmap::read" ref="ef3b715729ca384e6817a3fcdddfa261" args="(std::ifstream &in)" --> | ||
| 168 | <div class="memitem"> | ||
| 169 | <div class="memproto"> | ||
| 170 | <table class="memname"> | ||
| 171 | <tr> | ||
| 172 | <td class="memname">void CPixmap::read </td> | ||
| 173 | <td>(</td> | ||
| 174 | <td class="paramtype">std::ifstream & </td> | ||
| 175 | <td class="paramname"> <em>in</em> </td> | ||
| 176 | <td> ) </td> | ||
| 177 | <td width="100%"><code> [virtual]</code></td> | ||
| 178 | </tr> | ||
| 179 | </table> | ||
| 180 | </div> | ||
| 181 | <div class="memdoc"> | ||
| 182 | |||
| 183 | <p> | ||
| 184 | Reads Pixmap from filestream. On error an exception is thrown. | ||
| 185 | <p> | ||
| 186 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>read </dd></dl> | ||
| 187 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 188 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 189 | <tr><td valign="top"></td><td valign="top"><em>in</em> </td><td>filestream to read data from </td></tr> | ||
| 190 | </table> | ||
| 191 | </dl> | ||
| 192 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl> | ||
| 193 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 194 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 195 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 196 | <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCFile_1_1FileError.html" title="Exception thrown by implemententations of CFile.">CFile::FileError</a></em> </td><td></td></tr> | ||
| 197 | <tr><td valign="top"></td><td valign="top"><em>bad_alloc</em> </td><td></td></tr> | ||
| 198 | </table> | ||
| 199 | </dl> | ||
| 200 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 201 | |||
| 202 | <p>Implements <a class="el" href="classCBitmap.html#beaf444a418973a1bf8373f236d54421">CBitmap</a>.</p> | ||
| 203 | |||
| 204 | </div> | ||
| 205 | </div><p> | ||
| 206 | <a class="anchor" name="507d5a88f8af0e41e418108e01572f13"></a><!-- doxytag: member="CPixmap::write" ref="507d5a88f8af0e41e418108e01572f13" args="(std::ofstream &out)" --> | ||
| 207 | <div class="memitem"> | ||
| 208 | <div class="memproto"> | ||
| 209 | <table class="memname"> | ||
| 210 | <tr> | ||
| 211 | <td class="memname">void CPixmap::write </td> | ||
| 212 | <td>(</td> | ||
| 213 | <td class="paramtype">std::ofstream & </td> | ||
| 214 | <td class="paramname"> <em>out</em> </td> | ||
| 215 | <td> ) </td> | ||
| 216 | <td width="100%"><code> [virtual]</code></td> | ||
| 217 | </tr> | ||
| 218 | </table> | ||
| 219 | </div> | ||
| 220 | <div class="memdoc"> | ||
| 221 | |||
| 222 | <p> | ||
| 223 | Writes Pixmap to filestream. | ||
| 224 | <p> | ||
| 225 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>write </dd></dl> | ||
| 226 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 227 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 228 | <tr><td valign="top"></td><td valign="top"><em>out</em> </td><td>filestream to read data from </td></tr> | ||
| 229 | </table> | ||
| 230 | </dl> | ||
| 231 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl> | ||
| 232 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 233 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 234 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 235 | <tr><td valign="top"></td><td valign="top"><em>FileError</em> </td><td></td></tr> | ||
| 236 | <tr><td valign="top"></td><td valign="top"><em>bad_alloc</em> </td><td></td></tr> | ||
| 237 | </table> | ||
| 238 | </dl> | ||
| 239 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 240 | |||
| 241 | <p>Implements <a class="el" href="classCBitmap.html#bfa214932af1cc21817dde3dbe3c61c6">CBitmap</a>.</p> | ||
| 242 | |||
| 243 | </div> | ||
| 244 | </div><p> | ||
| 245 | <a class="anchor" name="740486bba3c8ea24f306a7b8248652e2"></a><!-- doxytag: member="CPixmap::getPixelDataSize" ref="740486bba3c8ea24f306a7b8248652e2" args="()" --> | ||
| 246 | <div class="memitem"> | ||
| 247 | <div class="memproto"> | ||
| 248 | <table class="memname"> | ||
| 249 | <tr> | ||
| 250 | <td class="memname">const uint32_t CPixmap::getPixelDataSize </td> | ||
| 251 | <td>(</td> | ||
| 252 | <td class="paramname"> </td> | ||
| 253 | <td> ) </td> | ||
| 254 | <td width="100%"><code> [inline, virtual]</code></td> | ||
| 255 | </tr> | ||
| 256 | </table> | ||
| 257 | </div> | ||
| 258 | <div class="memdoc"> | ||
| 259 | |||
| 260 | <p> | ||
| 261 | Return size of pixelbuffer. | ||
| 262 | <p> | ||
| 263 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>getPixelDataSize </dd></dl> | ||
| 264 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 265 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 266 | <tr><td valign="top"></td><td valign="top"><em>-</em> </td><td></td></tr> | ||
| 267 | </table> | ||
| 268 | </dl> | ||
| 269 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>size of pixelbuffer </dd></dl> | ||
| 270 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 271 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 272 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 273 | <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> | ||
| 274 | </table> | ||
| 275 | </dl> | ||
| 276 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 277 | |||
| 278 | <p>Implements <a class="el" href="classCBitmap.html#7ea12e77a86c283ce173785c64384c33">CBitmap</a>.</p> | ||
| 279 | |||
| 280 | </div> | ||
| 281 | </div><p> | ||
| 282 | <a class="anchor" name="3f50d434556073a883bb5a2650cf2f71"></a><!-- doxytag: member="CPixmap::getHeight" ref="3f50d434556073a883bb5a2650cf2f71" args="()" --> | ||
| 283 | <div class="memitem"> | ||
| 284 | <div class="memproto"> | ||
| 285 | <table class="memname"> | ||
| 286 | <tr> | ||
| 287 | <td class="memname">const uint32_t CPixmap::getHeight </td> | ||
| 288 | <td>(</td> | ||
| 289 | <td class="paramname"> </td> | ||
| 290 | <td> ) </td> | ||
| 291 | <td width="100%"><code> [inline, virtual]</code></td> | ||
| 292 | </tr> | ||
| 293 | </table> | ||
| 294 | </div> | ||
| 295 | <div class="memdoc"> | ||
| 296 | |||
| 297 | <p> | ||
| 298 | Return height of bitmap in pixel. | ||
| 299 | <p> | ||
| 300 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>getHeight </dd></dl> | ||
| 301 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 302 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 303 | <tr><td valign="top"></td><td valign="top"><em>-</em> </td><td></td></tr> | ||
| 304 | </table> | ||
| 305 | </dl> | ||
| 306 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>height of bitmap in pixel </dd></dl> | ||
| 307 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 308 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 309 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 310 | <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> | ||
| 311 | </table> | ||
| 312 | </dl> | ||
| 313 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 314 | |||
| 315 | <p>Implements <a class="el" href="classCBitmap.html#a69618d5309e1f51741a8be98ce44c02">CBitmap</a>.</p> | ||
| 316 | |||
| 317 | </div> | ||
| 318 | </div><p> | ||
| 319 | <a class="anchor" name="f3419c1f68c7aa2c69d1e83b2ee6be8c"></a><!-- doxytag: member="CPixmap::getWidth" ref="f3419c1f68c7aa2c69d1e83b2ee6be8c" args="()" --> | ||
| 320 | <div class="memitem"> | ||
| 321 | <div class="memproto"> | ||
| 322 | <table class="memname"> | ||
| 323 | <tr> | ||
| 324 | <td class="memname">const uint32_t CPixmap::getWidth </td> | ||
| 325 | <td>(</td> | ||
| 326 | <td class="paramname"> </td> | ||
| 327 | <td> ) </td> | ||
| 328 | <td width="100%"><code> [inline, virtual]</code></td> | ||
| 329 | </tr> | ||
| 330 | </table> | ||
| 331 | </div> | ||
| 332 | <div class="memdoc"> | ||
| 333 | |||
| 334 | <p> | ||
| 335 | Return width of bitmap in pixel. | ||
| 336 | <p> | ||
| 337 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>getWidth </dd></dl> | ||
| 338 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 339 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 340 | <tr><td valign="top"></td><td valign="top"><em>-</em> </td><td></td></tr> | ||
| 341 | </table> | ||
| 342 | </dl> | ||
| 343 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>width of bitmap in pixel </dd></dl> | ||
| 344 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 345 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 346 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 347 | <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> | ||
| 348 | </table> | ||
| 349 | </dl> | ||
| 350 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 351 | |||
| 352 | <p>Implements <a class="el" href="classCBitmap.html#82ffb686b4d4c7465c5239a984bf6fe4">CBitmap</a>.</p> | ||
| 353 | |||
| 354 | </div> | ||
| 355 | </div><p> | ||
| 356 | <a class="anchor" name="fc2876d5d93122f22eb1759381030980"></a><!-- doxytag: member="CPixmap::hasColorTable" ref="fc2876d5d93122f22eb1759381030980" args="()" --> | ||
| 357 | <div class="memitem"> | ||
| 358 | <div class="memproto"> | ||
| 359 | <table class="memname"> | ||
| 360 | <tr> | ||
| 361 | <td class="memname">const bool CPixmap::hasColorTable </td> | ||
| 362 | <td>(</td> | ||
| 363 | <td class="paramname"> </td> | ||
| 364 | <td> ) </td> | ||
| 365 | <td width="100%"><code> [inline, virtual]</code></td> | ||
| 366 | </tr> | ||
| 367 | </table> | ||
| 368 | </div> | ||
| 369 | <div class="memdoc"> | ||
| 370 | |||
| 371 | <p> | ||
| 372 | Check if bitmap has a colortable (we don't support this yet for windows bitmaps). | ||
| 373 | <p> | ||
| 374 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>hasColorTable </dd></dl> | ||
| 375 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 376 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 377 | <tr><td valign="top"></td><td valign="top"><em>-</em> </td><td></td></tr> | ||
| 378 | </table> | ||
| 379 | </dl> | ||
| 380 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if bitmap has a colortable. false otherwise </dd></dl> | ||
| 381 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 382 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 383 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 384 | <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> | ||
| 385 | </table> | ||
| 386 | </dl> | ||
| 387 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 388 | |||
| 389 | <p>Implements <a class="el" href="classCBitmap.html#9b38397779b83cbc0a71e40cc3995025">CBitmap</a>.</p> | ||
| 390 | |||
| 391 | </div> | ||
| 392 | </div><p> | ||
| 393 | <a class="anchor" name="0cbf88af3060d338b1d288cb930c8b49"></a><!-- doxytag: member="CPixmap::isMirrored" ref="0cbf88af3060d338b1d288cb930c8b49" args="()" --> | ||
| 394 | <div class="memitem"> | ||
| 395 | <div class="memproto"> | ||
| 396 | <table class="memname"> | ||
| 397 | <tr> | ||
| 398 | <td class="memname">const bool CPixmap::isMirrored </td> | ||
| 399 | <td>(</td> | ||
| 400 | <td class="paramname"> </td> | ||
| 401 | <td> ) </td> | ||
| 402 | <td width="100%"><code> [inline, virtual]</code></td> | ||
| 403 | </tr> | ||
| 404 | </table> | ||
| 405 | </div> | ||
| 406 | <div class="memdoc"> | ||
| 407 | |||
| 408 | <p> | ||
| 409 | Windows Bitmaps can be stored upside down. | ||
| 410 | <p> | ||
| 411 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>isMirrored </dd></dl> | ||
| 412 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 413 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 414 | <tr><td valign="top"></td><td valign="top"><em>-</em> </td><td></td></tr> | ||
| 415 | </table> | ||
| 416 | </dl> | ||
| 417 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if bitmap is stored upside down. false otherwise </dd></dl> | ||
| 418 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 419 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 420 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 421 | <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> | ||
| 422 | </table> | ||
| 423 | </dl> | ||
| 424 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 425 | |||
| 426 | <p>Implements <a class="el" href="classCBitmap.html#cd6bfd1ffca5f3c6d0faa29275733bad">CBitmap</a>.</p> | ||
| 427 | |||
| 428 | </div> | ||
| 429 | </div><p> | ||
| 430 | <a class="anchor" name="0d93bfe35b557f3827f90aa81685aff4"></a><!-- doxytag: member="CPixmap::getLine" ref="0d93bfe35b557f3827f90aa81685aff4" args="(std::ifstream &in, bool ignore_comments=true)" --> | ||
| 431 | <div class="memitem"> | ||
| 432 | <div class="memproto"> | ||
| 433 | <table class="memname"> | ||
| 434 | <tr> | ||
| 435 | <td class="memname">std::string CPixmap::getLine </td> | ||
| 436 | <td>(</td> | ||
| 437 | <td class="paramtype">std::ifstream & </td> | ||
| 438 | <td class="paramname"> <em>in</em>, </td> | ||
| 439 | </tr> | ||
| 440 | <tr> | ||
| 441 | <td class="paramkey"></td> | ||
| 442 | <td></td> | ||
| 443 | <td class="paramtype">bool </td> | ||
| 444 | <td class="paramname"> <em>ignore_comments</em> = <code>true</code></td><td> </td> | ||
| 445 | </tr> | ||
| 446 | <tr> | ||
| 447 | <td></td> | ||
| 448 | <td>)</td> | ||
| 449 | <td></td><td></td><td width="100%"><code> [protected]</code></td> | ||
| 450 | </tr> | ||
| 451 | </table> | ||
| 452 | </div> | ||
| 453 | <div class="memdoc"> | ||
| 454 | |||
| 455 | <p> | ||
| 456 | read trimmed line (terminated by <br> | ||
| 457 | ) from filestream | ||
| 458 | <p> | ||
| 459 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>getLine </dd></dl> | ||
| 460 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 461 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 462 | <tr><td valign="top"></td><td valign="top"><em>in</em> </td><td>filestream to read data from </td></tr> | ||
| 463 | <tr><td valign="top"></td><td valign="top"><em>ignore_comments</em> </td><td>true: ignore c-like comments </td></tr> | ||
| 464 | </table> | ||
| 465 | </dl> | ||
| 466 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>return trimmed line from filestream </dd></dl> | ||
| 467 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 468 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 469 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 470 | <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> | ||
| 471 | </table> | ||
| 472 | </dl> | ||
| 473 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 474 | |||
| 475 | </div> | ||
| 476 | </div><p> | ||
| 477 | <a class="anchor" name="4fea1d2e3e528e660f48f37fa91aedae"></a><!-- doxytag: member="CPixmap::getCArrayLine" ref="4fea1d2e3e528e660f48f37fa91aedae" args="(std::ifstream &in)" --> | ||
| 478 | <div class="memitem"> | ||
| 479 | <div class="memproto"> | ||
| 480 | <table class="memname"> | ||
| 481 | <tr> | ||
| 482 | <td class="memname">std::string CPixmap::getCArrayLine </td> | ||
| 483 | <td>(</td> | ||
| 484 | <td class="paramtype">std::ifstream & </td> | ||
| 485 | <td class="paramname"> <em>in</em> </td> | ||
| 486 | <td> ) </td> | ||
| 487 | <td width="100%"><code> [protected]</code></td> | ||
| 488 | </tr> | ||
| 489 | </table> | ||
| 490 | </div> | ||
| 491 | <div class="memdoc"> | ||
| 492 | |||
| 493 | <p> | ||
| 494 | read trimmed c-arrayline from filestream | ||
| 495 | <p> | ||
| 496 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>getArrayLine </dd></dl> | ||
| 497 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 498 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 499 | <tr><td valign="top"></td><td valign="top"><em>in</em> </td><td>filestream to read data from </td></tr> | ||
| 500 | </table> | ||
| 501 | </dl> | ||
| 502 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>return trimmed c-arrayline from filestream </dd></dl> | ||
| 503 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 504 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 505 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 506 | <tr><td valign="top"></td><td valign="top"><em>FileError</em> </td><td></td></tr> | ||
| 507 | </table> | ||
| 508 | </dl> | ||
| 509 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 510 | |||
| 511 | </div> | ||
| 512 | </div><p> | ||
| 513 | <a class="anchor" name="51b3aeac4afa31c11188cf844a40f0fc"></a><!-- doxytag: member="CPixmap::getXPMColorID" ref="51b3aeac4afa31c11188cf844a40f0fc" args="(unsigned int index, unsigned int length)" --> | ||
| 514 | <div class="memitem"> | ||
| 515 | <div class="memproto"> | ||
| 516 | <table class="memname"> | ||
| 517 | <tr> | ||
| 518 | <td class="memname">const std::string CPixmap::getXPMColorID </td> | ||
| 519 | <td>(</td> | ||
| 520 | <td class="paramtype">unsigned int </td> | ||
| 521 | <td class="paramname"> <em>index</em>, </td> | ||
| 522 | </tr> | ||
| 523 | <tr> | ||
| 524 | <td class="paramkey"></td> | ||
| 525 | <td></td> | ||
| 526 | <td class="paramtype">unsigned int </td> | ||
| 527 | <td class="paramname"> <em>length</em></td><td> </td> | ||
| 528 | </tr> | ||
| 529 | <tr> | ||
| 530 | <td></td> | ||
| 531 | <td>)</td> | ||
| 532 | <td></td><td></td><td width="100%"><code> [protected]</code></td> | ||
| 533 | </tr> | ||
| 534 | </table> | ||
| 535 | </div> | ||
| 536 | <div class="memdoc"> | ||
| 537 | |||
| 538 | <p> | ||
| 539 | get xpm color identifier, generated using an index | ||
| 540 | <p> | ||
| 541 | <dl class="user" compact><dt><b>Methodname:</b></dt><dd>getXPMColorID </dd></dl> | ||
| 542 | <dl compact><dt><b>Parameters:</b></dt><dd> | ||
| 543 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 544 | <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>index used to generate the xpm color identifier </td></tr> | ||
| 545 | <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>length of xpm color identifier </td></tr> | ||
| 546 | </table> | ||
| 547 | </dl> | ||
| 548 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>return xpm color identifier, generated using index </dd></dl> | ||
| 549 | <dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl> | ||
| 550 | <dl compact><dt><b>Exceptions:</b></dt><dd> | ||
| 551 | <table border="0" cellspacing="2" cellpadding="0"> | ||
| 552 | <tr><td valign="top"></td><td valign="top"><em>FileError</em> </td><td></td></tr> | ||
| 553 | </table> | ||
| 554 | </dl> | ||
| 555 | <dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl> | ||
| 556 | |||
| 557 | </div> | ||
| 558 | </div><p> | ||
| 559 | <hr><h2>Member Data Documentation</h2> | ||
| 560 | <a class="anchor" name="5ca3e44f4f5a3d7a94d0f7a83d30eb2b"></a><!-- doxytag: member="CPixmap::m_fileheader" ref="5ca3e44f4f5a3d7a94d0f7a83d30eb2b" args="" --> | ||
| 561 | <div class="memitem"> | ||
| 562 | <div class="memproto"> | ||
| 563 | <table class="memname"> | ||
| 564 | <tr> | ||
| 565 | <td class="memname"><a class="el" href="structCPixmap_1_1PIXMAP__FILEHEADER.html">PIXMAP_FILEHEADER</a> <a class="el" href="classCPixmap.html#5ca3e44f4f5a3d7a94d0f7a83d30eb2b">CPixmap::m_fileheader</a><code> [protected]</code> </td> | ||
| 566 | </tr> | ||
| 567 | </table> | ||
| 568 | </div> | ||
| 569 | <div class="memdoc"> | ||
| 570 | |||
| 571 | <p> | ||
| 572 | fileheader | ||
| 573 | </div> | ||
| 574 | </div><p> | ||
| 575 | <a class="anchor" name="ac8ee30e3375e15684c1263d7c9b8dd4"></a><!-- doxytag: member="CPixmap::m_imagename" ref="ac8ee30e3375e15684c1263d7c9b8dd4" args="" --> | ||
| 576 | <div class="memitem"> | ||
| 577 | <div class="memproto"> | ||
| 578 | <table class="memname"> | ||
| 579 | <tr> | ||
| 580 | <td class="memname">std::string <a class="el" href="classCPixmap.html#ac8ee30e3375e15684c1263d7c9b8dd4">CPixmap::m_imagename</a><code> [protected]</code> </td> | ||
| 581 | </tr> | ||
| 582 | </table> | ||
| 583 | </div> | ||
| 584 | <div class="memdoc"> | ||
| 585 | |||
| 586 | <p> | ||
| 587 | name of image/c-array | ||
| 588 | </div> | ||
| 589 | </div><p> | ||
| 590 | <hr>The documentation for this class was generated from the following files:<ul> | ||
| 591 | <li>imgsynth2/<a class="el" href="cpixmap_8h-source.html">cpixmap.h</a><li>imgsynth2/cpixmap.cpp</ul> | ||
| 592 | <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 18:58:11 2009 for imgsynth2 by | ||
| 593 | <a href="http://www.doxygen.org/index.html"> | ||
| 594 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> | ||
| 595 | </body> | ||
| 596 | </html> | ||
