(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_DialogFileFilter

An entry for filters for file dialogs.

Header File

Defined in <SDL3/SDL_dialog.h>

Syntax

typedef struct SDL_DialogFileFilter
{
    const char *name;
    const char *pattern;
} SDL_DialogFileFilter;

Remarks

name is a user-readable label for the filter (for example, "Office document").

pattern is a semicolon-separated list of file extensions (for example, "doc;docx"). File extensions may only contain alphanumeric characters, hyphens, underscores and periods. Alternatively, the whole string can be a single asterisk ("*"), which serves as an "All files" filter.

Version

This struct is available since SDL 3.0.0.

Code Examples

This structure is most often used as a NULL-terminated array:

const SDL_DialogFileFilter filters[] = {
    { "PNG images",  "png" },
    { "JPEG images", "jpg;jpeg" },
    { "All images",  "png;jpg;jpeg" },
    { "All files",   "*" },
    { NULL, NULL }
};

See Also


CategoryAPI, CategoryAPIStruct, CategoryDialog