SDL_GetTrayEntryChecked

Gets whether or not an entry is checked.

Header File

Defined in <SDL3/SDL_tray.h>

Syntax

bool SDL_GetTrayEntryChecked(SDL_TrayEntry *entry);

Function Parameters

SDL_TrayEntry * entry the entry to be read.

Return Value

(bool) Returns true if the entry is checked; false otherwise.

Remarks

The entry must have been created with the SDL_TRAYENTRY_CHECKBOX flag.

Thread Safety

This function should be called on the thread that created the tray.

Version

This function is available since SDL 3.2.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryTray