projects / sdlgit/SDL-Site.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | history | HEAD
updated docs
[sdlgit/SDL-Site.git] / pages / SDL-GFX-ImageFilter.html-inc
CommitLineData
cf23a5da 1<div class="pod">
2<!-- INDEX START -->
3<h3 id="TOP">Index</h3>
4
5<ul><li><a href="#NAME">NAME</a></li>
6<li><a href="#CATEGORY">CATEGORY</a></li>
7<li><a href="#METHODS">METHODS</a>
8<ul><li><a href="#MMX_detect">MMX_detect</a></li>
9<li><a href="#MMX_off">MMX_off</a></li>
10<li><a href="#MMX_on">MMX_on</a></li>
11<li><a href="#add">add</a></li>
12<li><a href="#mean">mean</a></li>
13<li><a href="#sub">sub</a></li>
14<li><a href="#abs_diff">abs_diff</a></li>
15<li><a href="#mult">mult</a></li>
16<li><a href="#mult_nor">mult_nor</a></li>
17<li><a href="#mult_div_by_2">mult_div_by_2</a></li>
18<li><a href="#mult_div_by_4">mult_div_by_4</a></li>
19<li><a href="#bit_and">bit_and</a></li>
20<li><a href="#bit_or">bit_or</a></li>
21<li><a href="#div">div</a></li>
22<li><a href="#bit_negation">bit_negation</a></li>
23<li><a href="#add_byte">add_byte</a></li>
24<li><a href="#add_uint">add_uint</a></li>
25<li><a href="#add_byte_to_half">add_byte_to_half</a></li>
26<li><a href="#sub_byte">sub_byte</a></li>
27<li><a href="#sub_uint">sub_uint</a></li>
28<li><a href="#shift_right">shift_right</a></li>
29<li><a href="#shift_right_uint">shift_right_uint</a></li>
30<li><a href="#mult_by_byte">mult_by_byte</a></li>
31<li><a href="#shift_right_and_mult_by_byte">shift_right_and_mult_by_byte</a></li>
32<li><a href="#shift_left_byte">shift_left_byte</a></li>
33<li><a href="#shift_left_uint">shift_left_uint</a></li>
34<li><a href="#shift_left">shift_left</a></li>
35<li><a href="#binarize_using_threshold">binarize_using_threshold</a></li>
36<li><a href="#clip_to_range">clip_to_range</a></li>
37<li><a href="#normalize_linear">normalize_linear</a></li>
38<li><a href="#convolve_kernel_3x3_divide">convolve_kernel_3x3_divide</a></li>
39<li><a href="#convolve_kernel_5x5_divide">convolve_kernel_5x5_divide</a></li>
40<li><a href="#convolve_kernel_7x7_divide">convolve_kernel_7x7_divide</a></li>
41<li><a href="#convolve_kernel_9x9_divide">convolve_kernel_9x9_divide</a></li>
42<li><a href="#convolve_kernel_3x3_shift_right">convolve_kernel_3x3_shift_right</a></li>
43<li><a href="#convolve_kernel_5x5_shift_right">convolve_kernel_5x5_shift_right</a></li>
44<li><a href="#convolve_kernel_7x7_shift_right">convolve_kernel_7x7_shift_right</a></li>
45<li><a href="#convolve_kernel_9x9_shift_right">convolve_kernel_9x9_shift_right</a></li>
46<li><a href="#sobel_x">sobel_x</a></li>
47<li><a href="#sobel_x_shift_right">sobel_x_shift_right</a></li>
48<li><a href="#align_stack">align_stack</a></li>
d5943b68 49<li><a href="#restore_stack">restore_stack</a></li>
cf23a5da 50</ul>
51</li>
d5943b68 52<li><a href="#AUTHORS">AUTHORS</a>
53</li>
cf23a5da 54</ul><hr />
55<!-- INDEX END -->
56
57<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
58<div id="NAME_CONTENT">
59<p>SDL::GFX::ImageFilter - image filtering functions</p>
60
61</div>
62<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
63<div id="CATEGORY_CONTENT">
b5d537cc 64<p>TODO, GFX</p>
cf23a5da 65
66</div>
67<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
68<div id="METHODS_CONTENT">
69
70</div>
71<h2 id="MMX_detect">MMX_detect</h2>
72<div id="MMX_detect_CONTENT">
73<p>int
74gfx_image_MMX_detect()
75 CODE:
76 SDL_imageFilterMMXdetect();</p>
77
78</div>
79<h2 id="MMX_off">MMX_off</h2>
80<div id="MMX_off_CONTENT">
81<p>void
82gfx_image_MMX_off()
83 CODE:
84 SDL_imageFilterMMXoff();</p>
85
86</div>
87<h2 id="MMX_on">MMX_on</h2>
88<div id="MMX_on_CONTENT">
89<p>void
90gfx_image_MMX_on()
91 CODE:
92 SDL_imageFilterMMXon();</p>
93
94</div>
95<h2 id="add">add</h2>
96<div id="add_CONTENT">
97<p>int
98gfx_image_add(Src1, Src2, Dest, length)
99 unsigned char *Src1
100 unsigned char *Src2
101 unsigned char *Dest
102 int length
103 CODE:
104 RETVAL = SDL_imageFilterAdd(Src1, Src2, Dest, length);
105 OUTPUT:
106 RETVAL</p>
107
108</div>
109<h2 id="mean">mean</h2>
110<div id="mean_CONTENT">
111<p>int
112gfx_image_mean(Src1, Src2, Dest, length)
113 unsigned char *Src1
114 unsigned char *Src2
115 unsigned char *Dest
116 int length
117 CODE:
118 RETVAL = SDL_imageFilterMean(Src1, Src2, Dest, length);
119 OUTPUT:
120 RETVAL</p>
121
122</div>
123<h2 id="sub">sub</h2>
124<div id="sub_CONTENT">
125<p>int
126gfx_image_sub(Src1, Src2, Dest, length)
127 unsigned char *Src1
128 unsigned char *Src2
129 unsigned char *Dest
130 int length
131 CODE:
132 RETVAL = SDL_imageFilterSub(Src1, Src2, Dest, length);
133 OUTPUT:
134 RETVAL</p>
135
136</div>
137<h2 id="abs_diff">abs_diff</h2>
138<div id="abs_diff_CONTENT">
139<p>int
140gfx_image_abs_diff(Src1, Src2, Dest, length)
141 unsigned char *Src1
142 unsigned char *Src2
143 unsigned char *Dest
144 int length
145 CODE:
146 RETVAL = SDL_imageFilterAbsDiff(Src1, Src2, Dest, length);
147 OUTPUT:
148 RETVAL</p>
149
150</div>
151<h2 id="mult">mult</h2>
152<div id="mult_CONTENT">
153<p>int
154gfx_image_mult(Src1, Src2, Dest, length)
155 unsigned char *Src1
156 unsigned char *Src2
157 unsigned char *Dest
158 int length
159 CODE:
160 RETVAL = SDL_imageFilterMult(Src1, Src2, Dest, length);
161 OUTPUT:
162 RETVAL</p>
163
164</div>
165<h2 id="mult_nor">mult_nor</h2>
166<div id="mult_nor_CONTENT">
167<p>int
168gfx_image_mult_nor(Src1, Src2, Dest, length)
169 unsigned char *Src1
170 unsigned char *Src2
171 unsigned char *Dest
172 int length
173 CODE:
174 RETVAL = SDL_imageFilterMultNor(Src1, Src2, Dest, length);
175 OUTPUT:
176 RETVAL</p>
177
178</div>
179<h2 id="mult_div_by_2">mult_div_by_2</h2>
180<div id="mult_div_by_2_CONTENT">
181<p>int
182gfx_image_mult_div_by_2(Src1, Src2, Dest, length)
183 unsigned char *Src1
184 unsigned char *Src2
185 unsigned char *Dest
186 int length
187 CODE:
188 RETVAL = SDL_imageFilterMultDivby2(Src1, Src2, Dest, length);
189 OUTPUT:
190 RETVAL</p>
191
192</div>
193<h2 id="mult_div_by_4">mult_div_by_4</h2>
194<div id="mult_div_by_4_CONTENT">
195<p>int
196gfx_image_mult_div_by_4(Src1, Src2, Dest, length)
197 unsigned char *Src1
198 unsigned char *Src2
199 unsigned char *Dest
200 int length
201 CODE:
202 RETVAL = SDL_imageFilterMultDivby4(Src1, Src2, Dest, length);
203 OUTPUT:
204 RETVAL</p>
205
206</div>
207<h2 id="bit_and">bit_and</h2>
208<div id="bit_and_CONTENT">
209<p>int
210gfx_image_bit_and(Src1, Src2, Dest, length)
211 unsigned char *Src1
212 unsigned char *Src2
213 unsigned char *Dest
214 int length
215 CODE:
216 RETVAL = SDL_imageFilterBitAnd(Src1, Src2, Dest, length);
217 OUTPUT:
218 RETVAL</p>
219
220</div>
221<h2 id="bit_or">bit_or</h2>
222<div id="bit_or_CONTENT">
223<p>int
224gfx_image_bit_or(Src1, Src2, Dest, length)
225 unsigned char *Src1
226 unsigned char *Src2
227 unsigned char *Dest
228 int length
229 CODE:
230 RETVAL = SDL_imageFilterBitOr(Src1, Src2, Dest, length);
231 OUTPUT:
232 RETVAL</p>
233
234</div>
235<h2 id="div">div</h2>
236<div id="div_CONTENT">
237<p>int
238gfx_image_div(Src1, Src2, Dest, length)
239 unsigned char *Src1
240 unsigned char *Src2
241 unsigned char *Dest
242 int length
243 CODE:
244 RETVAL = SDL_imageFilterDiv(Src1, Src2, Dest, length);
245 OUTPUT:
246 RETVAL</p>
247
248</div>
249<h2 id="bit_negation">bit_negation</h2>
250<div id="bit_negation_CONTENT">
251<p>int
252gfx_image_bit_negation(Src1, Dest, length)
253 unsigned char *Src1
254 unsigned char *Dest
255 int length
256 CODE:
257 RETVAL = SDL_imageFilterBitNegation(Src1, Dest, length);
258 OUTPUT:
259 RETVAL</p>
260
261</div>
262<h2 id="add_byte">add_byte</h2>
263<div id="add_byte_CONTENT">
264<p>int
265gfx_image_add_byte(Src1, Dest, length, C)
266 unsigned char *Src1
267 unsigned char *Dest
268 int length
269 unsigned char C
270 CODE:
271 RETVAL = SDL_imageFilterAddByte(Src1, Dest, length, C);
272 OUTPUT:
273 RETVAL</p>
274
275</div>
276<h2 id="add_uint">add_uint</h2>
277<div id="add_uint_CONTENT">
278<p>int
279gfx_image_add_uint(Src1, Dest, length, C)
280 unsigned char *Src1
281 unsigned char *Dest
282 int length
283 unsigned int C
284 CODE:
285 RETVAL = SDL_imageFilterAddUint(Src1, Dest, length, C);
286 OUTPUT:
287 RETVAL</p>
288
289</div>
290<h2 id="add_byte_to_half">add_byte_to_half</h2>
291<div id="add_byte_to_half_CONTENT">
292<p>int
293gfx_image_add_byte_to_half(Src1, Dest, length, C)
294 unsigned char *Src1
295 unsigned char *Dest
296 int length
297 unsigned char C
298 CODE:
299 RETVAL = SDL_imageFilterAddByteToHalf(Src1, Dest, length, C);
300 OUTPUT:
301 RETVAL</p>
302
303</div>
304<h2 id="sub_byte">sub_byte</h2>
305<div id="sub_byte_CONTENT">
306<p>int
307gfx_image_sub_byte(Src1, Dest, length, C)
308 unsigned char *Src1
309 unsigned char *Dest
310 int length
311 unsigned char C
312 CODE:
313 RETVAL = SDL_imageFilterSubByte(Src1, Dest, length, C);
314 OUTPUT:
315 RETVAL</p>
316
317</div>
318<h2 id="sub_uint">sub_uint</h2>
319<div id="sub_uint_CONTENT">
320<p>int
321gfx_image_sub_uint(Src1, Dest, length, C)
322 unsigned char *Src1
323 unsigned char *Dest
324 int length
325 unsigned int C
326 CODE:
327 RETVAL = SDL_imageFilterSubUint(Src1, Dest, length, C);
328 OUTPUT:
329 RETVAL</p>
330
331</div>
332<h2 id="shift_right">shift_right</h2>
333<div id="shift_right_CONTENT">
334<p>int
335gfx_image_shift_right(Src1, Dest, length, N)
336 unsigned char *Src1
337 unsigned char *Dest
338 int length
339 unsigned char N
340 CODE:
341 RETVAL = SDL_imageFilterShiftRight(Src1, Dest, length, N);
342 OUTPUT:
343 RETVAL</p>
344
345</div>
346<h2 id="shift_right_uint">shift_right_uint</h2>
347<div id="shift_right_uint_CONTENT">
348<p>int
349gfx_image_shift_right_uint(Src1, Dest, length, N)
350 unsigned char *Src1
351 unsigned char *Dest
352 int length
353 unsigned char N
354 CODE:
355 RETVAL = SDL_imageFilterShiftRightUint(Src1, Dest, length, N);
356 OUTPUT:
357 RETVAL</p>
358
359</div>
360<h2 id="mult_by_byte">mult_by_byte</h2>
361<div id="mult_by_byte_CONTENT">
362<p>int
363gfx_image_mult_by_byte(Src1, Dest, length, C)
364 unsigned char *Src1
365 unsigned char *Dest
366 int length
367 unsigned char C
368 CODE:
369 RETVAL = SDL_imageFilterMultByByte(Src1, Dest, length, C);
370 OUTPUT:
371 RETVAL</p>
372
373</div>
374<h2 id="shift_right_and_mult_by_byte">shift_right_and_mult_by_byte</h2>
375<div id="shift_right_and_mult_by_byte_CONTENT">
376<p>int
377gfx_image_shift_right_and_mult_by_byte(Src1, Dest, length, N, C)
378 unsigned char *Src1
379 unsigned char *Dest
380 int length
381 unsigned char N
382 unsigned char C
383 CODE:
384 RETVAL = SDL_imageFilterShiftRightAndMultByByte(Src1, Dest, length, N, C);
385 OUTPUT:
386 RETVAL</p>
387
388</div>
389<h2 id="shift_left_byte">shift_left_byte</h2>
390<div id="shift_left_byte_CONTENT">
391<p>int
392gfx_image_shift_left_byte(Src1, Dest, length, N)
393 unsigned char *Src1
394 unsigned char *Dest
395 int length
396 unsigned char N
397 CODE:
398 RETVAL = SDL_imageFilterShiftLeftByte(Src1, Dest, length, N);
399 OUTPUT:
400 RETVAL</p>
401
402</div>
403<h2 id="shift_left_uint">shift_left_uint</h2>
404<div id="shift_left_uint_CONTENT">
405<p>int
406gfx_image_shift_left_uint(Src1, Dest, length, N)
407 unsigned char *Src1
408 unsigned char *Dest
409 int length
410 unsigned char N
411 CODE:
412 RETVAL = SDL_imageFilterShiftLeftUint(Src1, Dest, length, N);
413 OUTPUT:
414 RETVAL</p>
415
416</div>
417<h2 id="shift_left">shift_left</h2>
418<div id="shift_left_CONTENT">
419<p>int
420gfx_image_shift_left(Src1, Dest, length, N)
421 unsigned char *Src1
422 unsigned char *Dest
423 int length
424 unsigned char N
425 CODE:
426 RETVAL = SDL_imageFilterShiftLeft(Src1, Dest, length, N);
427 OUTPUT:
428 RETVAL</p>
429
430</div>
431<h2 id="binarize_using_threshold">binarize_using_threshold</h2>
432<div id="binarize_using_threshold_CONTENT">
433<p>int
434gfx_image_binarize_using_threshold(Src1, Dest, length, T)
435 unsigned char *Src1
436 unsigned char *Dest
437 int length
438 unsigned char T
439 CODE:
440 RETVAL = SDL_imageFilterBinarizeUsingThreshold(Src1, Dest, length, T);
441 OUTPUT:
442 RETVAL</p>
443
444</div>
445<h2 id="clip_to_range">clip_to_range</h2>
446<div id="clip_to_range_CONTENT">
447<p>int
448gfx_image_clip_to_range(Src1, Dest, length, Tmin, Tmax)
449 unsigned char *Src1
450 unsigned char *Dest
451 int length
452 unsigned char Tmin
453 unsigned char Tmax
454 CODE:
455 RETVAL = SDL_imageFilterClipToRange(Src1, Dest, length, Tmin, Tmax);
456 OUTPUT:
457 RETVAL</p>
458
459</div>
460<h2 id="normalize_linear">normalize_linear</h2>
461<div id="normalize_linear_CONTENT">
462<p>int
463gfx_image_normalize_linear(Src1, Dest, length, Cmin, Cmax, Nmin, Nmax)
464 unsigned char *Src1
465 unsigned char *Dest
466 int length
467 int Cmin
468 int Cmax
469 int Nmin
470 int Nmax
471 CODE:
472 RETVAL = SDL_imageFilterNormalizeLinear(Src1, Dest, length, Cmin, Cmax, Nmin, Nmax);
473 OUTPUT:
474 RETVAL</p>
475
476</div>
477<h2 id="convolve_kernel_3x3_divide">convolve_kernel_3x3_divide</h2>
478<div id="convolve_kernel_3x3_divide_CONTENT">
479<p>int
480gfx_image_convolve_kernel_3x3_divide(Src, Dest, rows, columns, Kernel, Divisor)
481 unsigned char *Src
482 unsigned char *Dest
483 int rows
484 int columns
485 Sint16 *Kernel
486 unsigned char Divisor
487 CODE:
488 RETVAL = SDL_imageFilterConvolveKernel3x3Divide(Src, Dest, rows, columns, Kernel, Divisor);
489 OUTPUT:
490 RETVAL</p>
491
492</div>
493<h2 id="convolve_kernel_5x5_divide">convolve_kernel_5x5_divide</h2>
494<div id="convolve_kernel_5x5_divide_CONTENT">
495<p>int
496gfx_image_convolve_kernel_5x5_divide(Src, Dest, rows, columns, Kernel, Divisor)
497 unsigned char *Src
498 unsigned char *Dest
499 int rows
500 int columns
501 Sint16 *Kernel
502 unsigned char Divisor
503 CODE:
504 RETVAL = SDL_imageFilterConvolveKernel5x5Divide(Src, Dest, rows, columns, Kernel, Divisor);
505 OUTPUT:
506 RETVAL</p>
507
508</div>
509<h2 id="convolve_kernel_7x7_divide">convolve_kernel_7x7_divide</h2>
510<div id="convolve_kernel_7x7_divide_CONTENT">
511<p>int
512gfx_image_convolve_kernel_7x7_divide(Src, Dest, rows, columns, Kernel, Divisor)
513 unsigned char *Src
514 unsigned char *Dest
515 int rows
516 int columns
517 Sint16 *Kernel
518 unsigned char Divisor
519 CODE:
520 RETVAL = SDL_imageFilterConvolveKernel7x7Divide(Src, Dest, rows, columns, Kernel, Divisor);
521 OUTPUT:
522 RETVAL</p>
523
524</div>
525<h2 id="convolve_kernel_9x9_divide">convolve_kernel_9x9_divide</h2>
526<div id="convolve_kernel_9x9_divide_CONTENT">
527<p>int
528gfx_image_convolve_kernel_9x9_divide(Src, Dest, rows, columns, Kernel, Divisor)
529 unsigned char *Src
530 unsigned char *Dest
531 int rows
532 int columns
533 Sint16 *Kernel
534 unsigned char Divisor
535 CODE:
536 RETVAL = SDL_imageFilterConvolveKernel9x9Divide(Src, Dest, rows, columns, Kernel, Divisor);
537 OUTPUT:
538 RETVAL</p>
539
540</div>
541<h2 id="convolve_kernel_3x3_shift_right">convolve_kernel_3x3_shift_right</h2>
542<div id="convolve_kernel_3x3_shift_right_CONT">
543<p>int
544gfx_image_convolve_kernel_3x3_shift_right(Src, Dest, rows, columns, Kernel, NRightShift)
545 unsigned char *Src
546 unsigned char *Dest
547 int rows
548 int columns
549 Sint16 *Kernel
550 unsigned char NRightShift
551 CODE:
552 RETVAL = SDL_imageFilterConvolveKernel3x3ShiftRight(Src, Dest, rows, columns, Kernel, NRightShift);
553 OUTPUT:
554 RETVAL</p>
555
556</div>
557<h2 id="convolve_kernel_5x5_shift_right">convolve_kernel_5x5_shift_right</h2>
558<div id="convolve_kernel_5x5_shift_right_CONT">
559<p>int
560gfx_image_convolve_kernel_5x5_shift_right(Src, Dest, rows, columns, Kernel, NRightShift)
561 unsigned char *Src
562 unsigned char *Dest
563 int rows
564 int columns
565 Sint16 *Kernel
566 unsigned char NRightShift
567 CODE:
568 RETVAL = SDL_imageFilterConvolveKernel5x5ShiftRight(Src, Dest, rows, columns, Kernel, NRightShift);
569 OUTPUT:
570 RETVAL</p>
571
572</div>
573<h2 id="convolve_kernel_7x7_shift_right">convolve_kernel_7x7_shift_right</h2>
574<div id="convolve_kernel_7x7_shift_right_CONT">
575<p>int
576gfx_image_convolve_kernel_7x7_shift_right(Src, Dest, rows, columns, Kernel, NRightShift)
577 unsigned char *Src
578 unsigned char *Dest
579 int rows
580 int columns
581 Sint16 *Kernel
582 unsigned char NRightShift
583 CODE:
584 RETVAL = SDL_imageFilterConvolveKernel7x7ShiftRight(Src, Dest, rows, columns, Kernel, NRightShift);
585 OUTPUT:
586 RETVAL</p>
587
588</div>
589<h2 id="convolve_kernel_9x9_shift_right">convolve_kernel_9x9_shift_right</h2>
590<div id="convolve_kernel_9x9_shift_right_CONT">
591<p>int
592gfx_image_convolve_kernel_9x9_shift_right(Src, Dest, rows, columns, Kernel, NRightShift)
593 unsigned char *Src
594 unsigned char *Dest
595 int rows
596 int columns
597 Sint16 *Kernel
598 unsigned char NRightShift
599 CODE:
600 RETVAL = SDL_imageFilterConvolveKernel9x9ShiftRight(Src, Dest, rows, columns, Kernel, NRightShift);
601 OUTPUT:
602 RETVAL</p>
603
604</div>
605<h2 id="sobel_x">sobel_x</h2>
606<div id="sobel_x_CONTENT">
607<p>int
608gfx_image_sobel_x(Src, Dest, rows, columns)
609 unsigned char *Src
610 unsigned char *Dest
611 int rows
612 int columns
613 CODE:
614 RETVAL = SDL_imageFilterSobelX(Src, Dest, rows, columns);
615 OUTPUT:
616 RETVAL</p>
617
618</div>
619<h2 id="sobel_x_shift_right">sobel_x_shift_right</h2>
620<div id="sobel_x_shift_right_CONTENT">
621<p>int
622gfx_image_sobel_x_shift_right(Src, Dest, rows, columns, NRightShift)
623 unsigned char *Src
624 unsigned char *Dest
625 int rows
626 int columns
627 unsigned char NRightShift
628 CODE:
629 RETVAL = SDL_imageFilterSobelXShiftRight(Src, Dest, rows, columns, NRightShift);
630 OUTPUT:
631 RETVAL</p>
632
633</div>
634<h2 id="align_stack">align_stack</h2>
635<div id="align_stack_CONTENT">
636<p>void
637gfx_image_align_stack()
638 CODE:
639 SDL_imageFilterAlignStack();</p>
640
641</div>
642<h2 id="restore_stack">restore_stack</h2>
643<div id="restore_stack_CONTENT">
644<p>void
645gfx_image_restore_stack()
646 CODE:
d5943b68 647 SDL_imageFilterRestoreStack();</p>
648
649
650
651
652
653</div>
654<h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
655<div id="AUTHORS_CONTENT">
656<p>See <b>AUTHORS</b> in <cite>SDL</cite>.</p>
cf23a5da 657
658</div>
659</div>
Unnamed repository; edit this file to name it for gitweb.