.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "pods::SDL::GFX::ImageFilter 3pm" .TH pods::SDL::GFX::ImageFilter 3pm "2020-11-09" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" SDL::GFX::ImageFilter \- image filtering functions .SH "CATEGORY" .IX Header "CATEGORY" \&\s-1TODO, GFX\s0 .SH "METHODS" .IX Header "METHODS" .SS "MMX_detect" .IX Subsection "MMX_detect" int \&\fBgfx_image_MMX_detect()\fR \s-1CODE:\s0 \fBSDL_imageFilterMMXdetect()\fR; .SS "MMX_off" .IX Subsection "MMX_off" void \&\fBgfx_image_MMX_off()\fR \s-1CODE:\s0 \fBSDL_imageFilterMMXoff()\fR; .SS "MMX_on" .IX Subsection "MMX_on" void \&\fBgfx_image_MMX_on()\fR \s-1CODE:\s0 \fBSDL_imageFilterMMXon()\fR; .SS "add" .IX Subsection "add" int gfx_image_add(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterAdd(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "mean" .IX Subsection "mean" int gfx_image_mean(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterMean(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "sub" .IX Subsection "sub" int gfx_image_sub(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterSub(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "abs_diff" .IX Subsection "abs_diff" int gfx_image_abs_diff(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterAbsDiff(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "mult" .IX Subsection "mult" int gfx_image_mult(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterMult(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "mult_nor" .IX Subsection "mult_nor" int gfx_image_mult_nor(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterMultNor(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "mult_div_by_2" .IX Subsection "mult_div_by_2" int gfx_image_mult_div_by_2(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterMultDivby2(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "mult_div_by_4" .IX Subsection "mult_div_by_4" int gfx_image_mult_div_by_4(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterMultDivby4(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "bit_and" .IX Subsection "bit_and" int gfx_image_bit_and(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterBitAnd(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "bit_or" .IX Subsection "bit_or" int gfx_image_bit_or(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterBitOr(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "div" .IX Subsection "div" int gfx_image_div(Src1, Src2, Dest, length) unsigned char *Src1 unsigned char *Src2 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterDiv(Src1, Src2, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "bit_negation" .IX Subsection "bit_negation" int gfx_image_bit_negation(Src1, Dest, length) unsigned char *Src1 unsigned char *Dest int length \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterBitNegation(Src1, Dest, length); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "add_byte" .IX Subsection "add_byte" int gfx_image_add_byte(Src1, Dest, length, C) unsigned char *Src1 unsigned char *Dest int length unsigned char C \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterAddByte(Src1, Dest, length, C); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "add_uint" .IX Subsection "add_uint" int gfx_image_add_uint(Src1, Dest, length, C) unsigned char *Src1 unsigned char *Dest int length unsigned int C \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterAddUint(Src1, Dest, length, C); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "add_byte_to_half" .IX Subsection "add_byte_to_half" int gfx_image_add_byte_to_half(Src1, Dest, length, C) unsigned char *Src1 unsigned char *Dest int length unsigned char C \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterAddByteToHalf(Src1, Dest, length, C); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "sub_byte" .IX Subsection "sub_byte" int gfx_image_sub_byte(Src1, Dest, length, C) unsigned char *Src1 unsigned char *Dest int length unsigned char C \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterSubByte(Src1, Dest, length, C); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "sub_uint" .IX Subsection "sub_uint" int gfx_image_sub_uint(Src1, Dest, length, C) unsigned char *Src1 unsigned char *Dest int length unsigned int C \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterSubUint(Src1, Dest, length, C); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "shift_right" .IX Subsection "shift_right" int gfx_image_shift_right(Src1, Dest, length, N) unsigned char *Src1 unsigned char *Dest int length unsigned char N \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterShiftRight(Src1, Dest, length, N); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "shift_right_uint" .IX Subsection "shift_right_uint" int gfx_image_shift_right_uint(Src1, Dest, length, N) unsigned char *Src1 unsigned char *Dest int length unsigned char N \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterShiftRightUint(Src1, Dest, length, N); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "mult_by_byte" .IX Subsection "mult_by_byte" int gfx_image_mult_by_byte(Src1, Dest, length, C) unsigned char *Src1 unsigned char *Dest int length unsigned char C \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterMultByByte(Src1, Dest, length, C); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "shift_right_and_mult_by_byte" .IX Subsection "shift_right_and_mult_by_byte" int gfx_image_shift_right_and_mult_by_byte(Src1, Dest, length, N, C) unsigned char *Src1 unsigned char *Dest int length unsigned char N unsigned char C \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterShiftRightAndMultByByte(Src1, Dest, length, N, C); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "shift_left_byte" .IX Subsection "shift_left_byte" int gfx_image_shift_left_byte(Src1, Dest, length, N) unsigned char *Src1 unsigned char *Dest int length unsigned char N \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterShiftLeftByte(Src1, Dest, length, N); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "shift_left_uint" .IX Subsection "shift_left_uint" int gfx_image_shift_left_uint(Src1, Dest, length, N) unsigned char *Src1 unsigned char *Dest int length unsigned char N \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterShiftLeftUint(Src1, Dest, length, N); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "shift_left" .IX Subsection "shift_left" int gfx_image_shift_left(Src1, Dest, length, N) unsigned char *Src1 unsigned char *Dest int length unsigned char N \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterShiftLeft(Src1, Dest, length, N); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "binarize_using_threshold" .IX Subsection "binarize_using_threshold" int gfx_image_binarize_using_threshold(Src1, Dest, length, T) unsigned char *Src1 unsigned char *Dest int length unsigned char T \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterBinarizeUsingThreshold(Src1, Dest, length, T); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "clip_to_range" .IX Subsection "clip_to_range" int gfx_image_clip_to_range(Src1, Dest, length, Tmin, Tmax) unsigned char *Src1 unsigned char *Dest int length unsigned char Tmin unsigned char Tmax \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterClipToRange(Src1, Dest, length, Tmin, Tmax); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "normalize_linear" .IX Subsection "normalize_linear" int gfx_image_normalize_linear(Src1, Dest, length, Cmin, Cmax, Nmin, Nmax) unsigned char *Src1 unsigned char *Dest int length int Cmin int Cmax int Nmin int Nmax \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterNormalizeLinear(Src1, Dest, length, Cmin, Cmax, Nmin, Nmax); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "convolve_kernel_3x3_divide" .IX Subsection "convolve_kernel_3x3_divide" int gfx_image_convolve_kernel_3x3_divide(Src, Dest, rows, columns, Kernel, Divisor) unsigned char *Src unsigned char *Dest int rows int columns Sint16 *Kernel unsigned char Divisor \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterConvolveKernel3x3Divide(Src, Dest, rows, columns, Kernel, Divisor); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "convolve_kernel_5x5_divide" .IX Subsection "convolve_kernel_5x5_divide" int gfx_image_convolve_kernel_5x5_divide(Src, Dest, rows, columns, Kernel, Divisor) unsigned char *Src unsigned char *Dest int rows int columns Sint16 *Kernel unsigned char Divisor \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterConvolveKernel5x5Divide(Src, Dest, rows, columns, Kernel, Divisor); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "convolve_kernel_7x7_divide" .IX Subsection "convolve_kernel_7x7_divide" int gfx_image_convolve_kernel_7x7_divide(Src, Dest, rows, columns, Kernel, Divisor) unsigned char *Src unsigned char *Dest int rows int columns Sint16 *Kernel unsigned char Divisor \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterConvolveKernel7x7Divide(Src, Dest, rows, columns, Kernel, Divisor); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "convolve_kernel_9x9_divide" .IX Subsection "convolve_kernel_9x9_divide" int gfx_image_convolve_kernel_9x9_divide(Src, Dest, rows, columns, Kernel, Divisor) unsigned char *Src unsigned char *Dest int rows int columns Sint16 *Kernel unsigned char Divisor \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterConvolveKernel9x9Divide(Src, Dest, rows, columns, Kernel, Divisor); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "convolve_kernel_3x3_shift_right" .IX Subsection "convolve_kernel_3x3_shift_right" int gfx_image_convolve_kernel_3x3_shift_right(Src, Dest, rows, columns, Kernel, NRightShift) unsigned char *Src unsigned char *Dest int rows int columns Sint16 *Kernel unsigned char NRightShift \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterConvolveKernel3x3ShiftRight(Src, Dest, rows, columns, Kernel, NRightShift); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "convolve_kernel_5x5_shift_right" .IX Subsection "convolve_kernel_5x5_shift_right" int gfx_image_convolve_kernel_5x5_shift_right(Src, Dest, rows, columns, Kernel, NRightShift) unsigned char *Src unsigned char *Dest int rows int columns Sint16 *Kernel unsigned char NRightShift \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterConvolveKernel5x5ShiftRight(Src, Dest, rows, columns, Kernel, NRightShift); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "convolve_kernel_7x7_shift_right" .IX Subsection "convolve_kernel_7x7_shift_right" int gfx_image_convolve_kernel_7x7_shift_right(Src, Dest, rows, columns, Kernel, NRightShift) unsigned char *Src unsigned char *Dest int rows int columns Sint16 *Kernel unsigned char NRightShift \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterConvolveKernel7x7ShiftRight(Src, Dest, rows, columns, Kernel, NRightShift); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "convolve_kernel_9x9_shift_right" .IX Subsection "convolve_kernel_9x9_shift_right" int gfx_image_convolve_kernel_9x9_shift_right(Src, Dest, rows, columns, Kernel, NRightShift) unsigned char *Src unsigned char *Dest int rows int columns Sint16 *Kernel unsigned char NRightShift \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterConvolveKernel9x9ShiftRight(Src, Dest, rows, columns, Kernel, NRightShift); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "sobel_x" .IX Subsection "sobel_x" int gfx_image_sobel_x(Src, Dest, rows, columns) unsigned char *Src unsigned char *Dest int rows int columns \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterSobelX(Src, Dest, rows, columns); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "sobel_x_shift_right" .IX Subsection "sobel_x_shift_right" int gfx_image_sobel_x_shift_right(Src, Dest, rows, columns, NRightShift) unsigned char *Src unsigned char *Dest int rows int columns unsigned char NRightShift \s-1CODE:\s0 \s-1RETVAL\s0 = SDL_imageFilterSobelXShiftRight(Src, Dest, rows, columns, NRightShift); \s-1OUTPUT:\s0 \s-1RETVAL\s0 .SS "align_stack" .IX Subsection "align_stack" void \&\fBgfx_image_align_stack()\fR \s-1CODE:\s0 \fBSDL_imageFilterAlignStack()\fR; .SS "restore_stack" .IX Subsection "restore_stack" void \&\fBgfx_image_restore_stack()\fR \s-1CODE:\s0 \fBSDL_imageFilterRestoreStack()\fR; .SH "AUTHORS" .IX Header "AUTHORS" See \*(L"\s-1AUTHORS\*(R"\s0 in \s-1SDL\s0.