SDL_CreateTray

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

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.

extern (C) nothrow @nogc extern
SDL_CreateTray
(,
const(char)* tooltip
)

Parameters

icon SDL_Surface*

A surface to be used as icon. May be null.

tooltip const(char)*

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

Type: SDL_Tray*

The newly created system tray icon.

Threadsafety: This function should only be called on the main thread.

See Also

Meta