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