SDL_test_compare.h

00001 /*
00002   Simple DirectMedia Layer
00003   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
00004 
00005   This software is provided 'as-is', without any express or implied
00006   warranty.  In no event will the authors be held liable for any damages
00007   arising from the use of this software.
00008 
00009   Permission is granted to anyone to use this software for any purpose,
00010   including commercial applications, and to alter it and redistribute it
00011   freely, subject to the following restrictions:
00012 
00013   1. The origin of this software must not be misrepresented; you must not
00014      claim that you wrote the original software. If you use this software
00015      in a product, an acknowledgment in the product documentation would be
00016      appreciated but is not required.
00017   2. Altered source versions must be plainly marked as such, and must not be
00018      misrepresented as being the original software.
00019   3. This notice may not be removed or altered from any source distribution.
00020 */
00021 
00022 /**
00023  *  \file SDL_test_compare.h
00024  *
00025  *  Include file for SDL test framework.
00026  *
00027  *  This code is a part of the SDL2_test library, not the main SDL library.
00028  */
00029 
00030 /*
00031 
00032  Defines comparison functions (i.e. for surfaces).
00033 
00034 */
00035 
00036 #ifndef _SDL_test_compare_h
00037 #define _SDL_test_compare_h
00038 
00039 #include "SDL.h"
00040 
00041 #include "SDL_test_images.h"
00042 
00043 #include "begin_code.h"
00044 /* Set up for C function definitions, even when using C++ */
00045 #ifdef __cplusplus
00046 extern "C" {
00047 #endif
00048 
00049 /**
00050  * \brief Compares a surface and with reference image data for equality
00051  *
00052  * \param surface Surface used in comparison
00053  * \param referenceSurface Test Surface used in comparison
00054  * \param allowable_error Allowable difference (squared) in blending accuracy.
00055  *
00056  * \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.
00057  */
00058 int SDLTest_CompareSurfaces(SDL_Surface *surface, SDL_Surface *referenceSurface, int allowable_error);
00059 
00060 
00061 /* Ends C function definitions when using C++ */
00062 #ifdef __cplusplus
00063 }
00064 #endif
00065 #include "close_code.h"
00066 
00067 #endif /* _SDL_test_compare_h */
00068 
00069 /* vi: set ts=4 sw=4 expandtab: */