SDL_InvalidParamError - Man Page
A macro to standardize error reporting on unsupported operations.
Synopsis
#include <SDL3/SDL_error.h>
#define SDL_InvalidParamError(param) SDL_SetError("Parameter '%s' is invalid", (param))Description
This simply calls SDL_SetError() with a standardized error string, for convenience, consistency, and clarity.
A common usage pattern inside SDL is this:
bool MyFunction(const char *str) {
if (!str) {
return SDL_InvalidParamError("str"); // returns false.
}
DoSomething(str);
return true;
}Thread Safety
It is safe to call this macro from any thread.
Availability
This macro is available since SDL 3.2.0.
Info
SDL 3.2.24 Simple Directmedia Layer SDL3 FUNCTIONS