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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>paintlib: PLBmp class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a></div>
<h1>PLBmp Class Reference</h1><code>#include <<a class="el" href="plbitmap_8h-source.html">plbitmap.h</a>></code>
<p>
<p>Inheritance diagram for PLBmp:
<p><center><img src="classPLBmp.png" usemap="#PLBmp_map" border="0" alt=""></center>
<map name="PLBmp_map">
<area href="classPLBmpBase.html" alt="PLBmpBase" shape="rect" coords="111,112,212,136">
<area href="classPLBmpInfo.html" alt="PLBmpInfo" shape="rect" coords="111,56,212,80">
<area href="classPLAnyBmp.html" alt="PLAnyBmp" shape="rect" coords="0,224,101,248">
<area href="classPLDirectFBBmp.html" alt="PLDirectFBBmp" shape="rect" coords="111,224,212,248">
<area href="classPLWinBmp.html" alt="PLWinBmp" shape="rect" coords="222,224,323,248">
<area href="classPLDIBSection.html" alt="PLDIBSection" shape="rect" coords="222,280,323,304">
</map>
<a href="classPLBmp-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> </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a0">PLBmp</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a1" doxytag="PLBmp::~PLBmp"></a>
virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a1">~PLBmp</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Empty destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classPLBmp.html">PLBmp</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a2">operator=</a> (<a class="el" href="classPLBmpBase.html">PLBmpBase</a> const &Orig)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="PLBmp::operator="></a>
<a class="el" href="classPLBmp.html">PLBmp</a> & </td><td class="memItemRight" valign=bottom><b>operator=</b> (<a class="el" href="classPLBmp.html">PLBmp</a> const &Orig)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a4">Create</a> (PLLONG Width, PLLONG Height, const PLPixelFormat &pf, PLBYTE *pBits=0, int Stride=0, const <a class="el" href="classPLPoint.html">PLPoint</a> &Resolution=<a class="el" href="classPLPoint.html">PLPoint</a>(0, 0))</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a5">Create</a> (const <a class="el" href="classPLBmpInfo.html">PLBmpInfo</a> &Info)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a6">CreateCopy</a> (const <a class="el" href="classPLBmpBase.html">PLBmpBase</a> &rSrcBmp, const PLPixelFormat &pfWanted=PLPixelFormat::DONTCARE)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a7">CreateFilteredCopy</a> (<a class="el" href="classPLBmpBase.html">PLBmpBase</a> &rSrcBmp, const <a class="el" href="classPLFilter.html">PLFilter</a> &rFilter)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a8" doxytag="PLBmp::GetMemUsed"></a>
virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a8">GetMemUsed</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns memory used by a bitmap. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a9">GetBytesPerLine</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a10" doxytag="PLBmp::ApplyFilter"></a>
void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#a10">ApplyFilter</a> (const <a class="el" href="classPLFilter.html">PLFilter</a> &Filter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Applies a filter to the bitmap. <br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="b0" doxytag="PLBmp::initLocals"></a>
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#b0">initLocals</a> (PLLONG Width, PLLONG Height, const PLPixelFormat &pf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Can be called from <a class="el" href="classPLBmp.html#b1">internalCreate()</a> to initialize object state. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#b1">internalCreate</a> (PLLONG Width, PLLONG Height, const PLPixelFormat &pf)=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="b2" doxytag="PLBmp::initLineArray"></a>
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#b2">initLineArray</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize internal table of line addresses. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="b3" doxytag="PLBmp::freeMembers"></a>
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#b3">freeMembers</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete memory allocated by member variables. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLBmp.html#b4">internalCopy</a> (const <a class="el" href="classPLBmpBase.html">PLBmpBase</a> &rSrcBmp)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Device- and OS-independent bitmap class. Manipulates uncompressed bitmaps of all color depths.<p>
This class is an abstract base class. It exists to define a format-independent interface for bitmap manipulation and to provide common routines. Derived classes must support at least the color depths 1, 8 and 32 bpp. PLBmp defines a public interface for general use and a protected interface for use by derived classes.<p>
For 32 bpp, alpha channel information is stored in one byte (PL_RGBA_ALPHA) of each 4-byte pixel. To allow for optimizations when no alpha channel is present, a flag is set whenever the alpha information is valid. The complete alpha channel of a bitmap can be replaced by a different one by calling <a class="el" href="classPLBmpBase.html#a9">SetAlphaChannel()</a>. A 0 in an alpha channel entry is completely transparent; a 255 is completely opaque.
<p>
<p>
Definition at line <a class="el" href="plbitmap_8h-source.html#l00040">40</a> of file <a class="el" href="plbitmap_8h-source.html">plbitmap.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="PLBmp::PLBmp"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> PLBmp::PLBmp </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Empty constructor. Constructors in derived classes create a small empty bitmap to ensure that the object is always in a sane state. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a5" doxytag="PLBmp::Create"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void PLBmp::Create </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classPLBmpInfo.html">PLBmpInfo</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>Info</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a new empty bitmap. Info contains the metadata (width, height, etc.) to be used in creation. </td>
</tr>
</table>
<a name="a4" doxytag="PLBmp::Create"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void PLBmp::Create </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PLLONG </td>
<td class="mdname" nowrap> <em>Width</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>PLLONG </td>
<td class="mdname" nowrap> <em>Height</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const PLPixelFormat & </td>
<td class="mdname" nowrap> <em>pf</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>PLBYTE * </td>
<td class="mdname" nowrap> <em>pBits</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>Stride</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classPLPoint.html">PLPoint</a> & </td>
<td class="mdname" nowrap> <em>Resolution</em> = <a class="el" href="classPLPoint.html">PLPoint</a>(0, 0)</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a new empty bitmap. Memory for the bits is allocated but not initialized. Previous contents of the bitmap object are discarded. If bAlphaChannel is true, the bitmap is assumed to contain a valid alpha channel. If pBits is non-null, it contains pixel data in the format expected by the bitmap and Stride is the distance in bytes from one source line to the next. In this case, the data in pBits is copied into the internal buffer of the PLBmp. </td>
</tr>
</table>
<a name="a6" doxytag="PLBmp::CreateCopy"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void PLBmp::CreateCopy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classPLBmpBase.html">PLBmpBase</a> & </td>
<td class="mdname" nowrap> <em>rSrcBmp</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const PLPixelFormat & </td>
<td class="mdname" nowrap> <em>pfWanted</em> = PLPixelFormat::DONTCARE</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a copy of rSrcBmp, converting color depth if nessesary. Supports 1, 8, 16, 24 and 32 BPP. Alpha channel information is preserved if supported by the target bit depth. Conversion to 8 bpp is possible only from 1 and 32 bpp. </td>
</tr>
</table>
<a name="a7" doxytag="PLBmp::CreateFilteredCopy"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void PLBmp::CreateFilteredCopy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classPLBmpBase.html">PLBmpBase</a> & </td>
<td class="mdname" nowrap> <em>rSrcBmp</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classPLFilter.html">PLFilter</a> & </td>
<td class="mdname" nowrap> <em>rFilter</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a copy of rSrcBmp, applying rFilter on the way. Depending on the filter called, this is often much faster than <a class="el" href="classPLBmp.html#a6">CreateCopy()</a> followed by <a class="el" href="classPLBmp.html#a10">ApplyFilter()</a>. </td>
</tr>
</table>
<a name="a9" doxytag="PLBmp::GetBytesPerLine"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long PLBmp::GetBytesPerLine </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns number of bytes used per line. Note that this is not the stride of the bitmap.
<p>
Implemented in <a class="el" href="classPLAnyBmp.html#a7">PLAnyBmp</a>, <a class="el" href="classPLDirectFBBmp.html#a9">PLDirectFBBmp</a>, and <a class="el" href="classPLWinBmp.html#a8">PLWinBmp</a>. </td>
</tr>
</table>
<a name="b4" doxytag="PLBmp::internalCopy"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void PLBmp::internalCopy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classPLBmpBase.html">PLBmpBase</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>rSrcBmp</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a new PLBmp as copy of rSrcBmp. Assumes there is no memory allocated yet. </td>
</tr>
</table>
<a name="b1" doxytag="PLBmp::internalCreate"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void PLBmp::internalCreate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PLLONG </td>
<td class="mdname" nowrap> <em>Width</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>PLLONG </td>
<td class="mdname" nowrap> <em>Height</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const PLPixelFormat & </td>
<td class="mdname" nowrap> <em>pf</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a new bitmap with uninitialized bits. (Assume no memory is allocated yet.)
<p>
Implemented in <a class="el" href="classPLAnyBmp.html#b0">PLAnyBmp</a>. </td>
</tr>
</table>
<a name="a2" doxytag="PLBmp::operator="></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classPLBmp.html">PLBmp</a> & PLBmp::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classPLBmpBase.html">PLBmpBase</a> const & </td>
<td class="mdname1" valign="top" nowrap> <em>Orig</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Assignment operator. Note that assignment between different derived classes is possible and results in a format conversion.
<p>
Reimplemented in <a class="el" href="classPLAnyBmp.html#a4">PLAnyBmp</a>, <a class="el" href="classPLDIBSection.html#a4">PLDIBSection</a>, and <a class="el" href="classPLWinBmp.html#a4">PLWinBmp</a>.
<p>
Definition at line <a class="el" href="plbitmap_8h-source.html#l00155">155</a> of file <a class="el" href="plbitmap_8h-source.html">plbitmap.h</a>.
<p>
Referenced by <a class="el" href="plwinbmp_8h-source.html#l00208">PLWinBmp::operator=()</a>, <a class="el" href="pldirectfbbmp_8h-source.html#l00154">PLDirectFBBmp::operator=()</a>, <a class="el" href="pldibsect_8h-source.html#l00177">PLDIBSection::operator=()</a>, and <a class="el" href="planybmp_8h-source.html#l00133">PLAnyBmp::operator=()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="plbitmap_8h-source.html">plbitmap.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 13 16:16:41 2004 for paintlib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.2 </small></address>
</body>
</html>
|
