NAME¶

SDL_ShowSaveFileDialog - Displays a dialog that lets the user choose a new or existing file on their filesystem.

HEADER FILE¶

Defined in SDL3/SDL_dialog.h

SYNOPSIS¶

#include "SDL3/SDL.h"

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

DESCRIPTION¶

This function should only be invoked from the main thread.

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.

The chosen file may or may not already 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

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 of C strings, representing the paths chosen by the user. The list will be empty if the user canceled the dialog, and it will be NULL if an error occurred. If an error occurred, it can be fetched with SDL_GetError (). The second argument is the userdata pointer passed to the function. The third argument is the index of the filter selected by the user, or one past the index of the last filter (therefore the index of the terminating NULL filter) if no filter was chosen, or -1 if the platform does not support detecting the selected filter.

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 SDL_DialogFileFilter

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.

AVAILABILITY¶

This function is available since SDL 3.1.3.

SEE ALSO¶

•(3), SDL_DialogFileCallback(3type), •(3), SDL_DialogFileFilter(3type), •(3), SDL_ShowOpenFileDialog(3), •(3), SDL_ShowOpenFolderDialog(3)