SDL offers a simple message box API, which is useful for simple alerts, such as informing the user when something fatal happens at startup without the need to build a UI for it (or informing the user before your UI is ready).
More...
These message boxes are native system dialogs where possible.
There is both a customizable function (ShowMessageBox()) that offers lots of options for what to display and reports on what choice the user made, and also a much-simplified version (ShowSimpleMessageBox()), merely takes a text message and title, and waits until the user presses a single "OK" UI button. Often, this is all that is necessary.
◆ MessageBoxButtonData
- Since
- This struct is available since SDL 3.2.0.
◆ MessageBoxButtonFlags
- Since
- This datatype is available since SDL 3.2.0.
◆ MessageBoxColor
- Since
- This struct is available since SDL 3.2.0.
◆ MessageBoxColorScheme
- Since
- This struct is available since SDL 3.2.0.
◆ MessageBoxFlags
If supported will display warning icon, etc.
- Since
- This datatype is available since SDL 3.2.0.
◆ ShowSimpleMessageBox()
If your needs aren't complex, this function is preferred over MessageBox.Show.
flags
may be any of the following:
MESSAGEBOX_ERROR
: error dialog
MESSAGEBOX_WARNING
: warning dialog
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 InitSubSystem(). 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 InitSubSystem() 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.
- Parameters
-
flags | an MessageBoxFlags value. |
title | UTF-8 title text. |
message | UTF-8 message text. |
window | the parent window, or nullptr for no parent. |
- Exceptions
-
- Since
- This function is available since SDL 3.2.0.
- See also
- MessageBox.Show
◆ MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT
Initial value:=
SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT
◆ MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT
Initial value:=
SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT
◆ MESSAGEBOX_BUTTONS_LEFT_TO_RIGHT
Initial value:=
SDL_MESSAGEBOX_BUTTONS_LEFT_TO_RIGHT
◆ MESSAGEBOX_BUTTONS_RIGHT_TO_LEFT
Initial value:=
SDL_MESSAGEBOX_BUTTONS_RIGHT_TO_LEFT
◆ MESSAGEBOX_COLOR_BACKGROUND
Initial value:=
SDL_MESSAGEBOX_COLOR_BACKGROUND
◆ MESSAGEBOX_COLOR_BUTTON_BACKGROUND
Initial value:=
SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND
◆ MESSAGEBOX_COLOR_BUTTON_BORDER
Initial value:=
SDL_MESSAGEBOX_COLOR_BUTTON_BORDER
◆ MESSAGEBOX_COLOR_BUTTON_SELECTED
Initial value:=
SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED
◆ MESSAGEBOX_COLOR_COUNT
Initial value:=
SDL_MESSAGEBOX_COLOR_COUNT
◆ MESSAGEBOX_COLOR_TEXT
Initial value:=
SDL_MESSAGEBOX_COLOR_TEXT
◆ MESSAGEBOX_ERROR
◆ MESSAGEBOX_INFORMATION
Initial value:=
SDL_MESSAGEBOX_INFORMATION
◆ MESSAGEBOX_WARNING