SDL_ShowWindowSystemMenu3
Display the system-level window menu.
Usage
#include "SDL3/SDL.h"
bool SDL_ShowWindowSystemMenu(SDL_Window *window, int x, int y);
Header file
Defined in SDL3/SDL_video.h
Overview
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.
Function 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.