Miguel Ruiz / SDL_lib2

SDL Library

Dependents:   H261_decoder

SDL_test_compare.h@0:7fb6877b5d7c, 2016-09-22 (annotated)

Committer:
miruga27
Date:
Thu Sep 22 00:03:09 2016 +0000
Revision:
0:7fb6877b5d7c
SDL

Who changed what in which revision?

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