SDL_SetMemoryFunctions

Replace SDL's memory allocation functions with a custom set.

Header File

Syntax

bool SDL_SetMemoryFunctions(SDL_malloc_func malloc_func,
                            SDL_calloc_func calloc_func,
                            SDL_realloc_func realloc_func,
                            SDL_free_func free_func);

Function Parameters

SDL_malloc_func	malloc_func	custom malloc function.
SDL_calloc_func	calloc_func	custom calloc function.
SDL_realloc_func	realloc_func	custom realloc function.
SDL_free_func	free_func	custom free function.

Return Value

(bool) Returns true on success or false on failure. This only fails if there is a mix of NULL and non-NULL parameters. Failure will not set an error message (which allocates memory) so do not call SDL_GetError() in response to a failure here.

Remarks

It is not safe to call this function once any allocations have been made, as future calls to SDL_free will use the new allocator, even if they came from an SDL_malloc made with the old one!

If used, usually this needs to be the first call made into the SDL library, if not the very first thing done at program startup time.

It is legal to call this with all 4 parameters set to NULL, which will restore the original memory functions without having to query them with SDL_GetOriginalMemoryFunctions() first.

Thread Safety

It is safe to call this function from any thread, but one should not replace the memory functions once any allocations are made!

Version

This function is available since SDL 3.2.0.