SDL_SetError

Set the SDL error message for the current thread.

Header File

bool SDL_SetError(const char *fmt, ...);

const char *	fmt	a printf()-style message format string.
...	...	additional parameters matching % tokens in the `fmt` string, if any.

(bool) Returns false.

Calling this function will replace any previous error message that was set.

This function always returns false, since SDL frequently uses false to signify a failing result, leading to this idiom:

if (error_code) {
    return SDL_SetError("This operation has failed: %d", error_code);
}

It is safe to call this function from any thread.

This function is available since SDL 3.1.3.