(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_GetWindowWMInfo

Get driver-specific information about a window.

Header File

Defined in SDL_syswm.h

Syntax

SDL_bool SDL_GetWindowWMInfo(SDL_Window * window,
                             SDL_SysWMinfo * info);

Function Parameters

SDL_Window *	window	the window about which information is being requested.
SDL_SysWMinfo *	info	an SDL_SysWMinfo structure filled in with window information.

Return Value

(SDL_bool) Returns SDL_TRUE if the function is implemented and the version member of the info struct is valid, or SDL_FALSE if the information could not be retrieved; call SDL_GetError() for more information.

Remarks

You must include SDL_syswm.h for the declaration of SDL_SysWMinfo.

The caller must initialize the info structure's version by using SDL_VERSION(&info.version), and then this function will fill in the rest of the structure with information about the given window.

Version

This function is available since SDL 2.0.0.

---

CategoryAPI, CategoryAPIFunction, CategorySYSWM

[ 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.