Scroll to navigation

SDL_GetHint(3) SDL3 FUNCTIONS SDL_GetHint(3)

NAME

SDL_GetHint - Get the value of a hint.

HEADER FILE

Defined in SDL3/SDL_hints.h

SYNOPSIS

#include "SDL3/SDL.h"
const char* SDL_GetHint(const char *name);

FUNCTION PARAMETERS

the hint to query.

RETURN VALUE

Returns the string value of a hint or NULL if the hint isn't set.

THREAD SAFETY

It is safe to call this function from any thread, however the return value only remains valid until the hint is changed; if another thread might do so, the app should supply locks and/or make a copy of the string. Note that using a hint callback instead is always thread-safe, as SDL holds a lock on the thread subsystem during the callback.

AVAILABILITY

This function is available since SDL 3.0.0.

SEE ALSO

(3), SDL_SetHint(3), (3), SDL_SetHintWithPriority(3)

SDL 3.1.3 Simple Directmedia Layer