SDL_InvalidParamError(3)

SDL_InvalidParamError3

A macro to standardize error reporting on unsupported operations.

Usage

#include "SDL3/SDL.h"

#define SDL_InvalidParamError(param) SDL_SetError(Parameter'%s'isinvalid",(param))

Header file

Defined in SDL3/SDL_error.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.