plucky (3) SDL_GetHintBoolean.3.gz

Provided by: libsdl3-doc_3.2.4+ds-2_all bug

NAME

       SDL_GetHintBoolean - Get the boolean value of a hint variable.

HEADER FILE

       Defined in SDL3/SDL_hints.h

SYNOPSIS

       #include "SDL3/SDL.h"

       bool SDL_GetHintBoolean(const char *name, bool default_value);

FUNCTION PARAMETERS

       name   the name of the hint to get the boolean value from.

       default_value
              the value to return if the hint does not exist.

RETURN VALUE

       Returns the boolean value of a hint or the provided default value if the hint does not exist.

THREAD SAFETY

       It is safe to call this function from any thread.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       (3), SDL_GetHint(3), (3), SDL_SetHint(3)