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