eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-02 01:47:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add documentation about dialogs and events

Browse source
This commit is contained in:
Semphris 2024-05-08 20:29:40 -04:00 • committed by Sam Lantinga
parent e10666397e
commit 93a0db597a
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
include/SDL3/SDL_dialog.h
View file

@ -114,6 +114,10 @@ typedef void(SDLCALL *SDL_DialogFileCallback)(void *userdata, const char * const
* Depending on the platform, the user may be allowed to input paths that
* don't yet exist.
*
* On Linux, dialogs may require XDG Portals, which requires DBus, which
* requires and event-handling loop. Apps that do not use SDL to handle events
* should add a call to SDL_PumpEvents in their main loop.
*
* \param callback An SDL_DialogFileCallback to be invoked when the user
* selects a file and accepts, or cancels the dialog, or an
* error occurs. The first argument is a null-terminated list
@ -166,6 +170,10 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowOpenFileDialog(SDL_DialogFileCallback c
*
* The chosen file may or may not already exist.
*
* On Linux, dialogs may require XDG Portals, which requires DBus, which
* requires and event-handling loop. Apps that do not use SDL to handle events
* should add a call to SDL_PumpEvents in their main loop.
*
* \param callback An SDL_DialogFileCallback to be invoked when the user
* selects a file and accepts, or cancels the dialog, or an
* error occurs. The first argument is a null-terminated list
@ -216,6 +224,10 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowSaveFileDialog(SDL_DialogFileCallback c
* Depending on the platform, the user may be allowed to input paths that
* don't yet exist.
*
* On Linux, dialogs may require XDG Portals, which requires DBus, which
* requires and event-handling loop. Apps that do not use SDL to handle events
* should add a call to SDL_PumpEvents in their main loop.
*
* \param callback An SDL_DialogFileCallback to be invoked when the user
* selects a file and accepts, or cancels the dialog, or an
* error occurs. The first argument is a null-terminated list