NAME

Test::Image::GD - A module for testing images using GD

SYNOPSIS

  use Test::More plan => 1;
  use Test::Image::GD;
  
  cmp_image('test.gif', 'control.gif', '... these images should match');
  
  # or 
  
  my $test = GD::Image->new('test.gif');
  my $control = GD::Image->new('control.gif');
  cmp_image($test, $control, '... these images should match');

DESCRIPTION

This module is meant to be used for testing custom graphics, it provides only one function at the moment, which is cmp_image, and can be used to compare two images to see if they are visually similar. Future versions may include other testing functions.

FUNCTIONS

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.

Both $got and $expected can be either instances of GD::Image or either a file handle or a file path (both are valid parameters to the GD::Image constructor).

TO DO

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.

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.

CODE COVERAGE

I use Devel::Cover to test the code coverage of my tests, below is the Devel::Cover report on this module test suite.

 ---------------------------- ------ ------ ------ ------ ------ ------ ------
 File                           stmt   bran   cond    sub    pod   time  total
 ---------------------------- ------ ------ ------ ------ ------ ------ ------
 Test/Image/GD.pm              100.0  100.0   60.0  100.0  100.0  100.0   91.3
 ---------------------------- ------ ------ ------ ------ ------ ------ ------ 
 Total                         100.0  100.0   60.0  100.0  100.0  100.0   91.3
 ---------------------------- ------ ------ ------ ------ ------ ------ ------

SEE ALSO

The compare function of GD::Image class, that is how this module is implemented.

AUTHOR

Stevan Little, <stevan@iinteractive.com>

COPYRIGHT AND LICENSE

Copyright 2005 by Infinity Interactive, Inc.

http://www.iinteractive.com

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.