devela::_dep::sdl3::sys::messagebox

Function SDL_ShowSimpleMessageBox

pub unsafe extern "C" fn SDL_ShowSimpleMessageBox(
    flags: u32,
    title: *const i8,
    message: *const i8,
    window: *mut SDL_Window,
) -> bool
Available on crate feature dep_sdl3 only.
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:

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.

§Parameters

  • flags: an SDL_MessageBoxFlags value.
  • title: UTF-8 title text.
  • message: UTF-8 message text.
  • window: the parent window, or NULL for no parent.

§Return value

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

§Availability

This function is available since SDL 3.2.0.

§See also