Wiki Page Content

SDL_ShowSimpleMessageBox

Use this function to display a simple modal message box.

Syntax

int SDL_ShowSimpleMessageBox(Uint32      flags,
                             const char* title,
                             const char* message,
                             SDL_Window* window)

Function Parameters

flags

an SDL_MessageBoxFlag; see Remarks for details

title

UTF-8 title text

message

UTF-8 message text

window

the parent window, or NULL for no parent

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Code Examples

SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR,
                         "Missing file",
                         "File is missing. Please reinstall the program.",
                         NULL);

Remarks

flags may be any of the following:

SDL_MESSAGEBOX_ERROR

error dialog

SDL_MESSAGEBOX_WARNING

warning dialog

SDL_MESSAGEBOX_INFORMATION

informational dialog

This function may be called at any time, even before SDL_Init(). This makes it useful for reporting errors like a failure to create a renderer or OpenGL context.

On X11, SDL rolls its own dialog box with X11 primitives instead of a formal toolkit like GTK+ or Qt.

Note that if SDL_Init() would fail because there isn't any available video target, this function is likely to fail for the same reasons. If this is a concern, check the return value from this function and fall back to writing to stderr if you can.


CategoryAPI, CategoryVideo

None: SDL_ShowSimpleMessageBox (last edited 2014-09-24 20:33:51 by PhilippWiesemann)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit