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 * Memory tracking related functions of SDL test framework.
24 *
25 * This code is a part of the SDL test library, not the main SDL library.
26 */
27
28#ifndef SDL_test_memory_h_
29#define SDL_test_memory_h_
30
31#include <SDL3/SDL_stdinc.h>
32
33#include <SDL3/SDL_begin_code.h>
34/* Set up for C function definitions, even when using C++ */
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39/**
40 * Start tracking SDL memory allocations
41 *
42 * \note This should be called before any other SDL functions for complete tracking coverage
43 */
44void SDLCALL SDLTest_TrackAllocations(void);
45
46/**
47 * Fill allocations with random data
48 *
49 * \note This implicitly calls SDLTest_TrackAllocations()
50 */
51void SDLCALL SDLTest_RandFillAllocations(void);
52
53/**
54 * Print a log of any outstanding allocations
55 *
56 * \note This can be called after SDL_Quit()
57 */
58void SDLCALL SDLTest_LogAllocations(void);
59
60/* Ends C function definitions when using C++ */
61#ifdef __cplusplus
62}
63#endif
64#include <SDL3/SDL_close_code.h>
65
66#endif /* SDL_test_memory_h_ */
67