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

SDL_GetWindowProperties

Get the properties associated with a window.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

SDL_PropertiesID SDL_GetWindowProperties(SDL_Window *window);

Function Parameters

SDL_Window * window the window to query.

Return Value

(SDL_PropertiesID) Returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

Remarks

The following read-only properties are provided by SDL:

On Android:

On iOS:

On KMS/DRM:

On macOS:

On OpenVR:

On Vivante:

On Windows:

On Wayland:

Note: The xdg_* window objects do not internally persist across window show/hide calls. They will be null if the window is hidden and must be queried each time it is shown.

On X11:

Version

This function is available since SDL 3.1.3.


CategoryAPI, CategoryAPIFunction, CategoryVideo


[ edit | delete | history | feedback | raw ]

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