NAME¶

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

SYNOPSIS¶

#include <SDL3/SDL_tray.h>

SDL_Tray * SDL_CreateTrayWithProperties(SDL_PropertiesID props);

DESCRIPTION¶

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.

These are the supported properties:

• SDL_PROP_TRAY_CREATE_ICON_POINTER: an SDL_Surface to be used as the tray icon. May be NULL.

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

• SDL_PROP_TRAY_CREATE_USERDATA_POINTER: an optional pointer to associate with the tray, which will be passed to click callbacks. May be NULL.

• SDL_PROP_TRAY_CREATE_LEFTCLICK_CALLBACK_POINTER: an SDL_TrayClickCallback to be invoked when the tray icon is left-clicked. Not supported on all platforms. The callback should return true to show the default menu, or false to skip showing it. May be NULL.

• SDL_PROP_TRAY_CREATE_RIGHTCLICK_CALLBACK_POINTER: an SDL_TrayClickCallback to be invoked when the tray icon is right-clicked. Not supported on all platforms. The callback should return true to show the default menu, or false to skip showing it. May be NULL.

• SDL_PROP_TRAY_CREATE_MIDDLECLICK_CALLBACK_POINTER: an SDL_TrayClickCallback to be invoked when the tray icon is middle-clicked. Not supported on all platforms. May be NULL.

FUNCTION PARAMETERS¶

props

the properties to use.

RETURN VALUE¶

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.6.0.

SEE ALSO¶

SDL_CreateTray(3), SDL_CreateTrayMenu(3), SDL_GetTrayMenu(3), SDL_DestroyTray(3)