include/SDL_test_compare.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 04 Jan 2019 22:01:14 -0800
changeset 12503 806492103856
parent 11811 5d94cb6b24d3
permissions -rw-r--r--
Updated copyright for 2019
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_test_compare.h
    24  *
    25  *  Include file for SDL test framework.
    26  *
    27  *  This code is a part of the SDL2_test library, not the main SDL library.
    28  */
    29 
    30 /*
    31 
    32  Defines comparison functions (i.e. for surfaces).
    33 
    34 */
    35 
    36 #ifndef SDL_test_compare_h_
    37 #define SDL_test_compare_h_
    38 
    39 #include "SDL.h"
    40 
    41 #include "SDL_test_images.h"
    42 
    43 #include "begin_code.h"
    44 /* Set up for C function definitions, even when using C++ */
    45 #ifdef __cplusplus
    46 extern "C" {
    47 #endif
    48 
    49 /**
    50  * \brief Compares a surface and with reference image data for equality
    51  *
    52  * \param surface Surface used in comparison
    53  * \param referenceSurface Test Surface used in comparison
    54  * \param allowable_error Allowable difference (=sum of squared difference for each RGB component) in blending accuracy.
    55  *
    56  * \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.
    57  */
    58 int SDLTest_CompareSurfaces(SDL_Surface *surface, SDL_Surface *referenceSurface, int allowable_error);
    59 
    60 
    61 /* Ends C function definitions when using C++ */
    62 #ifdef __cplusplus
    63 }
    64 #endif
    65 #include "close_code.h"
    66 
    67 #endif /* SDL_test_compare_h_ */
    68 
    69 /* vi: set ts=4 sw=4 expandtab: */