summaryrefslogtreecommitdiffstats
path: root/ue1/doxygen/classCPixelFormat.html
diff options
context:
space:
mode:
Diffstat (limited to 'ue1/doxygen/classCPixelFormat.html')
-rw-r--r--ue1/doxygen/classCPixelFormat.html253
1 files changed, 253 insertions, 0 deletions
diff --git a/ue1/doxygen/classCPixelFormat.html b/ue1/doxygen/classCPixelFormat.html
new file mode 100644
index 0000000..b56105c
--- /dev/null
+++ b/ue1/doxygen/classCPixelFormat.html
@@ -0,0 +1,253 @@
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>imgsynth: 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__24.html" alt="CPixelFormat_24" shape="rect" coords="0,56,108,80">
35</map>
36</div>
37
38<p>
39<a href="classCPixelFormat-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.html#6216335559cf002f1e870b420b15913e">CPixelFormat</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="#6216335559cf002f1e870b420b15913e"></a><br></td></tr>
45<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>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor (virtual). <a href="#363edc98e8a6460466d52590679f1853"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPixelFormat.html#5b2dd386a12bd1c41ebe91d22c7713ec">setPixel</a> (const uint32_t *pixel, const uint32_t x, const uint32_t y)=0</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modifies pixel at coordinates x, y. <a href="#5b2dd386a12bd1c41ebe91d22c7713ec"></a><br></td></tr>
51<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>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns color bitcount supported by this class <a href="#bfe1496b57a8a62be38de66ae6cfe3a7"></a><br></td></tr>
54<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
55<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>
56
57<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
58<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>
59
60<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>
61</table>
62<hr><a name="_details"></a><h2>Detailed Description</h2>
63Abstract class for handling different color bitcount of Bitmaps.
64<p>
65Needed for generic use in <a class="el" href="classCBitmap.html" title="Implementation of CFile handling Windows Bitmaps.">CBitmap</a>.<p>
66On 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>
67<a class="anchor" name="6216335559cf002f1e870b420b15913e"></a><!-- doxytag: member="CPixelFormat::CPixelFormat" ref="6216335559cf002f1e870b420b15913e" args="(CBitmap *bitmap)" -->
68<div class="memitem">
69<div class="memproto">
70 <table class="memname">
71 <tr>
72 <td class="memname">CPixelFormat::CPixelFormat </td>
73 <td>(</td>
74 <td class="paramtype"><a class="el" href="classCBitmap.html">CBitmap</a> *&nbsp;</td>
75 <td class="paramname"> <em>bitmap</em> </td>
76 <td>&nbsp;)&nbsp;</td>
77 <td width="100%"><code> [inline]</code></td>
78 </tr>
79 </table>
80</div>
81<div class="memdoc">
82
83<p>
84Default ctor.
85<p>
86<dl class="user" compact><dt><b>Methodname:</b></dt><dd><a class="el" href="classCBitmap.html" title="Implementation of CFile handling Windows Bitmaps.">CBitmap</a> </dd></dl>
87<dl compact><dt><b>Parameters:</b></dt><dd>
88 <table border="0" cellspacing="2" cellpadding="0">
89 <tr><td valign="top"></td><td valign="top"><em>bitmap</em>&nbsp;</td><td>pointer to <a class="el" href="classCBitmap.html" title="Implementation of CFile handling Windows Bitmaps.">CBitmap</a> instance </td></tr>
90 </table>
91</dl>
92<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
93<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
94<dl compact><dt><b>Exceptions:</b></dt><dd>
95 <table border="0" cellspacing="2" cellpadding="0">
96 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
97 </table>
98</dl>
99<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
100
101</div>
102</div><p>
103<a class="anchor" name="363edc98e8a6460466d52590679f1853"></a><!-- doxytag: member="CPixelFormat::~CPixelFormat" ref="363edc98e8a6460466d52590679f1853" args="()" -->
104<div class="memitem">
105<div class="memproto">
106 <table class="memname">
107 <tr>
108 <td class="memname">virtual CPixelFormat::~CPixelFormat </td>
109 <td>(</td>
110 <td class="paramname"> </td>
111 <td>&nbsp;)&nbsp;</td>
112 <td width="100%"><code> [inline, virtual]</code></td>
113 </tr>
114 </table>
115</div>
116<div class="memdoc">
117
118<p>
119Default dtor (virtual).
120<p>
121<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CPixelFormat </dd></dl>
122<dl compact><dt><b>Parameters:</b></dt><dd>
123 <table border="0" cellspacing="2" cellpadding="0">
124 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
125 </table>
126</dl>
127<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
128<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
129<dl compact><dt><b>Exceptions:</b></dt><dd>
130 <table border="0" cellspacing="2" cellpadding="0">
131 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
132 </table>
133</dl>
134<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
135
136</div>
137</div><p>
138<hr><h2>Member Function Documentation</h2>
139<a class="anchor" name="5b2dd386a12bd1c41ebe91d22c7713ec"></a><!-- doxytag: member="CPixelFormat::setPixel" ref="5b2dd386a12bd1c41ebe91d22c7713ec" args="(const uint32_t *pixel, const uint32_t x, const uint32_t y)=0" -->
140<div class="memitem">
141<div class="memproto">
142 <table class="memname">
143 <tr>
144 <td class="memname">virtual void CPixelFormat::setPixel </td>
145 <td>(</td>
146 <td class="paramtype">const uint32_t *&nbsp;</td>
147 <td class="paramname"> <em>pixel</em>, </td>
148 </tr>
149 <tr>
150 <td class="paramkey"></td>
151 <td></td>
152 <td class="paramtype">const uint32_t&nbsp;</td>
153 <td class="paramname"> <em>x</em>, </td>
154 </tr>
155 <tr>
156 <td class="paramkey"></td>
157 <td></td>
158 <td class="paramtype">const uint32_t&nbsp;</td>
159 <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
160 </tr>
161 <tr>
162 <td></td>
163 <td>)</td>
164 <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
165 </tr>
166 </table>
167</div>
168<div class="memdoc">
169
170<p>
171Modifies pixel at coordinates x, y.
172<p>
173<dl class="user" compact><dt><b>Methodname:</b></dt><dd>setPixel </dd></dl>
174<dl compact><dt><b>Parameters:</b></dt><dd>
175 <table border="0" cellspacing="2" cellpadding="0">
176 <tr><td valign="top"></td><td valign="top"><em>pixel</em>&nbsp;</td><td>pointer to new pixel data </td></tr>
177 <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>x-coordinate </td></tr>
178 <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>y-coordinate </td></tr>
179 </table>
180</dl>
181<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
182<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
183<dl compact><dt><b>Exceptions:</b></dt><dd>
184 <table border="0" cellspacing="2" cellpadding="0">
185 <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>
186 </table>
187</dl>
188<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
189
190<p>Implemented in <a class="el" href="classCPixelFormat__24.html#902e32cdae81a2c20404592ebe2d6616">CPixelFormat_24</a>.</p>
191
192</div>
193</div><p>
194<a class="anchor" name="bfe1496b57a8a62be38de66ae6cfe3a7"></a><!-- doxytag: member="CPixelFormat::getBitCount" ref="bfe1496b57a8a62be38de66ae6cfe3a7" args="()=0" -->
195<div class="memitem">
196<div class="memproto">
197 <table class="memname">
198 <tr>
199 <td class="memname">virtual uint32_t CPixelFormat::getBitCount </td>
200 <td>(</td>
201 <td class="paramname"> </td>
202 <td>&nbsp;)&nbsp;</td>
203 <td width="100%"><code> [pure virtual]</code></td>
204 </tr>
205 </table>
206</div>
207<div class="memdoc">
208
209<p>
210returns color bitcount supported by this class
211<p>
212<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getBitCount </dd></dl>
213<dl compact><dt><b>Parameters:</b></dt><dd>
214 <table border="0" cellspacing="2" cellpadding="0">
215 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
216 </table>
217</dl>
218<dl class="return" compact><dt><b>Returns:</b></dt><dd>color bitcount supported by this class </dd></dl>
219<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
220<dl compact><dt><b>Exceptions:</b></dt><dd>
221 <table border="0" cellspacing="2" cellpadding="0">
222 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
223 </table>
224</dl>
225<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
226
227<p>Implemented in <a class="el" href="classCPixelFormat__24.html#4c45044f0ef60c9a0254d0a0bc6255c6">CPixelFormat_24</a>.</p>
228
229</div>
230</div><p>
231<hr><h2>Member Data Documentation</h2>
232<a class="anchor" name="0c0ab3e11535c9cda07d049cc6bd6f9a"></a><!-- doxytag: member="CPixelFormat::m_bitmap" ref="0c0ab3e11535c9cda07d049cc6bd6f9a" args="" -->
233<div class="memitem">
234<div class="memproto">
235 <table class="memname">
236 <tr>
237 <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>
238 </tr>
239 </table>
240</div>
241<div class="memdoc">
242
243<p>
244pointer to <a class="el" href="classCBitmap.html" title="Implementation of CFile handling Windows Bitmaps.">CBitmap</a> instance
245</div>
246</div><p>
247<hr>The documentation for this class was generated from the following file:<ul>
248<li>imgsynth/<a class="el" href="cpixelformat_8h-source.html">cpixelformat.h</a></ul>
249<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 26 12:25:52 2009 for imgsynth by&nbsp;
250<a href="http://www.doxygen.org/index.html">
251<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
252</body>
253</html>