gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync wiki -> headers.

Browse Source
This commit is contained in:
Ryan C. Gordon
2023-11-09 20:11:23 -05:00
parent 74f3643bfa
commit aa7baf63aa
5 changed files with 72 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
include/SDL3/SDL_video.h
View File

@@ -936,53 +936,53 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowParent(SDL_Window *window);
*
* The following properties are provided by SDL:
*
* On Android:
* "SDL.window.android.window" - the ANativeWindow associated with the window
* "SDL.window.android.surface" - the EGLSurface associated with the window
* On Android: "SDL.window.android.window" - the ANativeWindow associated with
* the window "SDL.window.android.surface" - the EGLSurface associated with
* the window
*
* On iOS:
* "SDL.window.uikit.window" - the (__unsafe_unretained) UIWindow associated with the window
* "SDL.window.uikit.metal_view_tag" - the NSInteger tag assocated with metal views on the window
* On iOS: "SDL.window.uikit.window" - the (__unsafe_unretained) UIWindow
* associated with the window "SDL.window.uikit.metal_view_tag" - the
* NSInteger tag assocated with metal views on the window
*
* On KMS/DRM:
* "SDL.window.kmsdrm.dev_index" - the device index associated with the window (e.g. the X in /dev/dri/cardX)
* "SDL.window.kmsdrm.drm_fd" - the DRM FD associated with the window
* "SDL.window.kmsdrm.gbm_dev" - the GBM device associated with the window
* On KMS/DRM: "SDL.window.kmsdrm.dev_index" - the device index associated
* with the window (e.g. the X in /dev/dri/cardX) "SDL.window.kmsdrm.drm_fd" -
* the DRM FD associated with the window "SDL.window.kmsdrm.gbm_dev" - the GBM
* device associated with the window
*
* On macOS:
* "SDL.window.cocoa.window" - the (__unsafe_unretained) NSWindow associated with the window
* "SDL.window.cocoa.metal_view_tag" - the NSInteger tag assocated with metal views on the window
* On macOS: "SDL.window.cocoa.window" - the (__unsafe_unretained) NSWindow
* associated with the window "SDL.window.cocoa.metal_view_tag" - the
* NSInteger tag assocated with metal views on the window
*
* On Vivante:
* "SDL.window.vivante.display" - the EGLNativeDisplayType associated with the window
* "SDL.window.vivante.window" - the EGLNativeWindowType associated with the window
* "SDL.window.vivante.surface" - the EGLSurface associated with the window
* On Vivante: "SDL.window.vivante.display" - the EGLNativeDisplayType
* associated with the window "SDL.window.vivante.window" - the
* EGLNativeWindowType associated with the window "SDL.window.vivante.surface"
* - the EGLSurface associated with the window
*
* On UWP:
* "SDL.window.winrt.window" - the IInspectable CoreWindow associated with the window
* On UWP: "SDL.window.winrt.window" - the IInspectable CoreWindow associated
* with the window
*
* On Windows:
* "SDL.window.win32.hwnd" - the HWND associated with the window
* On Windows: "SDL.window.win32.hwnd" - the HWND associated with the window
* "SDL.window.win32.hdc" - the HDC associated with the window
* "SDL.window.win32.instance" - the HINSTANCE associated with the window
*
* On Wayland:
* "SDL.window.wayland.registry" - the wl_registry associated with the window
* "SDL.window.wayland.display" - the wl_display associated with the window
* "SDL.window.wayland.surface" - the wl_surface associated with the window
* "SDL.window.wayland.egl_window" - the wl_egl_window associated with the window
* "SDL.window.wayland.xdg_surface" - the xdg_surface associated with the window
* "SDL.window.wayland.xdg_toplevel" - the xdg_toplevel role associated with the window
* "SDL.window.wayland.xdg_popup" - the xdg_popup role associated with the window
* "SDL.window.wayland.xdg_positioner" - the xdg_positioner associated with the window, in popup mode
* On Wayland: "SDL.window.wayland.registry" - the wl_registry associated with
* the window "SDL.window.wayland.display" - the wl_display associated with
* the window "SDL.window.wayland.surface" - the wl_surface associated with
* the window "SDL.window.wayland.egl_window" - the wl_egl_window associated
* with the window "SDL.window.wayland.xdg_surface" - the xdg_surface
* associated with the window "SDL.window.wayland.xdg_toplevel" - the
* xdg_toplevel role associated with the window "SDL.window.wayland.xdg_popup"
* - the xdg_popup role associated with the window
* "SDL.window.wayland.xdg_positioner" - 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.
* 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" - the X11 Display associated with the window
* "SDL.window.x11.screen" - the screen number associated with the window
* "SDL.window.x11.window" - the X11 Window associated with the window
* On X11: "SDL.window.x11.display" - the X11 Display associated with the
* window "SDL.window.x11.screen" - the screen number associated with the
* window "SDL.window.x11.window" - the X11 Window associated with the window
*
* \param window the window to query
* \returns a valid property ID on success or 0 on failure; call