SDL_InvalidParamError - A macro to standardize error reporting on unsupported operations.
Contents
Availability
This macro is available since SDL 3.2.0.
Simple Directmedia Layer SDL 3.2.20 SDL_InvalidParamError(3)
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;
}
Name
SDL_InvalidParamError - A macro to standardize error reporting on unsupported operations.
Synopsis
#include<SDL3/SDL_error.h>#defineSDL_InvalidParamError(param)SDL_SetError("Parameter'%s'isinvalid",(param))Thread Safety
It is safe to call this macro from any thread.
