summaryrefslogtreecommitdiffstats
path: root/ue2/doxygen/classCPixelFormat.html
diff options
context:
space:
mode:
authormanuel <manuel@nc8430.lan>2009-05-02 18:58:26 +0200
committermanuel <manuel@nc8430.lan>2009-05-02 18:58:26 +0200
commit93a6590af7f866838d883d92fac655251685c3d7 (patch)
tree57401b84345a4a36cee8cca2731fe567577f29e2 /ue2/doxygen/classCPixelFormat.html
parentbc94c4be2e7e37f1f3e8892dc115e61ed6b640e7 (diff)
downloadooprog-93a6590af7f866838d883d92fac655251685c3d7.tar.gz
ooprog-93a6590af7f866838d883d92fac655251685c3d7.tar.bz2
ooprog-93a6590af7f866838d883d92fac655251685c3d7.zip
adding doxygen files
Diffstat (limited to 'ue2/doxygen/classCPixelFormat.html')
-rw-r--r--ue2/doxygen/classCPixelFormat.html351
1 files changed, 351 insertions, 0 deletions
diff --git a/ue2/doxygen/classCPixelFormat.html b/ue2/doxygen/classCPixelFormat.html
new file mode 100644
index 0000000..45b9136
--- /dev/null
+++ b/ue2/doxygen/classCPixelFormat.html
@@ -0,0 +1,351 @@
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: CPixelFormat 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&nbsp;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&nbsp;List</span></a></li>
19 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
20 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
21 </ul>
22</div>
23<h1>CPixelFormat Class Reference</h1><!-- doxytag: class="CPixelFormat" -->Abstract class for handling different color bitcount of Bitmaps.
24<a href="#_details">More...</a>
25<p>
26<code>#include &lt;<a class="el" href="cpixelformat_8h-source.html">cpixelformat.h</a>&gt;</code>
27<p>
28<div class="dynheader">
29Inheritance diagram for CPixelFormat:</div>
30<div class="dynsection">
31
32<p><center><img src="classCPixelFormat.png" usemap="#CPixelFormat_map" border="0" alt=""></center>
33<map name="CPixelFormat_map">
34<area href="classCPixelFormat__BGR24.html" alt="CPixelFormat_BGR24" shape="rect" coords="0,56,145,80">
35<area href="classCPixelFormat__BGR555.html" alt="CPixelFormat_BGR555" shape="rect" coords="155,56,300,80">
36<area href="classCPixelFormat__Indexed8.html" alt="CPixelFormat_Indexed8" shape="rect" coords="310,56,455,80">
37</map>
38</div>
39
40<p>
41<a href="classCPixelFormat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
42<tr><td></td></tr>
43<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
44<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>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctor. <a href="#6216335559cf002f1e870b420b15913e"></a><br></td></tr>
47<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>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor (virtual). <a href="#363edc98e8a6460466d52590679f1853"></a><br></td></tr>
50<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>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get pixel at coordinates x, y. <a href="#5305559ecc7bd185d149493947ac45e7"></a><br></td></tr>
53<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>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modifies pixel at coordinates x, y. <a href="#6e6b0e48e8d6cd5e5b0fb7399307aa48"></a><br></td></tr>
56<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>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns color bitcount supported by this class <a href="#bfe1496b57a8a62be38de66ae6cfe3a7"></a><br></td></tr>
59<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>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get maximum values for RGB pixel. <a href="#bacedecc124fa734273948989cb4e31e"></a><br></td></tr>
62<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
63<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>
64
65<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
66<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>
67
68<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>
69<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>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RGB Pixel structure. <a href="structCPixelFormat_1_1RGBPIXEL.html#_details">More...</a><br></td></tr>
72</table>
73<hr><a name="_details"></a><h2>Detailed Description</h2>
74Abstract class for handling different color bitcount of Bitmaps.
75<p>
76Needed for generic use in <a class="el" href="classCBitmap.html" title="Abstract implementation of CFile handling Bitmaps.">CBitmap</a>.<p>
77On 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>
78<a class="anchor" name="6216335559cf002f1e870b420b15913e"></a><!-- doxytag: member="CPixelFormat::CPixelFormat" ref="6216335559cf002f1e870b420b15913e" args="(CBitmap *bitmap)" -->
79<div class="memitem">
80<div class="memproto">
81 <table class="memname">
82 <tr>
83 <td class="memname">CPixelFormat::CPixelFormat </td>
84 <td>(</td>
85 <td class="paramtype"><a class="el" href="classCBitmap.html">CBitmap</a> *&nbsp;</td>
86 <td class="paramname"> <em>bitmap</em> </td>
87 <td>&nbsp;)&nbsp;</td>
88 <td width="100%"><code> [inline]</code></td>
89 </tr>
90 </table>
91</div>
92<div class="memdoc">
93
94<p>
95Default ctor.
96<p>
97<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>
98<dl compact><dt><b>Parameters:</b></dt><dd>
99 <table border="0" cellspacing="2" cellpadding="0">
100 <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>
101 </table>
102</dl>
103<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
104<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
105<dl compact><dt><b>Exceptions:</b></dt><dd>
106 <table border="0" cellspacing="2" cellpadding="0">
107 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
108 </table>
109</dl>
110<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
111
112</div>
113</div><p>
114<a class="anchor" name="363edc98e8a6460466d52590679f1853"></a><!-- doxytag: member="CPixelFormat::~CPixelFormat" ref="363edc98e8a6460466d52590679f1853" args="()" -->
115<div class="memitem">
116<div class="memproto">
117 <table class="memname">
118 <tr>
119 <td class="memname">virtual CPixelFormat::~CPixelFormat </td>
120 <td>(</td>
121 <td class="paramname"> </td>
122 <td>&nbsp;)&nbsp;</td>
123 <td width="100%"><code> [inline, virtual]</code></td>
124 </tr>
125 </table>
126</div>
127<div class="memdoc">
128
129<p>
130Default dtor (virtual).
131<p>
132<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CPixelFormat </dd></dl>
133<dl compact><dt><b>Parameters:</b></dt><dd>
134 <table border="0" cellspacing="2" cellpadding="0">
135 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
136 </table>
137</dl>
138<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
139<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
140<dl compact><dt><b>Exceptions:</b></dt><dd>
141 <table border="0" cellspacing="2" cellpadding="0">
142 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
143 </table>
144</dl>
145<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
146
147</div>
148</div><p>
149<hr><h2>Member Function Documentation</h2>
150<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" -->
151<div class="memitem">
152<div class="memproto">
153 <table class="memname">
154 <tr>
155 <td class="memname">virtual void CPixelFormat::getPixel </td>
156 <td>(</td>
157 <td class="paramtype"><a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;&nbsp;</td>
158 <td class="paramname"> <em>pixel</em>, </td>
159 </tr>
160 <tr>
161 <td class="paramkey"></td>
162 <td></td>
163 <td class="paramtype">const uint32_t&nbsp;</td>
164 <td class="paramname"> <em>x</em>, </td>
165 </tr>
166 <tr>
167 <td class="paramkey"></td>
168 <td></td>
169 <td class="paramtype">const uint32_t&nbsp;</td>
170 <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
171 </tr>
172 <tr>
173 <td></td>
174 <td>)</td>
175 <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
176 </tr>
177 </table>
178</div>
179<div class="memdoc">
180
181<p>
182Get pixel at coordinates x, y.
183<p>
184<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getPixel </dd></dl>
185<dl compact><dt><b>Parameters:</b></dt><dd>
186 <table border="0" cellspacing="2" cellpadding="0">
187 <tr><td valign="top"></td><td valign="top"><em>pixel</em>&nbsp;</td><td>reference to pixel data </td></tr>
188 <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>x-coordinate </td></tr>
189 <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>y-coordinate </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="classCPixelFormat_1_1PixelFormatError.html" title="Exception thrown by implemententations of CPixelFormat.">PixelFormatError</a></em>&nbsp;</td><td></td></tr>
197 </table>
198</dl>
199<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
200
201</div>
202</div><p>
203<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" -->
204<div class="memitem">
205<div class="memproto">
206 <table class="memname">
207 <tr>
208 <td class="memname">virtual void CPixelFormat::setPixel </td>
209 <td>(</td>
210 <td class="paramtype">const <a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;&nbsp;</td>
211 <td class="paramname"> <em>pixel</em>, </td>
212 </tr>
213 <tr>
214 <td class="paramkey"></td>
215 <td></td>
216 <td class="paramtype">const uint32_t&nbsp;</td>
217 <td class="paramname"> <em>x</em>, </td>
218 </tr>
219 <tr>
220 <td class="paramkey"></td>
221 <td></td>
222 <td class="paramtype">const uint32_t&nbsp;</td>
223 <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
224 </tr>
225 <tr>
226 <td></td>
227 <td>)</td>
228 <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
229 </tr>
230 </table>
231</div>
232<div class="memdoc">
233
234<p>
235Modifies pixel at coordinates x, y.
236<p>
237<dl class="user" compact><dt><b>Methodname:</b></dt><dd>setPixel </dd></dl>
238<dl compact><dt><b>Parameters:</b></dt><dd>
239 <table border="0" cellspacing="2" cellpadding="0">
240 <tr><td valign="top"></td><td valign="top"><em>pixel</em>&nbsp;</td><td>reference to new pixel data </td></tr>
241 <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>x-coordinate </td></tr>
242 <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>y-coordinate </td></tr>
243 </table>
244</dl>
245<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
246<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
247<dl compact><dt><b>Exceptions:</b></dt><dd>
248 <table border="0" cellspacing="2" cellpadding="0">
249 <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>
250 </table>
251</dl>
252<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
253
254</div>
255</div><p>
256<a class="anchor" name="bfe1496b57a8a62be38de66ae6cfe3a7"></a><!-- doxytag: member="CPixelFormat::getBitCount" ref="bfe1496b57a8a62be38de66ae6cfe3a7" args="()=0" -->
257<div class="memitem">
258<div class="memproto">
259 <table class="memname">
260 <tr>
261 <td class="memname">virtual uint32_t CPixelFormat::getBitCount </td>
262 <td>(</td>
263 <td class="paramname"> </td>
264 <td>&nbsp;)&nbsp;</td>
265 <td width="100%"><code> [pure virtual]</code></td>
266 </tr>
267 </table>
268</div>
269<div class="memdoc">
270
271<p>
272returns color bitcount supported by this class
273<p>
274<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getBitCount </dd></dl>
275<dl compact><dt><b>Parameters:</b></dt><dd>
276 <table border="0" cellspacing="2" cellpadding="0">
277 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
278 </table>
279</dl>
280<dl class="return" compact><dt><b>Returns:</b></dt><dd>color bitcount supported by this class </dd></dl>
281<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
282<dl compact><dt><b>Exceptions:</b></dt><dd>
283 <table border="0" cellspacing="2" cellpadding="0">
284 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
285 </table>
286</dl>
287<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
288
289<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>
290
291</div>
292</div><p>
293<a class="anchor" name="bacedecc124fa734273948989cb4e31e"></a><!-- doxytag: member="CPixelFormat::getMaxColor" ref="bacedecc124fa734273948989cb4e31e" args="(RGBPIXEL &amp;pixel)=0" -->
294<div class="memitem">
295<div class="memproto">
296 <table class="memname">
297 <tr>
298 <td class="memname">virtual void CPixelFormat::getMaxColor </td>
299 <td>(</td>
300 <td class="paramtype"><a class="el" href="structCPixelFormat_1_1RGBPIXEL.html">RGBPIXEL</a> &amp;&nbsp;</td>
301 <td class="paramname"> <em>pixel</em> </td>
302 <td>&nbsp;)&nbsp;</td>
303 <td width="100%"><code> [pure virtual]</code></td>
304 </tr>
305 </table>
306</div>
307<div class="memdoc">
308
309<p>
310Get maximum values for RGB pixel.
311<p>
312<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getMaxColor </dd></dl>
313<dl compact><dt><b>Parameters:</b></dt><dd>
314 <table border="0" cellspacing="2" cellpadding="0">
315 <tr><td valign="top"></td><td valign="top"><em>pixel</em>&nbsp;</td><td>reference to pixel struct </td></tr>
316 </table>
317</dl>
318<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
319<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
320<dl compact><dt><b>Exceptions:</b></dt><dd>
321 <table border="0" cellspacing="2" cellpadding="0">
322 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
323 </table>
324</dl>
325<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
326
327</div>
328</div><p>
329<hr><h2>Member Data Documentation</h2>
330<a class="anchor" name="0c0ab3e11535c9cda07d049cc6bd6f9a"></a><!-- doxytag: member="CPixelFormat::m_bitmap" ref="0c0ab3e11535c9cda07d049cc6bd6f9a" args="" -->
331<div class="memitem">
332<div class="memproto">
333 <table class="memname">
334 <tr>
335 <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>
336 </tr>
337 </table>
338</div>
339<div class="memdoc">
340
341<p>
342pointer to <a class="el" href="classCBitmap.html" title="Abstract implementation of CFile handling Bitmaps.">CBitmap</a> instance
343</div>
344</div><p>
345<hr>The documentation for this class was generated from the following file:<ul>
346<li>imgsynth2/<a class="el" href="cpixelformat_8h-source.html">cpixelformat.h</a></ul>
347<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 18:58:11 2009 for imgsynth2 by&nbsp;
348<a href="http://www.doxygen.org/index.html">
349<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
350</body>
351</html>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-12 05:51:20 +0000