.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "Test::Image::GD 3pm" .TH Test::Image::GD 3pm "2005-12-09" "perl v5.10.1" "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" Test::Image::GD \- A module for testing images using GD .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Test::More plan => 1; \& use Test::Image::GD; \& \& cmp_image(\*(Aqtest.gif\*(Aq, \*(Aqcontrol.gif\*(Aq, \*(Aq... these images should match\*(Aq); \& \& # or \& \& my $test = GD::Image\->new(\*(Aqtest.gif\*(Aq); \& my $control = GD::Image\->new(\*(Aqcontrol.gif\*(Aq); \& cmp_image($test, $control, \*(Aq... these images should match\*(Aq); \& \& # some other test functions ... \& \& size_ok(\*(Aqcamel.gif\*(Aq, [ 100, 350 ], \*(Aq... the image is 100 x 350"); \& \& height_ok(\*(Aqtest.gif\*(Aq, 200, \*(Aq... the image has a height of 200\*(Aq); \& width_ok(\*(Aqtest.gif\*(Aq, 200, \*(Aq... the image has a width of 200\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is meant to be used for testing custom graphics, it attempts to \*(L"visually\*(R" compare the images, this means it ignores invisible differences like color palettes and metadata. It also provides some extra functions to check the size of the image. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .ie n .IP "\fBcmp_image ($got, \fB$expected\fB, \f(BI$message\fB)\fR" 4 .el .IP "\fBcmp_image ($got, \f(CB$expected\fB, \f(CB$message\fB)\fR" 4 .IX Item "cmp_image ($got, $expected, $message)" This function will tell you whether the two images will look different, ignoring differences in the order of colors in the color palette and other invisible changes. .Sp Both \f(CW$got\fR and \f(CW$expected\fR can be either instances of \f(CW\*(C`GD::Image\*(C'\fR or either a file handle or a file path (both are valid parameters to the \&\f(CW\*(C`GD::Image\*(C'\fR constructor). .ie n .IP "\fBsize_ok ($got, [ \fB$width\fB, \f(BI$height\fB ], ?$message)\fR" 4 .el .IP "\fBsize_ok ($got, [ \f(CB$width\fB, \f(CB$height\fB ], ?$message)\fR" 4 .IX Item "size_ok ($got, [ $width, $height ], ?$message)" This function will check if an image is a certain size. .Sp As with the \f(CW\*(C`cmp_image\*(C'\fR function, the \f(CW$got\fR parameter can be either an instance of \f(CW\*(C`GD::Image\*(C'\fR or a file handle or a file path (all are valid parameters to the \f(CW\*(C`GD::Image\*(C'\fR constructor). .ie n .IP "\fBheight_ok ($got, \fB$height\fB, ?$message)\fR" 4 .el .IP "\fBheight_ok ($got, \f(CB$height\fB, ?$message)\fR" 4 .IX Item "height_ok ($got, $height, ?$message)" This function will check if an image is a certain height. .Sp As with the \f(CW\*(C`cmp_image\*(C'\fR function, the \f(CW$got\fR parameter can be either an instance of \f(CW\*(C`GD::Image\*(C'\fR or a file handle or a file path (all are valid parameters to the \f(CW\*(C`GD::Image\*(C'\fR constructor). .ie n .IP "\fBwidth_ok ($got, \fB$width\fB, ?$message)\fR" 4 .el .IP "\fBwidth_ok ($got, \f(CB$width\fB, ?$message)\fR" 4 .IX Item "width_ok ($got, $width, ?$message)" This function will check if an image is a certain width. .Sp As with the \f(CW\*(C`cmp_image\*(C'\fR function, the \f(CW$got\fR parameter can be either an instance of \f(CW\*(C`GD::Image\*(C'\fR or a file handle or a file path (all are valid parameters to the \f(CW\*(C`GD::Image\*(C'\fR constructor). .SH "TO DO" .IX Header "TO DO" .IP "Add more functions" 4 .IX Item "Add more functions" This module currently serves a very basic need of mine, however, I am sure as I start writing more tests against images I will find a need for other testing functions. Any suggestions are welcome. .SH "BUGS" .IX Header "BUGS" None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it. .SH "CODE COVERAGE" .IX Header "CODE COVERAGE" I use \fBDevel::Cover\fR to test the code coverage of my tests, below is the \&\fBDevel::Cover\fR report on this module test suite. .PP .Vb 7 \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \& File stmt bran cond sub pod time total \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \& Test/Image/GD.pm 100.0 91.7 63.6 100.0 100.0 100.0 93.7 \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \& Total 100.0 91.7 63.6 100.0 100.0 100.0 93.7 \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- \-\-\-\-\-\- .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" The \f(CW\*(C`compare\*(C'\fR function of \f(CW\*(C`GD::Image\*(C'\fR class, that is how this \f(CW\*(C`cmp_image\*(C'\fR is implemented. .SH "AUTHOR" .IX Header "AUTHOR" Stevan Little, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2005 by Infinity Interactive, Inc. .PP .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.