(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetWindowProperties

Get the properties associated with a window.

Syntax

SDL_PropertiesID SDL_GetWindowProperties(SDL_Window *window);

Function Parameters

window

the window to query

Return Value

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:

"SDL.window.android.window" (pointer) - the ANativeWindow associated with the window
"SDL.window.android.surface" (pointer) - the EGLSurface associated with the window

On iOS:

"SDL.window.uikit.window" (pointer) - the (__unsafe_unretained) UIWindow associated with the window
"SDL.window.uikit.metal_view_tag" (number) - the NSInteger tag assocated with metal views on the window

On KMS/DRM:

"SDL.window.kmsdrm.dev_index" (number) - the device index associated with the window (e.g. the X in /dev/dri/cardX)
"SDL.window.kmsdrm.drm_fd" (number) - the DRM FD associated with the window
"SDL.window.kmsdrm.gbm_dev" (pointer) - the GBM device associated with the window

On macOS:

"SDL.window.cocoa.window" (pointer) - the (__unsafe_unretained) NSWindow associated with the window
"SDL.window.cocoa.metal_view_tag" (number) - the NSInteger tag assocated with metal views on the window

On Vivante:

"SDL.window.vivante.display" (pointer) - the EGLNativeDisplayType associated with the window
"SDL.window.vivante.window" (pointer) - the EGLNativeWindowType associated with the window
"SDL.window.vivante.surface" (pointer) - the EGLSurface associated with the window

On UWP:

"SDL.window.winrt.window" (pointer) - the IInspectable CoreWindow associated with the window

On Windows:

"SDL.window.win32.hwnd" (pointer) - the HWND associated with the window
"SDL.window.win32.hdc" (pointer) - the HDC associated with the window
"SDL.window.win32.instance" (pointer) - the HINSTANCE associated with the window

On Wayland:

"SDL.window.wayland.registry" (pointer) - the wl_registry associated with the window
"SDL.window.wayland.display" (pointer) - the wl_display associated with the window
"SDL.window.wayland.surface" (pointer) - the wl_surface associated with the window
"SDL.window.wayland.egl_window" (pointer) - the wl_egl_window associated with the window
"SDL.window.wayland.xdg_surface" (pointer) - the xdg_surface associated with the window
"SDL.window.wayland.xdg_toplevel" (pointer) - the xdg_toplevel role associated with the window
"SDL.window.wayland.xdg_popup" (pointer) - the xdg_popup role associated with the window
"SDL.window.wayland.xdg_positioner" (pointer) - the xdg_positioner associated with the window, in popup mode

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:

"SDL.window.x11.display" (pointer) - the X11 Display associated with the window
"SDL.window.x11.screen" (number) - the screen number associated with the window
"SDL.window.x11.window" (number) - the X11 Window associated with the window

Version

This function is available since SDL 3.0.0.

Related Functions

• SDL_GetProperty
• SDL_SetProperty

---

CategoryAPI

---

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