File: classPLSDLBmp.html

package info (click to toggle)
paintlib 2.6.2-8
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 7,900 kB
  • ctags: 3,875
  • sloc: cpp: 25,209; sh: 10,600; ansic: 1,891; makefile: 119
file content (205 lines) | stat: -rw-r--r-- 11,131 bytes parent folder | download | duplicates (2)
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
<!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: PLSDLBmp 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&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a></div>
<h1>PLSDLBmp Class Reference</h1><code>#include &lt;<a class="el" href="plsdlbmp_8h-source.html">plsdlbmp.h</a>&gt;</code>
<p>
<p>Inheritance diagram for PLSDLBmp:
<p><center><img src="classPLSDLBmp.png" usemap="#PLSDLBmp_map" border="0" alt=""></center>
<map name="PLSDLBmp_map">
<area href="classPLBmp.html" alt="PLBmp" shape="rect" coords="0,168,79,192">
<area href="classPLBmpBase.html" alt="PLBmpBase" shape="rect" coords="0,112,79,136">
<area href="classPLBmpInfo.html" alt="PLBmpInfo" shape="rect" coords="0,56,79,80">
</map>
<a href="classPLSDLBmp-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><a name="a0" doxytag="PLSDLBmp::PLSDLBmp"></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a0">PLSDLBmp</a> (int SurfFlags=SDL_SWSURFACE)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an empty bitmap. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a1" doxytag="PLSDLBmp::~PLSDLBmp"></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a1">~PLSDLBmp</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the bitmap. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="PLSDLBmp::PLSDLBmp"></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a2">PLSDLBmp</a> (const <a class="el" href="classPLBmpBase.html">PLBmpBase</a> &amp;Orig)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="PLSDLBmp::PLSDLBmp"></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a3">PLSDLBmp</a> (const <a class="el" href="classPLSDLBmp.html">PLSDLBmp</a> &amp;Orig)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a4">Attach</a> (SDL_Surface *pSurface)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="PLSDLBmp::operator="></a>
<a class="el" href="classPLSDLBmp.html">PLSDLBmp</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a5">operator=</a> (const <a class="el" href="classPLBmpBase.html">PLBmpBase</a> &amp;Orig)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a6" doxytag="PLSDLBmp::operator="></a>
<a class="el" href="classPLSDLBmp.html">PLSDLBmp</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a6">operator=</a> (const <a class="el" href="classPLSDLBmp.html">PLSDLBmp</a> &amp;Orig)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>SDL_Surface *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a7">GetSurface</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a8" doxytag="PLSDLBmp::GetMemUsed"></a>
long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a8">GetMemUsed</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the amount of memory used by the object. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a9" doxytag="PLSDLBmp::GetBytesPerLine"></a>
long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#a9">GetBytesPerLine</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns number of bytes used per line. <br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="e0" doxytag="PLSDLBmp::GetMemNeeded"></a>
long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#e0">GetMemNeeded</a> (PLLONG width, PLLONG height, PLWORD BitsPerPixel)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns memory needed by a bitmap with the specified attributes. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="e1" doxytag="PLSDLBmp::GetBitsMemNeeded"></a>
long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#e1">GetBitsMemNeeded</a> (PLLONG width, PLLONG height, PLWORD BitsPerPixel)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns memory needed by bitmap bits. <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>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#b0">internalCreate</a> (PLLONG Width, PLLONG Height, PLWORD BitsPerPixel, bool bAlphaChannel, bool bIsGreyscale)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a name="b1" doxytag="PLSDLBmp::freeMembers"></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#b1">freeMembers</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delete memory allocated by member variables. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="b2" doxytag="PLSDLBmp::initLineArray"></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPLSDLBmp.html#b2">initLineArray</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize internal table of line addresses. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Manipulates uncompressed bitmaps stored as SDL surfaces. 32 bpp only. 
<p>

<p>
Definition at line <a class="el" href="plsdlbmp_8h-source.html#l00022">22</a> of file <a class="el" href="plsdlbmp_8h-source.html">plsdlbmp.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="a4" doxytag="PLSDLBmp::Attach"></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 PLSDLBmp::Attach </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">SDL_Surface *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>pSurface</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Attach to an existing SDL surface. After the attach, the bitmap object besomes the owner of the surface. Any previous contents are destroyed.     </td>
  </tr>
</table>
<a name="a7" doxytag="PLSDLBmp::GetSurface"></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"> SDL_Surface* PLSDLBmp::GetSurface </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns a pointer to the internal SDL surface. Using this pointer, you can bring SDL and paintlib data out of sync easily. Handle with care.     </td>
  </tr>
</table>
<a name="b0" doxytag="PLSDLBmp::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 PLSDLBmp::internalCreate </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">PLLONG&nbsp;</td>
          <td class="mdname" nowrap> <em>Width</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>PLLONG&nbsp;</td>
          <td class="mdname" nowrap> <em>Height</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>PLWORD&nbsp;</td>
          <td class="mdname" nowrap> <em>BitsPerPixel</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>bAlphaChannel</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>bIsGreyscale</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Create a new bitmap with uninitialized bits. (Assume no memory is allocated yet.) 
<p>
Implements <a class="el" href="classPLBmp.html#b1">PLBmp</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="plsdlbmp_8h-source.html">plsdlbmp.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Jul 28 17:13:38 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>