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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gdk::Image Class Reference</h1>A GdkImage C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="gtk_2image_8hh-source.html">gfc/gdk/image.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gdk::Image:
<p><center><img src="classGFC_1_1Gdk_1_1Image.png" usemap="#GFC::Gdk::Image_map" border="0" alt=""></center>
<map name="GFC::Gdk::Image_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Gdk_1_1Image-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z166_0" doxytag="GFC::Gdk::Image::~Image" ></a>
virtual <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z166_0">~Image</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z167_0" doxytag="GFC::Gdk::Image::gdk_image" ></a>
GdkImage * <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_0">gdk_image</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GdkImage structure. <br></dl><li><a class="anchor" name="z167_1" doxytag="GFC::Gdk::Image::operator GdkImage *" ></a>
<a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_1">operator GdkImage *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a> to a GdkImage pointer. <br></dl><li><a class="anchor" name="z167_2" doxytag="GFC::Gdk::Image::image_type" ></a>
<a class="el" href="namespaceGFC_1_1Gdk.html#a273">ImageType</a> <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_2">image_type</a> () const
<dl class="el"><dd class="mdescRight">Returns the type of the image. <br></dl><li><a class="anchor" name="z167_3" doxytag="GFC::Gdk::Image::visual" ></a>
const <a class="el" href="classGFC_1_1Gdk_1_1Visual.html">Visual</a> & <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_3">visual</a> () const
<dl class="el"><dd class="mdescRight">Returns the <a class="el" href="classGFC_1_1Gdk_1_1Visual.html">Visual</a> used to create the image. <br></dl><li><a class="anchor" name="z167_4" doxytag="GFC::Gdk::Image::byte_order" ></a>
<a class="el" href="namespaceGFC_1_1Gdk.html#a279">ByteOrder</a> <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_4">byte_order</a> () const
<dl class="el"><dd class="mdescRight">Returns the byte order for the image. <br></dl><li><a class="anchor" name="z167_5" doxytag="GFC::Gdk::Image::width" ></a>
int <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_5">width</a> () const
<dl class="el"><dd class="mdescRight">Returns the width of the image in pixels. <br></dl><li><a class="anchor" name="z167_6" doxytag="GFC::Gdk::Image::height" ></a>
int <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_6">height</a> () const
<dl class="el"><dd class="mdescRight">Returns the height of the image in pixels. <br></dl><li><a class="anchor" name="z167_7" doxytag="GFC::Gdk::Image::depth" ></a>
unsigned short <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_7">depth</a> () const
<dl class="el"><dd class="mdescRight">Returns the depth of the image, i.e. the number of bits per pixel. <br></dl><li><a class="anchor" name="z167_8" doxytag="GFC::Gdk::Image::bytes_per_pixel" ></a>
unsigned short <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_8">bytes_per_pixel</a> () const
<dl class="el"><dd class="mdescRight">Returns the number of bytes per pixel. <br></dl><li><a class="anchor" name="z167_9" doxytag="GFC::Gdk::Image::bytes_per_line" ></a>
unsigned short <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_9">bytes_per_line</a> () const
<dl class="el"><dd class="mdescRight">Returns the number of bytes per line of the image. <br></dl><li>unsigned int <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_10">get_pixel</a> (int x, int y) const
<dl class="el"><dd class="mdescRight">Gets a pixel value at a specified position in the image. <a href="#z167_10"></a><br></dl><li><a class="el" href="classGFC_1_1Gdk_1_1Colormap.html">Colormap</a> * <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_11">get_colormap</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the colormap for a given image, if it exists. <a href="#z167_11"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z168_0">put_pixel</a> (int x, int y, unsigned int pixel)
<dl class="el"><dd class="mdescRight">Sets a pixel in the image to a given pixel value. <a href="#z168_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z168_1">set_colormap</a> (<a class="el" href="classGFC_1_1Gdk_1_1Colormap.html">Colormap</a> &colormap)
<dl class="el"><dd class="mdescRight">Sets the colormap for the image to the given colormap. <a href="#z168_1"></a><br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a> > <a class="el" href="classGFC_1_1Gdk_1_1Image.html#e0">create</a> (<a class="el" href="namespaceGFC_1_1Gdk.html#a273">ImageType</a> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html#z121_2">type</a>, const <a class="el" href="classGFC_1_1Gdk_1_1Visual.html">Visual</a> &visual, int width, int height)
<dl class="el"><dd class="mdescRight">Creates a new image. <a href="#e0"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gdk_1_1Image.html#z165_0">Image</a> (GdkImage *image, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a> from an existing GdkImage. <a href="#z165_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GdkImage C++ wrapper class.
<p>
The <a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a> object represents an area for drawing graphics. It has now been superceded to a large extent by the much more flexible <a class="el" href="classGFC_1_1Gdk_1_1Drawable.html">Gdk::Drawable</a> RGB drawing methods.<p>
An <a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a> can be manipulated with <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z167_10">get_pixel()</a> and <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z168_0">put_pixel()</a>, or alternatively by changing the actual pixel data. Though manipulating the pixel data requires complicated code to cope with the different formats that may be used. To draw an <a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a> in a <a class="el" href="classGFC_1_1Gdk_1_1Window.html">Gdk::Window</a> or <a class="el" href="classGFC_1_1Gdk_1_1Pixmap.html">Gdk::Pixmap</a> use <a class="el" href="classGFC_1_1Gdk_1_1Drawable.html#z135_17">Gdk::Drawable::draw_image()</a>.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z165_0" doxytag="GFC::Gdk::Image::Image" ></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"> GFC::Gdk::Image::Image </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GdkImage * </td>
<td class="mdname" nowrap> <em>image</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a> from an existing GdkImage.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>image</em> </td><td>A pointer to a GdkImage. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>image</em> can be a newly created GdkImage or an existing GdkImage. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0" doxytag="GFC::Gdk::Image::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"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a>> GFC::Gdk::Image::create </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gdk.html#a273">ImageType</a> </td>
<td class="mdname" nowrap> <em>type</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Gdk_1_1Visual.html">Visual</a> & </td>
<td class="mdname" nowrap> <em>visual</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>width</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>height</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a new image.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>type</em> </td><td>The type of the image, one of IMAGE_NORMAL, IMAGE_SHARED and IMAGE_FASTEST. </td></tr>
<tr><td></td><td valign=top><em>visual</em> </td><td>The <a class="el" href="classGFC_1_1Gdk_1_1Visual.html">Visual</a> to use for the image. </td></tr>
<tr><td></td><td valign=top><em>width</em> </td><td>The width of the image in pixels. </td></tr>
<tr><td></td><td valign=top><em>height</em> </td><td>The height of the image in pixels. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to the new <a class="el" href="classGFC_1_1Gdk_1_1Image.html">Image</a>, or null if the image could not be created.</dd></dl>
<br>
IMAGE_FASTEST is probably the best choice, since it will try creating an IMAGE_SHARED image first and if that fails it will then use IMAGE_NORMAL. </td>
</tr>
</table>
<a class="anchor" name="z167_11" doxytag="GFC::Gdk::Image::get_colormap" ></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="classGFC_1_1Gdk_1_1Colormap.html">Colormap</a>* GFC::Gdk::Image::get_colormap </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the colormap for a given image, if it exists.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The colormap for the image.</dd></dl>
<br>
An image will have a colormap if the drawable from which it was created has a colormap, or if a colormap was set explicitely with <a class="el" href="classGFC_1_1Gdk_1_1Image.html#z168_1">set_colormap()</a>. </td>
</tr>
</table>
<a class="anchor" name="z167_10" doxytag="GFC::Gdk::Image::get_pixel" ></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"> unsigned int GFC::Gdk::Image::get_pixel </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>x</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>y</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets a pixel value at a specified position in the image.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>x</em> </td><td>The X coordinate of the pixel to get. </td></tr>
<tr><td></td><td valign=top><em>y</em> </td><td>The Y coordinate of the pixel to get. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The pixel value at the given position. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z168_0" doxytag="GFC::Gdk::Image::put_pixel" ></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 GFC::Gdk::Image::put_pixel </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>x</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>y</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>pixel</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>
Sets a pixel in the image to a given pixel value.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>x</em> </td><td>The X coordinate of the pixel to set. </td></tr>
<tr><td></td><td valign=top><em>y</em> </td><td>The Y coordinate of the pixel to set. </td></tr>
<tr><td></td><td valign=top><em>pixel</em> </td><td>The pixel value to set. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z168_1" doxytag="GFC::Gdk::Image::set_colormap" ></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 GFC::Gdk::Image::set_colormap </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gdk_1_1Colormap.html">Colormap</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>colormap</em> </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>
Sets the colormap for the image to the given colormap.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>colormap</em> </td><td>A <a class="el" href="classGFC_1_1Gdk_1_1Colormap.html">Colormap</a>.</td></tr>
</table>
</dl>
<br>
Normally there's no need to use this method, images are created with the correct colormap if you get the image from a drawable. If you create the image from scratch, use the colormap of the drawable you intend to render the image to. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gdk_2image_8hh-source.html">gdk/image.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:36 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
