SDL_CreateTray(3)

SDL_CreateTray3

Create an icon to be placed in the operating system's tray, or equivalent.

Usage

#include "SDL3/SDL.h"

SDL_Tray * SDL_CreateTray(SDL_Surface *icon, const char *tooltip);

Header file

Defined in SDL3/SDL_tray.h

Overview

Many platforms advise not using a system tray unless persistence is a necessary feature. Avoid needlessly creating a tray icon, as the user may feel like it clutters their interface.

Using tray icons require the video subsystem.

Function parameters

icon

a surface to be used as icon. May be NULL.

tooltip

a tooltip to be displayed when the mouse hovers the icon in UTF-8 encoding. Not supported on all platforms. May be NULL.

Return value

( SDL_Tray
*) Returns The newly created system tray icon.

Thread safety

This function should only be called on the main thread.

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.