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

Function SDL_ShowWindowSystemMenu

pub unsafe extern "C" fn SDL_ShowWindowSystemMenu(
    window: *mut SDL_Window,
    x: i32,
    y: i32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Display the system-level window menu.

This default window menu is provided by the system and on some platforms provides functionality for setting or changing privileged state on the window, such as moving it between workspaces or displays, or toggling the always-on-top property.

On platforms or desktops where this is unsupported, this function does nothing.

§Parameters

  • window: the window for which the menu will be displayed.
  • x: the x coordinate of the menu, relative to the origin (top-left) of the client area.
  • y: the y coordinate of the menu, relative to the origin (top-left) of the client area.

§Return value

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.

§Availability

This function is available since SDL 3.2.0.