summaryrefslogtreecommitdiff
path: root/doc/fl_image.html
blob: 783828948a4b54e479c2b732ee4c8d7b4f34ba2d (plain)
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

<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Fl_Image Binding Map</title>
    <link href="map.css" rel="stylesheet">
  </head>

  <body>


<h2>Fl_Image Binding Map</h2>


<a href="index.html">Back to Index</a>


<table class="package">
  <tr><th colspan="2">Package name</th></tr>

  <tr>
    <td>Fl_Image</td>
    <td>FLTK.Images</td>
  </tr>

</table>



<table class="type">
  <tr><th colspan="2">Types</th></tr>

  <tr>
    <td>Fl_Image</td>
    <td>Image</td>
  </tr>

  <tr>
    <td>&nbsp;</td>
    <td>Image_Reference</td>
  </tr>

  <tr>
    <td>Fl_RGB_Scaling</td>
    <td>Scaling_Kind</td>
  </tr>

  <tr>
    <td>&nbsp;</td>
    <td>Blend</td>
  </tr>

</table>



<table class="type">
  <tr><th colspan="2">Errors</th></tr>

  <tr>
    <td>ERR_FILE_ACCESS</td>
    <td>File_Access_Error</td>
  </tr>

  <tr>
    <td>ERR_FORMAT</td>
    <td>Format_Error</td>
  </tr>

  <tr>
    <td>ERR_NO_IMAGE</td>
    <td>No_Image_Error</td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Static Functions and Procedures</th></tr>

  <tr>
<td><pre>
static void RGB_scaling(Fl_RGB_Scaling);
</pre></td>
<td><pre>
procedure Set_Copy_Algorithm
       (To : in Scaling_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
static Fl_RGB_Scaling RGB_scaling();
</pre></td>
<td><pre>
function Get_Copy_Algorithm
    return Scaling_Kind;
</pre></td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Functions and Procedures</th></tr>

  <tr>
<td><pre>
Fl_Image(int W, int H, int D);
</pre></td>
<td><pre>
function Create
       (Width, Height, Depth : in Natural)
    return Image;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void color_average(Fl_Color c, float i);
</pre></td>
<td><pre>
procedure Color_Average
       (This   : in out Image;
        Col    : in     Color;
        Amount : in     Blend);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual Fl_Image * copy(int W, int H);
</pre></td>
<td><pre>
function Copy
       (This          : in Image;
        Width, Height : in Natural)
    return Image'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Image * copy();
</pre></td>
<td><pre>
function Copy
       (This : in Image)
    return Image'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
int count() const;
</pre></td>
<td><pre>
function Get_Data_Count
       (This : in Image)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td>&nbsp;</td>
<td><pre>
function Get_Data_Size
       (This : in Image)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
int d() const;
</pre></td>
<td><pre>
function Get_D
       (This : in Image)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * const * data() const;
</pre></td>
<td><pre>
function Get_Datum
       (This     : in Image;
        Data     : in Positive;
        Position : in Positive)
    return Color_Component
with Pre =>
        Data <= Get_Data_Count (This) and
        Position <= Get_Data_Size (This);

procedure Set_Datum
       (This     : in out Image;
        Data     : in     Positive;
        Position : in     Positive;
        Value    : in     Color_Component)
with Pre =>
        Data <= Get_Data_Count (This) and
        Position <= Get_Data_Size (This);

function Get_Data
       (This     : in Image;
        Data     : in Positive;
        Position : in Positive;
        Count    : in Natural)
    return Color_Component_Array
with Pre =>
        Data <= Get_Data_Count (This) and
        Position <= Get_Data_Size (This) and
        Count <= Get_Data_Size (This) - Position + 1;

function All_Data
       (This : in Image;
        Data : in Positive)
    return Color_Component_Array
with Pre =>
        Data <= Get_Data_Count (This);

procedure Update_Data
       (This     : in out Image;
        Data     : in     Positive;
        Position : in     Positive;
        Values   : in     Color_Component_Array)
with Pre =>
        Data <= Get_Data_Count (This) and
        Position <= Get_Data_Size (This) and
        Values'Length <= Get_Data_Size (This) - Position + 1;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void desaturate();
</pre></td>
<td><pre>
procedure Desaturate
       (This : in out Image);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void draw(int X, int Y, int W, int H,
    int cx=0, int cy=0);
</pre></td>
<td><pre>
procedure Draw
       (This       : in Image;
        X, Y, W, H : in Integer;
        CX, CY     : in Integer := 0);
</pre></td>
  </tr>

  <tr>
<td><pre>
void draw(int X, int Y);
</pre></td>
<td><pre>
procedure Draw
       (This : in Image;
        X, Y : in Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void draw_empty(int X, int Y);
</pre></td>
<td><pre>
procedure Draw_Empty
       (This : in Image;
        X, Y : in Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
int fail();
</pre></td>
<td><pre>
function Is_Empty
       (This : in Image)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int h() const;
</pre></td>
<td><pre>
function Get_H
       (This : in Image)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void inactive();
</pre></td>
<td><pre>
procedure Inactive
       (This : in out Image);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void label(Fl_Widget *w);
</pre></td>
<td>Not applicable as the original is marked as obsolete</td>
  </tr>

  <tr>
<td><pre>
virtual void label(Fl_Menu_Item *m);
</pre></td>
<td>Not applicable as the original is marked as obsolete</td>
  </tr>

  <tr>
<td><pre>
int ld() const;
</pre></td>
<td><pre>
function Get_Line_Data
       (This : in Image)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void uncache();
</pre></td>
<td><pre>
procedure Uncache
       (This : in out Image);
</pre></td>
  </tr>

  <tr>
<td><pre>
int w() const;
</pre></td>
<td><pre>
function Get_W
       (This : in Image)
    return Natural;
</pre></td>
  </tr>

</table>


  </body>
</html>