eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-31 08:57:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

video: Document that SDL_RaiseWindow is a request and subject to window manager policy

Browse source 
The result of SDL_RaiseWindow is ultimately subject to window manager policy, particularly if the request would result in stealing focus from another window. Document that this is only a request, and if successful, will result in a focus gained event along with the input focus flag being set on the window.
This commit is contained in:
Frank Praznik 2024-07-06 11:45:04 -04:00
parent be43dec798
commit fbb5652d3e
No known key found for this signature in database
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/SDL3/SDL_video.h
View file

@ -1709,7 +1709,13 @@ extern SDL_DECLSPEC int SDLCALL SDL_ShowWindow(SDL_Window *window);
extern SDL_DECLSPEC int SDLCALL SDL_HideWindow(SDL_Window *window);
/**
* Raise a window above other windows and set the input focus.
* Request that a window be raised above other windows and gain the input focus.
*
* The result of this request is subject to desktop window manager policy,
* particularly if raising the requested window would result in stealing focus
* from another application. If the window is successfully raised and gains input
* focus, an SDL_EVENT_WINDOW_FOCUS_GAINED event will be emitted, and the window
* will have the SDL_WINDOW_INPUT_FOCUS flag set.
*
* \param window the window to raise.
* \returns 0 on success or a negative error code on failure; call