(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetHint

Set a hint with normal priority.

Header File

Syntax

bool SDL_SetHint(const char *name, const char *value);

Function Parameters

const char *	name	the hint to set.
const char *	value	the value of the hint variable.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Hints will not be set if there is an existing override hint or environment variable that takes precedence. You can use SDL_SetHintWithPriority() to set the hint with override priority instead.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.

Code Examples

#include <SDL3/SDL.h>
#include <SDL3/SDL_main.h>

int main(int argc, char* argv[])
{
    // Each hint describes when it should be set, this one should be set before SDL is initialized.
    SDL_SetHint(SDL_HINT_APP_NAME, "My Game 2: The Revenge");

    SDL_Init(SDL_INIT_VIDEO);

    // ...

    SDL_Quit();
    return 0;
}