Add SDL_HINT_AUDIO_DEVICE_APP_ICON_NAME

This commit is contained in:
Thomas J Faughnan Jr 2024-05-11 13:32:40 -04:00 committed by Ryan C. Gordon
parent 8bd0433966
commit ad166be1c5
3 changed files with 55 additions and 7 deletions

View file

@ -292,6 +292,28 @@ extern "C" {
*/
#define SDL_HINT_AUDIO_DEVICE_APP_NAME "SDL_AUDIO_DEVICE_APP_NAME"
/**
* Specify an application icon name for an audio device.
*
* Some audio backends (such as Pulseaudio and Pipewire) allow you to set an
* XDG icon name for your application. Among other things, this icon might show
* up in a system control panel that lets the user adjust the volume on specific
* audio streams instead of using one giant master volume slider. Note that this
* is unrelated to the icon used by the windowing system, which may be set with
* SDL_SetWindowIcon (or via desktop file on Wayland).
*
* Setting this to "" or leaving it unset will have SDL use a reasonable
* default, "applications-games", which is likely to be installed.
* See https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
* and https://specifications.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
* for the relevant XDG icon specs.
*
* This hint should be set before an audio device is opened.
*
* \since This hint is available since SDL 3.0.0.
*/
#define SDL_HINT_AUDIO_DEVICE_APP_ICON_NAME "SDL_AUDIO_DEVICE_APP_ICON_NAME"
/**
* A variable controlling device buffer size.
*