ue2/doxygen/classCPixelFormat.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

<!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: CPixelFormat 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>CPixelFormat Class Reference</h1><!-- doxytag: class="CPixelFormat" -->Abstract class for handling different color bitcount of Bitmaps.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="cpixelformat_8h-source.html">cpixelformat.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for CPixelFormat:</div>
<div class="dynsection">

<p><center><img src="classCPixelFormat.png" usemap="#CPixelFormat_map" border="0" alt=""></center>
<map name="CPixelFormat_map">
<area href="classCPixelFormat__BGR24.html" alt="CPixelFormat_BGR24" shape="rect" coords="0,56,145,80">
<area href="classCPixelFormat__BGR555.html" alt="CPixelFormat_BGR555" shape="rect" coords="155,56,300,80">
<area href="classCPixelFormat__Indexed8.html" alt="CPixelFormat_Indexed8" shape="rect" coords="310,56,455,80">
</map>
</div>

<p>
<a href="classCPixelFormat-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="classCPixelFormat.html#6216335559cf002f1e870b420b15913e">CPixelFormat</a> (<a class="el" href="classCBitmap.html">CBitmap</a> *bitmap)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctor.  <a href="#6216335559cf002f1e870b420b15913e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat.html#363edc98e8a6460466d52590679f1853">~CPixelFormat</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor (virtual).  <a href="#363edc98e8a6460466d52590679f1853"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat.html#5305559ecc7bd185d149493947ac45e7">getPixel</a> (<a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;pixel, const uint32_t x, const uint32_t y)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get pixel at coordinates x, y.  <a href="#5305559ecc7bd185d149493947ac45e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat.html#6e6b0e48e8d6cd5e5b0fb7399307aa48">setPixel</a> (const <a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;pixel, const uint32_t x, const uint32_t y)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modifies pixel at coordinates x, y.  <a href="#6e6b0e48e8d6cd5e5b0fb7399307aa48"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat.html#bfe1496b57a8a62be38de66ae6cfe3a7">getBitCount</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns color bitcount supported by this class  <a href="#bfe1496b57a8a62be38de66ae6cfe3a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat.html#bacedecc124fa734273948989cb4e31e">getMaxColor</a> (<a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;pixel)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get maximum values for RGB pixel.  <a href="#bacedecc124fa734273948989cb4e31e"></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="classCBitmap.html">CBitmap</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat.html#0c0ab3e11535c9cda07d049cc6bd6f9a">m_bitmap</a></td></tr>

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

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Exception thrown by implemententations of <a class="el" href="classCPixelFormat.html" title="Abstract class for handling different color bitcount of Bitmaps.">CPixelFormat</a>.  <a href="classCPixelFormat_1_1PixelFormatError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RGB Pixel structure.  <a href="structCPixelFormat_1_1RGBPIXEL.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract class for handling different color bitcount of Bitmaps. 
<p>
Needed for generic use in <a class="el" href="classCBitmap.html" title="Abstract implementation of CFile handling Bitmaps.">CBitmap</a>.<p>
On error throw <a class="el" href="classCPixelFormat_1_1PixelFormatError.html" title="Exception thrown by implemententations of CPixelFormat.">PixelFormatError</a>. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="6216335559cf002f1e870b420b15913e"></a><!-- doxytag: member="CPixelFormat::CPixelFormat" ref="6216335559cf002f1e870b420b15913e" args="(CBitmap *bitmap)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CPixelFormat::CPixelFormat           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCBitmap.html">CBitmap</a> *&nbsp;</td>
          <td class="paramname"> <em>bitmap</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></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="classCPixelFormat.html" title="Abstract class for handling different color bitcount of Bitmaps.">CPixelFormat</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>bitmap</em>&nbsp;</td><td>pointer to <a class="el" href="classCBitmap.html" title="Abstract implementation of CFile handling Bitmaps.">CBitmap</a> instance </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="363edc98e8a6460466d52590679f1853"></a><!-- doxytag: member="CPixelFormat::~CPixelFormat" ref="363edc98e8a6460466d52590679f1853" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CPixelFormat::~CPixelFormat           </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>
Default dtor (virtual). 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CPixelFormat </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="5305559ecc7bd185d149493947ac45e7"></a><!-- doxytag: member="CPixelFormat::getPixel" ref="5305559ecc7bd185d149493947ac45e7" args="(RGBPIXEL &amp;pixel, const uint32_t x, const uint32_t y)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CPixelFormat::getPixel           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>pixel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint32_t&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint32_t&nbsp;</td>
          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get pixel at coordinates x, y. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getPixel </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>pixel</em>&nbsp;</td><td>reference to pixel data </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>x-coordinate </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>y-coordinate </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="classCPixelFormat_1_1PixelFormatError.html" title="Exception thrown by implemententations of CPixelFormat.">PixelFormatError</a></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="6e6b0e48e8d6cd5e5b0fb7399307aa48"></a><!-- doxytag: member="CPixelFormat::setPixel" ref="6e6b0e48e8d6cd5e5b0fb7399307aa48" args="(const RGBPIXEL &amp;pixel, const uint32_t x, const uint32_t y)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CPixelFormat::setPixel           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>pixel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint32_t&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint32_t&nbsp;</td>
          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Modifies pixel at coordinates x, y. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>setPixel </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>pixel</em>&nbsp;</td><td>reference to new pixel data </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>x-coordinate </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>y-coordinate </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="classCPixelFormat_1_1PixelFormatError.html" title="Exception thrown by implemententations of CPixelFormat.">PixelFormatError</a></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="bfe1496b57a8a62be38de66ae6cfe3a7"></a><!-- doxytag: member="CPixelFormat::getBitCount" ref="bfe1496b57a8a62be38de66ae6cfe3a7" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual uint32_t CPixelFormat::getBitCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
returns color bitcount supported by this class 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getBitCount </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>color bitcount supported by this class </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>Implemented in <a class="el" href="classCPixelFormat__BGR24.html#cf1c81e62b3cd809c7be4cc7c90acc02">CPixelFormat_BGR24</a>, <a class="el" href="classCPixelFormat__BGR555.html#5b9994732731fa813b055df01cb2dd05">CPixelFormat_BGR555</a>, and <a class="el" href="classCPixelFormat__Indexed8.html#677d751409dc57344b0ca5f6787ead0c">CPixelFormat_Indexed8</a>.</p>

</div>
</div><p>
<a class="anchor" name="bacedecc124fa734273948989cb4e31e"></a><!-- doxytag: member="CPixelFormat::getMaxColor" ref="bacedecc124fa734273948989cb4e31e" args="(RGBPIXEL &amp;pixel)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CPixelFormat::getMaxColor           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>pixel</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get maximum values for RGB pixel. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getMaxColor </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>pixel</em>&nbsp;</td><td>reference to pixel struct </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 Data Documentation</h2>
<a class="anchor" name="0c0ab3e11535c9cda07d049cc6bd6f9a"></a><!-- doxytag: member="CPixelFormat::m_bitmap" ref="0c0ab3e11535c9cda07d049cc6bd6f9a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCBitmap.html">CBitmap</a>* <a class="el" href="classCPixelFormat.html#0c0ab3e11535c9cda07d049cc6bd6f9a">CPixelFormat::m_bitmap</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
pointer to <a class="el" href="classCBitmap.html" title="Abstract implementation of CFile handling Bitmaps.">CBitmap</a> instance 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>imgsynth2/<a class="el" href="cpixelformat_8h-source.html">cpixelformat.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 18:58:11 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>