(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_ShowWindowSystemMenu

Display the system-level window menu.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

bool SDL_ShowWindowSystemMenu(SDL_Window *window, int x, int y);

Function Parameters

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

Return Value

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

Remarks

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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryVideo

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.