Miguel Ruiz / SDL_lib

SDL standard library

Dependents:   H261_encoder

SDL_test_compare.h@0:dda4f4550403, 2016-09-07 (annotated)

Committer:
miruga27
Date:
Wed Sep 07 18:46:53 2016 +0000
Revision:
0:dda4f4550403
7/09/2016;

Who changed what in which revision?

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