Function SDL_InvalidParamError

pub unsafe fn SDL_InvalidParamError(param: *const i8) -> bool

Available on crate feature dep_sdl3 only.

A macro to standardize error reporting on unsupported operations.

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.