v2026.5.3
All Bundles
Bundle SDL2 multimedia library for 2D graphics, input handling, audio playback, and window management. Core types: Window, Renderer, Texture, Surface, Event, and Mixer. Compile with -lib sdl2.

Hints

Configuration management

Operations

Clear # function

Clear all hints

function : Clear() ~ Nil

Get # function

Get the value of a hint.

function : Get(name:String) ~ String

Parameters

NameTypeDescription
nameStringthe hint to query

Return

TypeDescription
Stringthe string value of a hint

Get # function

Get the boolean value of a hint variable

function : Get(name:String, value:Bool) ~ Bool

Parameters

NameTypeDescription
nameStringthe hint to query
valueBoolthe value to return if the hint does not exist

Return

TypeDescription
Boolthe boolean value of a hint or the provided default value if the hint does not exist

Set # function

Set a hint with normal priority.

function : Set(name:String, value:String) ~ Bool

Parameters

NameTypeDescription
nameStringthe hint to set; see the list of hints on CategoryHints for details
valueStringthe value of the hint variable

Return

TypeDescription
Booltrue if the hint was set, false otherwise

SetWithPriority # function

Set a hint with a specific priority

function : SetWithPriority(name:String, value:String, priority:HintPriority) ~ Bool

Parameters

NameTypeDescription
nameStringthe hint to set; see the list of hints on CategoryHints for details
valueStringthe value of the hint variable
priorityHintPrioritythe SDL_HintPriority level for the hint

Return

TypeDescription
Booltrue if the hint was set, false otherwise