1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2025 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 * Comparison function of SDL test framework.
24 *
25 * This code is a part of the SDL test library, not the main SDL library.
26 */
27
28/*
29
30 Defines comparison functions (i.e. for surfaces).
31
32*/
33
34#ifndef SDL_test_compare_h_
35#define SDL_test_compare_h_
36
37#include <SDL3/SDL.h>
38
39#include <SDL3/SDL_begin_code.h>
40/* Set up for C function definitions, even when using C++ */
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45/**
46 * Compares a surface and with reference image data for equality
47 *
48 * \param surface Surface used in comparison
49 * \param referenceSurface Test Surface used in comparison
50 * \param allowable_error Allowable difference (=sum of squared difference for each RGB component) in blending accuracy.
51 *
52 * \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.
53 */
54int SDLCALL SDLTest_CompareSurfaces(SDL_Surface *surface, SDL_Surface *referenceSurface, int allowable_error);
55
56/**
57 * Compares 2 memory blocks for equality
58 *
59 * \param actual Memory used in comparison, displayed on the left
60 * \param size_actual Size of actual in bytes
61 * \param reference Reference memory, displayed on the right
62 * \param size_reference Size of reference in bytes
63 *
64 * \returns 0 if the left and right memory block are equal, non-zero if they are non-equal.
65 *
66 * \since This function is available since SDL 3.2.0.
67 */
68int SDLCALL SDLTest_CompareMemory(const void *actual, size_t size_actual, const void *reference, size_t size_reference);
69
70/* Ends C function definitions when using C++ */
71#ifdef __cplusplus
72}
73#endif
74#include <SDL3/SDL_close_code.h>
75
76#endif /* SDL_test_compare_h_ */
77