devela::_dep::sdl3::sys::tray

Function SDL_CreateTray

pub unsafe extern "C" fn SDL_CreateTray(
    icon: *mut SDL_Surface,
    tooltip: *const i8,
) -> *mut SDL_Tray
Available on crate feature dep_sdl3 only.
Expand description

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.

§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

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.

§See also