SDL_GetTrayEntryChecked(3)

SDL_GetTrayEntryChecked3

Gets whether or not an entry is checked.

Usage

#include "SDL3/SDL.h"

bool SDL_GetTrayEntryChecked(SDL_TrayEntry *entry);

Header file

Defined in SDL3/SDL_tray.h

Overview

The entry must have been created with the

SDL_TRAYENTRY_CHECKBOX
flag.

Function parameters

entry

the entry to be read.

Return value

Returns true if the entry is checked; false otherwise.

Thread safety

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

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.