ue2/doxygen/classCPixmap.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>imgsynth2: CPixmap Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<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.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="cpixmap_8h-source.html">cpixmap.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for CPixmap:</div>
<div class="dynsection">

<p><center><img src="classCPixmap.png" usemap="#CPixmap_map" border="0" alt=""></center>
<map name="CPixmap_map">
<area href="classCBitmap.html" alt="CBitmap" shape="rect" coords="0,56,61,80">
<area href="classCFile.html" alt="CFile" shape="rect" coords="0,0,61,24">
</map>
</div>

<p>
<a href="classCPixmap-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#32f42f22fc98398d87946895139d0b60">CPixmap</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctor.  <a href="#32f42f22fc98398d87946895139d0b60"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#6bba8999f9c8bfd410561bc62a4fd6fc">~CPixmap</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor.  <a href="#6bba8999f9c8bfd410561bc62a4fd6fc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#ef3b715729ca384e6817a3fcdddfa261">read</a> (std::ifstream &amp;in)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads Pixmap from filestream. On error an exception is thrown.  <a href="#ef3b715729ca384e6817a3fcdddfa261"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#507d5a88f8af0e41e418108e01572f13">write</a> (std::ofstream &amp;out)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes Pixmap to filestream.  <a href="#507d5a88f8af0e41e418108e01572f13"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#740486bba3c8ea24f306a7b8248652e2">getPixelDataSize</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return size of pixelbuffer.  <a href="#740486bba3c8ea24f306a7b8248652e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#3f50d434556073a883bb5a2650cf2f71">getHeight</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return height of bitmap in pixel.  <a href="#3f50d434556073a883bb5a2650cf2f71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#f3419c1f68c7aa2c69d1e83b2ee6be8c">getWidth</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return width of bitmap in pixel.  <a href="#f3419c1f68c7aa2c69d1e83b2ee6be8c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#fc2876d5d93122f22eb1759381030980">hasColorTable</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</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>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#0cbf88af3060d338b1d288cb930c8b49">isMirrored</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Windows Bitmaps can be stored upside down.  <a href="#0cbf88af3060d338b1d288cb930c8b49"></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">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#0d93bfe35b557f3827f90aa81685aff4">getLine</a> (std::ifstream &amp;in, bool ignore_comments=true)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">read trimmed line (terminated by <br>
) from filestream  <a href="#0d93bfe35b557f3827f90aa81685aff4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#4fea1d2e3e528e660f48f37fa91aedae">getCArrayLine</a> (std::ifstream &amp;in)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">read trimmed c-arrayline from filestream  <a href="#4fea1d2e3e528e660f48f37fa91aedae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#51b3aeac4afa31c11188cf844a40f0fc">getXPMColorID</a> (unsigned int index, unsigned int length)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get xpm color identifier, generated using an index  <a href="#51b3aeac4afa31c11188cf844a40f0fc"></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="structCPixmap_1_1PIXMAP__FILEHEADER.html">PIXMAP_FILEHEADER</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#5ca3e44f4f5a3d7a94d0f7a83d30eb2b">m_fileheader</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixmap.html#ac8ee30e3375e15684c1263d7c9b8dd4">m_imagename</a></td></tr>

<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCPixmap_1_1PIXMAP__FILEHEADER.html">PIXMAP_FILEHEADER</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pixmap Header structure.  <a href="structCPixmap_1_1PIXMAP__FILEHEADER.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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. 
<p>
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>
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 &amp; Destructor Documentation</h2>
<a class="anchor" name="32f42f22fc98398d87946895139d0b60"></a><!-- doxytag: member="CPixmap::CPixmap" ref="32f42f22fc98398d87946895139d0b60" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CPixmap::CPixmap           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default ctor. 
<p>
<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>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<a class="anchor" name="6bba8999f9c8bfd410561bc62a4fd6fc"></a><!-- doxytag: member="CPixmap::~CPixmap" ref="6bba8999f9c8bfd410561bc62a4fd6fc" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CPixmap::~CPixmap           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default dtor. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CPixmap </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ef3b715729ca384e6817a3fcdddfa261"></a><!-- doxytag: member="CPixmap::read" ref="ef3b715729ca384e6817a3fcdddfa261" args="(std::ifstream &amp;in)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPixmap::read           </td>
          <td>(</td>
          <td class="paramtype">std::ifstream &amp;&nbsp;</td>
          <td class="paramname"> <em>in</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Reads Pixmap from filestream. On error an exception is thrown. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>read </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>filestream to read data from </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <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>&nbsp;</td><td></td></tr>
    <tr><td valign="top"></td><td valign="top"><em>bad_alloc</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

<p>Implements <a class="el" href="classCBitmap.html#beaf444a418973a1bf8373f236d54421">CBitmap</a>.</p>

</div>
</div><p>
<a class="anchor" name="507d5a88f8af0e41e418108e01572f13"></a><!-- doxytag: member="CPixmap::write" ref="507d5a88f8af0e41e418108e01572f13" args="(std::ofstream &amp;out)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPixmap::write           </td>
          <td>(</td>
          <td class="paramtype">std::ofstream &amp;&nbsp;</td>
          <td class="paramname"> <em>out</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Writes Pixmap to filestream. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>write </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>out</em>&nbsp;</td><td>filestream to read data from </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>FileError</em>&nbsp;</td><td></td></tr>
    <tr><td valign="top"></td><td valign="top"><em>bad_alloc</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

<p>Implements <a class="el" href="classCBitmap.html#bfa214932af1cc21817dde3dbe3c61c6">CBitmap</a>.</p>

</div>
</div><p>
<a class="anchor" name="740486bba3c8ea24f306a7b8248652e2"></a><!-- doxytag: member="CPixmap::getPixelDataSize" ref="740486bba3c8ea24f306a7b8248652e2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t CPixmap::getPixelDataSize           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return size of pixelbuffer. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getPixelDataSize </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>size of pixelbuffer </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

<p>Implements <a class="el" href="classCBitmap.html#7ea12e77a86c283ce173785c64384c33">CBitmap</a>.</p>

</div>
</div><p>
<a class="anchor" name="3f50d434556073a883bb5a2650cf2f71"></a><!-- doxytag: member="CPixmap::getHeight" ref="3f50d434556073a883bb5a2650cf2f71" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t CPixmap::getHeight           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return height of bitmap in pixel. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getHeight </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>height of bitmap in pixel </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

<p>Implements <a class="el" href="classCBitmap.html#a69618d5309e1f51741a8be98ce44c02">CBitmap</a>.</p>

</div>
</div><p>
<a class="anchor" name="f3419c1f68c7aa2c69d1e83b2ee6be8c"></a><!-- doxytag: member="CPixmap::getWidth" ref="f3419c1f68c7aa2c69d1e83b2ee6be8c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t CPixmap::getWidth           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return width of bitmap in pixel. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getWidth </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>width of bitmap in pixel </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

<p>Implements <a class="el" href="classCBitmap.html#82ffb686b4d4c7465c5239a984bf6fe4">CBitmap</a>.</p>

</div>
</div><p>
<a class="anchor" name="fc2876d5d93122f22eb1759381030980"></a><!-- doxytag: member="CPixmap::hasColorTable" ref="fc2876d5d93122f22eb1759381030980" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bool CPixmap::hasColorTable           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if bitmap has a colortable (we don't support this yet for windows bitmaps). 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>hasColorTable </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if bitmap has a colortable. false otherwise </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

<p>Implements <a class="el" href="classCBitmap.html#9b38397779b83cbc0a71e40cc3995025">CBitmap</a>.</p>

</div>
</div><p>
<a class="anchor" name="0cbf88af3060d338b1d288cb930c8b49"></a><!-- doxytag: member="CPixmap::isMirrored" ref="0cbf88af3060d338b1d288cb930c8b49" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bool CPixmap::isMirrored           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Windows Bitmaps can be stored upside down. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>isMirrored </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if bitmap is stored upside down. false otherwise </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

<p>Implements <a class="el" href="classCBitmap.html#cd6bfd1ffca5f3c6d0faa29275733bad">CBitmap</a>.</p>

</div>
</div><p>
<a class="anchor" name="0d93bfe35b557f3827f90aa81685aff4"></a><!-- doxytag: member="CPixmap::getLine" ref="0d93bfe35b557f3827f90aa81685aff4" args="(std::ifstream &amp;in, bool ignore_comments=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string CPixmap::getLine           </td>
          <td>(</td>
          <td class="paramtype">std::ifstream &amp;&nbsp;</td>
          <td class="paramname"> <em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>ignore_comments</em> = <code>true</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
read trimmed line (terminated by <br>
) from filestream 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getLine </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>filestream to read data from </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ignore_comments</em>&nbsp;</td><td>true: ignore c-like comments </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>return trimmed line from filestream </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<a class="anchor" name="4fea1d2e3e528e660f48f37fa91aedae"></a><!-- doxytag: member="CPixmap::getCArrayLine" ref="4fea1d2e3e528e660f48f37fa91aedae" args="(std::ifstream &amp;in)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string CPixmap::getCArrayLine           </td>
          <td>(</td>
          <td class="paramtype">std::ifstream &amp;&nbsp;</td>
          <td class="paramname"> <em>in</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
read trimmed c-arrayline from filestream 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getArrayLine </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>filestream to read data from </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>return trimmed c-arrayline from filestream </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>FileError</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<a class="anchor" name="51b3aeac4afa31c11188cf844a40f0fc"></a><!-- doxytag: member="CPixmap::getXPMColorID" ref="51b3aeac4afa31c11188cf844a40f0fc" args="(unsigned int index, unsigned int length)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string CPixmap::getXPMColorID           </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>index</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>length</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get xpm color identifier, generated using an index 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getXPMColorID </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>index used to generate the xpm color identifier </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>length of xpm color identifier </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>return xpm color identifier, generated using index </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>FileError</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="5ca3e44f4f5a3d7a94d0f7a83d30eb2b"></a><!-- doxytag: member="CPixmap::m_fileheader" ref="5ca3e44f4f5a3d7a94d0f7a83d30eb2b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
fileheader 
</div>
</div><p>
<a class="anchor" name="ac8ee30e3375e15684c1263d7c9b8dd4"></a><!-- doxytag: member="CPixmap::m_imagename" ref="ac8ee30e3375e15684c1263d7c9b8dd4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string <a class="el" href="classCPixmap.html#ac8ee30e3375e15684c1263d7c9b8dd4">CPixmap::m_imagename</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
name of image/c-array 
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>imgsynth2/<a class="el" href="cpixmap_8h-source.html">cpixmap.h</a><li>imgsynth2/cpixmap.cpp</ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun May 3 19:16:26 2009 for imgsynth2 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>