Documentation

Create a modal message box.

If your needs aren't complex, it might be easier to use SDL_ShowSimpleMessageBox.

This function should be called on the thread that created the parent window, or on the main thread if the messagebox has no parent. It will block execution of that thread until the user clicks a button or closes the messagebox.

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.

messageboxdata

the SDL_MessageBoxData structure with title, text and other options.

buttonid

the pointer to which user id of hit button should be copied.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_ShowSimpleMessageBox

C declaration

SDL_ShowMessageBox, defined at SDL3/SDL_messagebox.h 177:34

Since: 3.2.0

Display a simple modal message box.

If your needs aren't complex, this function is preferred over SDL_ShowMessageBox.

flags may be any of the following:

• sDL_MESSAGEBOX_ERROR: error dialog
• sDL_MESSAGEBOX_WARNING: warning dialog
• sDL_MESSAGEBOX_INFORMATION: informational dialog

This function should be called on the thread that created the parent window, or on the main thread if the messagebox has no parent. It will block execution of that thread until the user clicks a button or closes the messagebox.

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.

flags

an SDL_MessageBoxFlags value.

title

UTF-8 title text.

message

UTF-8 message text.

window

the parent window, or NULL for no parent.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_ShowMessageBox

C declaration

SDL_ShowSimpleMessageBox, defined at SDL3/SDL_messagebox.h 221:34

Since: 3.2.0