include/SDL_test_compare.h
changeset 9254 6c469ea796e4
parent 8149 681eb46b8ac4
child 9619 b94b6d0bff0f
     1.1 --- a/include/SDL_test_compare.h	Sun Nov 30 22:17:12 2014 +0100
     1.2 +++ b/include/SDL_test_compare.h	Sun Nov 30 20:55:27 2014 -0800
     1.3 @@ -51,9 +51,9 @@
     1.4   *
     1.5   * \param surface Surface used in comparison
     1.6   * \param referenceSurface Test Surface used in comparison
     1.7 - * \param allowable_error Allowable difference (squared) in blending accuracy.
     1.8 + * \param allowable_error Allowable difference (=sum of squared difference for each RGB component) in blending accuracy.
     1.9   *
    1.10 - * \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.11 + * \returns 0 if comparison succeeded, >0 (=number of pixels for which the comparison failed) if comparison failed, -1 if any of the surfaces were NULL, -2 if the surface sizes differ.
    1.12   */
    1.13  int SDLTest_CompareSurfaces(SDL_Surface *surface, SDL_Surface *referenceSurface, int allowable_error);
    1.14