devela::_dep::sdl3::sys::video

Function SDL_CreatePopupWindow

pub unsafe extern "C" fn SDL_CreatePopupWindow(
    parent: *mut SDL_Window,
    offset_x: i32,
    offset_y: i32,
    w: i32,
    h: i32,
    flags: u64,
) -> *mut SDL_Window
Available on crate feature dep_sdl3 only.
Expand description

Create a child popup window of the specified parent window.

The flags parameter must contain at least one of the following:

  • SDL_WINDOW_TOOLTIP: The popup window is a tooltip and will not pass any input events.
  • SDL_WINDOW_POPUP_MENU: The popup window is a popup menu. The topmost popup menu will implicitly gain the keyboard focus.

The following flags are not relevant to popup window creation and will be ignored:

The following flags are incompatible with popup window creation and will cause it to fail:

The parent parameter must be non-null and a valid window. The parent of a popup window can be either a regular, toplevel window, or another popup window.

Popup windows cannot be minimized, maximized, made fullscreen, raised, flash, be made a modal window, be the parent of a toplevel window, or grab the mouse and/or keyboard. Attempts to do so will fail.

Popup windows implicitly do not have a border/decorations and do not appear on the taskbar/dock or in lists of windows such as alt-tab menus.

If a parent window is hidden or destroyed, any child popup windows will be recursively hidden or destroyed as well. Child popup windows not explicitly hidden will be restored when the parent is shown.

§Parameters

  • parent: the parent of the window, must not be NULL.
  • offset_x: the x position of the popup window relative to the origin of the parent.
  • offset_y: the y position of the popup window relative to the origin of the parent window.
  • w: the width of the window.
  • h: the height of the window.
  • flags: SDL_WINDOW_TOOLTIP or SDL_WINDOW_POPUP_MENU, and zero or more additional SDL_WindowFlags OR’d together.

§Return value

Returns the window that was created or NULL on failure; call SDL_GetError() for more information.

§Thread safety

This function should only be called on the main thread.

§Availability

This function is available since SDL 3.2.0.

§See also