include/SDL_test_compare.h
changeset 6772 5229a117ef97
parent 6763 9cbd31a3450b
child 6885 700f1b25f77f
     1.1 --- a/include/SDL_test_compare.h	Sat Dec 22 20:43:51 2012 -0800
     1.2 +++ b/include/SDL_test_compare.h	Mon Dec 24 14:43:57 2012 -0800
     1.3 @@ -37,6 +37,7 @@
     1.4  #define _SDL_test_compare_h
     1.5  
     1.6  #include "SDL.h"
     1.7 +
     1.8  #include "SDL_test_images.h"
     1.9  
    1.10  #include "begin_code.h"
    1.11 @@ -50,13 +51,13 @@
    1.12  /**
    1.13   * \brief Compares a surface and with reference image data for equality
    1.14   *
    1.15 - * \param sur Surface used in comparison
    1.16 - * \param img Test Surface used in comparison
    1.17 - * \param allowable_error Allowable difference in blending accuracy
    1.18 + * \param surface Surface used in comparison
    1.19 + * \param referenceSurface Test Surface used in comparison
    1.20 + * \param allowable_error Allowable difference (squared) in blending accuracy.
    1.21   *
    1.22 - * \returns 0 if comparison succeeded, >0 (=number of pixels where comparison failed) if comparison failed, <0 for any other error.
    1.23 + * \returns 0 if comparison succeeded, >0 (=number of pixels where comparison failed) if comparison failed, -1 if any of the surfaces were NULL, -2 if the surface sizes differ.
    1.24   */
    1.25 -int SDLTest_CompareSurfaces(SDL_Surface *sur, SDL_Surface *img, int allowable_error);
    1.26 +int SDLTest_CompareSurfaces(SDL_Surface *surface, SDL_Surface *referenceSurface, int allowable_error);
    1.27        
    1.28  
    1.29  /* Ends C function definitions when using C++ */