(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_HINT_SCREENSAVER_INHIBIT_ACTIVITY_NAME

Specify an "activity name" for screensaver inhibition.

Header File

Defined in <SDL3/SDL_hints.h>

Syntax

#define SDL_HINT_SCREENSAVER_INHIBIT_ACTIVITY_NAME "SDL_SCREENSAVER_INHIBIT_ACTIVITY_NAME"

Remarks

Some platforms, notably Linux desktops, list the applications which are inhibiting the screensaver or other power-saving features.

This hint lets you specify the "activity name" sent to the OS when SDL_DisableScreenSaver() is used (or the screensaver is automatically disabled). The contents of this hint are used when the screensaver is disabled. You should use a string that describes what your program is doing (and, therefore, why the screensaver is disabled). For example, "Playing a game" or "Watching a video".

Setting this to "" or leaving it unset will have SDL use a reasonable default: "Playing a game" or something similar.

This hint should be set before calling SDL_DisableScreenSaver()

Version

This hint is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIMacro, CategoryHints

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.