Provided by: libsdl3-doc_3.2.8+ds-1_all bug

NAME

       SDL_ShowOpenFileDialog - Displays a dialog that lets the user select a file on their filesystem.

HEADER FILE

       Defined in SDL3/SDL_dialog.h

SYNOPSIS

       #include "SDL3/SDL.h"

       void SDL_ShowOpenFileDialog(SDL_DialogFileCallback callback, void *userdata, SDL_Window *window, const SDL_DialogFileFilter *filters, int nfilters, const char *default_location, bool allow_many);

DESCRIPTION

       This  is  an  asynchronous  function;  it  will  return immediately, and the result will be passed to the
       callback.

       The callback will be invoked with a null-terminated list of files the user chose. The list will be  empty
       if the user canceled the dialog, and it will be NULL if an error occurred.

       Note that the callback may be called from a different thread than the one the function was invoked on.

       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 an event-handling loop.
       Apps that do not use SDL to handle events should add a call to SDL_PumpEvents
        in their main loop.

FUNCTION PARAMETERS

       callback
              a function pointer to be invoked when the user selects a file and accepts, or cancels the  dialog,
              or an error occurs.

       userdata
              an optional pointer to pass extra data to the callback when it will be invoked.

       window the  window  that  the  dialog  should  be  modal for, may be NULL. Not all platforms support this
              option.

       filters
              a list of filters, may be NULL. Not all platforms support  this  option,  and  platforms  that  do
              support  it  may  allow the user to ignore the filters. If non-NULL, it must remain valid at least
              until the callback is invoked.

       nfilters
              the number of filters. Ignored if filters is NULL.

       default_location
              the default folder or file to start the dialog at, may be NULL. Not  all  platforms  support  this
              option.

       allow_many
              if  non-zero,  the user will be allowed to select multiple entries. Not all platforms support this
              option.

THREAD SAFETY

       This function should be called only from the main thread. The callback  may  be  invoked  from  the  same
       thread or from a different one, depending on the OS's constraints.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       (3),  SDL_DialogFileCallback(3type), (3), SDL_DialogFileFilter(3type), (3), SDL_ShowSaveFileDialog(3),
       (3), SDL_ShowOpenFolderDialog(3), (3), SDL_ShowFileDialogWithProperties(3)

Simple Directmedia Layer                            SDL 3.2.8                          SDL_ShowOpenFileDialog(3)