summaryrefslogtreecommitdiffstats
path: root/ue2/doxygen/classCPixelFormat__Indexed8.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__Indexed8.html
parentbc94c4be2e7e37f1f3e8892dc115e61ed6b640e7 (diff)
downloadooprog-93a6590af7f866838d883d92fac655251685c3d7.tar.gz
ooprog-93a6590af7f866838d883d92fac655251685c3d7.tar.bz2
ooprog-93a6590af7f866838d883d92fac655251685c3d7.zip
adding doxygen files
Diffstat (limited to 'ue2/doxygen/classCPixelFormat__Indexed8.html')
-rw-r--r--ue2/doxygen/classCPixelFormat__Indexed8.html326
1 files changed, 326 insertions, 0 deletions
diff --git a/ue2/doxygen/classCPixelFormat__Indexed8.html b/ue2/doxygen/classCPixelFormat__Indexed8.html
new file mode 100644
index 0000000..2cdeb02
--- /dev/null
+++ b/ue2/doxygen/classCPixelFormat__Indexed8.html
@@ -0,0 +1,326 @@
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_Indexed8 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_Indexed8 Class Reference</h1><!-- doxytag: class="CPixelFormat_Indexed8" --><!-- doxytag: inherits="CPixelFormat" -->Implementation of <a class="el" href="classCPixelFormat.html" title="Abstract class for handling different color bitcount of Bitmaps.">CPixelFormat</a> handling 24bit indexed bitmaps.
24<a href="#_details">More...</a>
25<p>
26<code>#include &lt;<a class="el" href="cpixelformat__indexed8_8h-source.html">cpixelformat_indexed8.h</a>&gt;</code>
27<p>
28<div class="dynheader">
29Inheritance diagram for CPixelFormat_Indexed8:</div>
30<div class="dynsection">
31
32<p><center><img src="classCPixelFormat__Indexed8.png" usemap="#CPixelFormat_Indexed8_map" border="0" alt=""></center>
33<map name="CPixelFormat_Indexed8_map">
34<area href="classCPixelFormat.html" alt="CPixelFormat" shape="rect" coords="0,0,145,24">
35</map>
36</div>
37
38<p>
39<a href="classCPixelFormat__Indexed8-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
40<tr><td></td></tr>
41<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat__Indexed8.html#bbc3a8d9c76664f87d2eda110880bfb5">CPixelFormat_Indexed8</a> (<a class="el" href="classCBitmap.html">CBitmap</a> *bitmap)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctor. <a href="#bbc3a8d9c76664f87d2eda110880bfb5"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat__Indexed8.html#781e9e7d62c23dd491b8288b1a26b393">~CPixelFormat_Indexed8</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor. <a href="#781e9e7d62c23dd491b8288b1a26b393"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat__Indexed8.html#d77b6e03ca34e354e1abf81ae8646eea">getPixel</a> (RGBPIXEL &amp;pixel, uint32_t x, uint32_t y)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get pixel at coordinates x, y. <a href="#d77b6e03ca34e354e1abf81ae8646eea"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat__Indexed8.html#6b2792a98b8f06f0ed014054b9218fdf">setPixel</a> (const RGBPIXEL &amp;pixel, uint32_t x, uint32_t y)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modifies pixel at coordinates x, y. <a href="#6b2792a98b8f06f0ed014054b9218fdf"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat__Indexed8.html#677d751409dc57344b0ca5f6787ead0c">getBitCount</a> ()</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the bitcount needed for indexing the color tabel. <a href="#677d751409dc57344b0ca5f6787ead0c"></a><br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat__Indexed8.html#d56bbec5d00cbd3c60f21fecc6ebc1a4">getMaxColor</a> (RGBPIXEL &amp;pixel)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get maximum values for RGB pixel. <a href="#d56bbec5d00cbd3c60f21fecc6ebc1a4"></a><br></td></tr>
60</table>
61<hr><a name="_details"></a><h2>Detailed Description</h2>
62Implementation of <a class="el" href="classCPixelFormat.html" title="Abstract class for handling different color bitcount of Bitmaps.">CPixelFormat</a> handling 24bit indexed bitmaps.
63<p>
64<dl class="user" compact><dt><b>Modulname:</b></dt><dd>cpixelformat_bgr24 </dd></dl>
65<dl class="author" compact><dt><b>Author:</b></dt><dd>Guenther Neuwirth (0626638), Manuel Mausz (0728348) </dd></dl>
66<dl class="date" compact><dt><b>Date:</b></dt><dd>02.05.2009</dd></dl>
67Implementation of <a class="el" href="classCPixelFormat.html" title="Abstract class for handling different color bitcount of Bitmaps.">CPixelFormat</a> handling 24bit indexed bitmaps.<p>
68On error <a class="el" href="classCPixelFormat_1_1PixelFormatError.html" title="Exception thrown by implemententations of CPixelFormat.">CPixelFormat::PixelFormatError</a> is thrown. <hr><h2>Constructor &amp; Destructor Documentation</h2>
69<a class="anchor" name="bbc3a8d9c76664f87d2eda110880bfb5"></a><!-- doxytag: member="CPixelFormat_Indexed8::CPixelFormat_Indexed8" ref="bbc3a8d9c76664f87d2eda110880bfb5" args="(CBitmap *bitmap)" -->
70<div class="memitem">
71<div class="memproto">
72 <table class="memname">
73 <tr>
74 <td class="memname">CPixelFormat_Indexed8::CPixelFormat_Indexed8 </td>
75 <td>(</td>
76 <td class="paramtype"><a class="el" href="classCBitmap.html">CBitmap</a> *&nbsp;</td>
77 <td class="paramname"> <em>bitmap</em> </td>
78 <td>&nbsp;)&nbsp;</td>
79 <td width="100%"><code> [inline]</code></td>
80 </tr>
81 </table>
82</div>
83<div class="memdoc">
84
85<p>
86Default ctor.
87<p>
88<dl class="user" compact><dt><b>Methodname:</b></dt><dd><a class="el" href="classCPixelFormat__Indexed8.html" title="Implementation of CPixelFormat handling 24bit indexed bitmaps.">CPixelFormat_Indexed8</a> </dd></dl>
89<dl compact><dt><b>Parameters:</b></dt><dd>
90 <table border="0" cellspacing="2" cellpadding="0">
91 <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>
92 </table>
93</dl>
94<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
95<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
96<dl compact><dt><b>Exceptions:</b></dt><dd>
97 <table border="0" cellspacing="2" cellpadding="0">
98 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
99 </table>
100</dl>
101<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
102
103</div>
104</div><p>
105<a class="anchor" name="781e9e7d62c23dd491b8288b1a26b393"></a><!-- doxytag: member="CPixelFormat_Indexed8::~CPixelFormat_Indexed8" ref="781e9e7d62c23dd491b8288b1a26b393" args="()" -->
106<div class="memitem">
107<div class="memproto">
108 <table class="memname">
109 <tr>
110 <td class="memname">CPixelFormat_Indexed8::~CPixelFormat_Indexed8 </td>
111 <td>(</td>
112 <td class="paramname"> </td>
113 <td>&nbsp;)&nbsp;</td>
114 <td width="100%"><code> [inline]</code></td>
115 </tr>
116 </table>
117</div>
118<div class="memdoc">
119
120<p>
121Default dtor.
122<p>
123<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CPixelFormat_Indexed8 </dd></dl>
124<dl compact><dt><b>Parameters:</b></dt><dd>
125 <table border="0" cellspacing="2" cellpadding="0">
126 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
127 </table>
128</dl>
129<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
130<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
131<dl compact><dt><b>Exceptions:</b></dt><dd>
132 <table border="0" cellspacing="2" cellpadding="0">
133 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
134 </table>
135</dl>
136<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
137
138</div>
139</div><p>
140<hr><h2>Member Function Documentation</h2>
141<a class="anchor" name="d77b6e03ca34e354e1abf81ae8646eea"></a><!-- doxytag: member="CPixelFormat_Indexed8::getPixel" ref="d77b6e03ca34e354e1abf81ae8646eea" args="(RGBPIXEL &amp;pixel, uint32_t x, uint32_t y)" -->
142<div class="memitem">
143<div class="memproto">
144 <table class="memname">
145 <tr>
146 <td class="memname">void CPixelFormat_Indexed8::getPixel </td>
147 <td>(</td>
148 <td class="paramtype">RGBPIXEL &amp;&nbsp;</td>
149 <td class="paramname"> <em>pixel</em>, </td>
150 </tr>
151 <tr>
152 <td class="paramkey"></td>
153 <td></td>
154 <td class="paramtype">uint32_t&nbsp;</td>
155 <td class="paramname"> <em>x</em>, </td>
156 </tr>
157 <tr>
158 <td class="paramkey"></td>
159 <td></td>
160 <td class="paramtype">uint32_t&nbsp;</td>
161 <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
162 </tr>
163 <tr>
164 <td></td>
165 <td>)</td>
166 <td></td><td></td><td width="100%"></td>
167 </tr>
168 </table>
169</div>
170<div class="memdoc">
171
172<p>
173Get pixel at coordinates x, y.
174<p>
175<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getPixel </dd></dl>
176<dl compact><dt><b>Parameters:</b></dt><dd>
177 <table border="0" cellspacing="2" cellpadding="0">
178 <tr><td valign="top"></td><td valign="top"><em>pixel</em>&nbsp;</td><td>reference to pixel data </td></tr>
179 <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>x-coordinate </td></tr>
180 <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>y-coordinate </td></tr>
181 </table>
182</dl>
183<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
184<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
185<dl compact><dt><b>Exceptions:</b></dt><dd>
186 <table border="0" cellspacing="2" cellpadding="0">
187 <tr><td valign="top"></td><td valign="top"><em>PixelFormatError</em>&nbsp;</td><td></td></tr>
188 </table>
189</dl>
190<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
191
192</div>
193</div><p>
194<a class="anchor" name="6b2792a98b8f06f0ed014054b9218fdf"></a><!-- doxytag: member="CPixelFormat_Indexed8::setPixel" ref="6b2792a98b8f06f0ed014054b9218fdf" args="(const RGBPIXEL &amp;pixel, uint32_t x, uint32_t y)" -->
195<div class="memitem">
196<div class="memproto">
197 <table class="memname">
198 <tr>
199 <td class="memname">void CPixelFormat_Indexed8::setPixel </td>
200 <td>(</td>
201 <td class="paramtype">const RGBPIXEL &amp;&nbsp;</td>
202 <td class="paramname"> <em>pixel</em>, </td>
203 </tr>
204 <tr>
205 <td class="paramkey"></td>
206 <td></td>
207 <td class="paramtype">uint32_t&nbsp;</td>
208 <td class="paramname"> <em>x</em>, </td>
209 </tr>
210 <tr>
211 <td class="paramkey"></td>
212 <td></td>
213 <td class="paramtype">uint32_t&nbsp;</td>
214 <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
215 </tr>
216 <tr>
217 <td></td>
218 <td>)</td>
219 <td></td><td></td><td width="100%"></td>
220 </tr>
221 </table>
222</div>
223<div class="memdoc">
224
225<p>
226Modifies pixel at coordinates x, y.
227<p>
228<dl class="user" compact><dt><b>Methodname:</b></dt><dd>setPixel </dd></dl>
229<dl compact><dt><b>Parameters:</b></dt><dd>
230 <table border="0" cellspacing="2" cellpadding="0">
231 <tr><td valign="top"></td><td valign="top"><em>pixel</em>&nbsp;</td><td>reference to new pixel data </td></tr>
232 <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>x-coordinate </td></tr>
233 <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>y-coordinate </td></tr>
234 </table>
235</dl>
236<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
237<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
238<dl compact><dt><b>Exceptions:</b></dt><dd>
239 <table border="0" cellspacing="2" cellpadding="0">
240 <tr><td valign="top"></td><td valign="top"><em>PixelFormatError</em>&nbsp;</td><td></td></tr>
241 </table>
242</dl>
243<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
244
245</div>
246</div><p>
247<a class="anchor" name="677d751409dc57344b0ca5f6787ead0c"></a><!-- doxytag: member="CPixelFormat_Indexed8::getBitCount" ref="677d751409dc57344b0ca5f6787ead0c" args="()" -->
248<div class="memitem">
249<div class="memproto">
250 <table class="memname">
251 <tr>
252 <td class="memname">uint32_t CPixelFormat_Indexed8::getBitCount </td>
253 <td>(</td>
254 <td class="paramname"> </td>
255 <td>&nbsp;)&nbsp;</td>
256 <td width="100%"><code> [inline, virtual]</code></td>
257 </tr>
258 </table>
259</div>
260<div class="memdoc">
261
262<p>
263returns the bitcount needed for indexing the color tabel.
264<p>
265<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getBitCount </dd></dl>
266<dl compact><dt><b>Parameters:</b></dt><dd>
267 <table border="0" cellspacing="2" cellpadding="0">
268 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
269 </table>
270</dl>
271<dl class="return" compact><dt><b>Returns:</b></dt><dd>bitcount of indexes supported by this class </dd></dl>
272<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
273<dl compact><dt><b>Exceptions:</b></dt><dd>
274 <table border="0" cellspacing="2" cellpadding="0">
275 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
276 </table>
277</dl>
278<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
279
280<p>Implements <a class="el" href="classCPixelFormat.html#bfe1496b57a8a62be38de66ae6cfe3a7">CPixelFormat</a>.</p>
281
282</div>
283</div><p>
284<a class="anchor" name="d56bbec5d00cbd3c60f21fecc6ebc1a4"></a><!-- doxytag: member="CPixelFormat_Indexed8::getMaxColor" ref="d56bbec5d00cbd3c60f21fecc6ebc1a4" args="(RGBPIXEL &amp;pixel)" -->
285<div class="memitem">
286<div class="memproto">
287 <table class="memname">
288 <tr>
289 <td class="memname">void CPixelFormat_Indexed8::getMaxColor </td>
290 <td>(</td>
291 <td class="paramtype">RGBPIXEL &amp;&nbsp;</td>
292 <td class="paramname"> <em>pixel</em> </td>
293 <td>&nbsp;)&nbsp;</td>
294 <td width="100%"><code> [inline]</code></td>
295 </tr>
296 </table>
297</div>
298<div class="memdoc">
299
300<p>
301Get maximum values for RGB pixel.
302<p>
303<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getMaxColor </dd></dl>
304<dl compact><dt><b>Parameters:</b></dt><dd>
305 <table border="0" cellspacing="2" cellpadding="0">
306 <tr><td valign="top"></td><td valign="top"><em>pixel</em>&nbsp;</td><td>reference to pixel struct </td></tr>
307 </table>
308</dl>
309<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
310<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
311<dl compact><dt><b>Exceptions:</b></dt><dd>
312 <table border="0" cellspacing="2" cellpadding="0">
313 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
314 </table>
315</dl>
316<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
317
318</div>
319</div><p>
320<hr>The documentation for this class was generated from the following files:<ul>
321<li>imgsynth2/<a class="el" href="cpixelformat__indexed8_8h-source.html">cpixelformat_indexed8.h</a><li>imgsynth2/cpixelformat_indexed8.cpp</ul>
322<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 18:58:11 2009 for imgsynth2 by&nbsp;
323<a href="http://www.doxygen.org/index.html">
324<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
325</body>
326</html>