Function sdl2_sys::SDL_ShowSimpleMessageBox

source · 
pub unsafe extern "C" fn SDL_ShowSimpleMessageBox(
    flags: Uint32,
    title: *const c_char,
    message: *const c_char,
    window: *mut SDL_Window,
) -> c_int
Expand description

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.

\param flags an SDL_MessageBoxFlags value \param title UTF-8 title text \param message UTF-8 message text \param window the parent window, or NULL for no parent \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_ShowMessageBox