mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-07-09 02:39:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source 
[ci skip]
This commit is contained in:
SDL Wiki Bot
2026-06-30 16:33:03 +00:00
parent b4b1cdeb27
commit 4fe0d8c1cd
1 changed files with 30 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
include/SDL3/SDL_video.h
View File

@@ -103,29 +103,33 @@ typedef Uint32 SDL_WindowID;
#define SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER "SDL.video.wayland.wl_display"
/**
* The session ID string used for saving and restoring window state across runs.
* The session ID string used for saving and restoring window state across
* runs.
*
* This requires that the compositor supports the `xdg_session_management_v1` protocol.
* This requires that the compositor supports the `xdg_session_management_v1`
* protocol.
*
* To save and restore the current state of Wayland toplevel windows, set this to a non-null
* value before creating a window, and serialize this value before shutting down. To restore
* the previous state on subsequent runs, set this property to the previously serialized
* value before window creation.
* To save and restore the current state of Wayland toplevel windows, set this
* to a non-null value before creating a window, and serialize this value
* before shutting down. To restore the previous state on subsequent runs, set
* this property to the previously serialized value before window creation.
*
* This can be set at any time before the first call to a window creation function. Reading
* should be deferred until serialization time, as compositors may not set the session
* identifier string immediately, and the identifier string may change during runtime, so
* it should not be cached.
* This can be set at any time before the first call to a window creation
* function. Reading should be deferred until serialization time, as
* compositors may not set the session identifier string immediately, and the
* identifier string may change during runtime, so it should not be cached.
*
* Setting this to an empty string ("") before creating a window will cause a new session with
* an automatically generated identifier string to be created.
* Setting this to an empty string ("") before creating a window will cause a
* new session with an automatically generated identifier string to be
* created.
*
* Setting this to null or an empty string before shutting down the video subsystem will cause
* the existing session to be removed.
* Setting this to null or an empty string before shutting down the video
* subsystem will cause the existing session to be removed.
*
* Note that for windows to be saved/restored by the session, they also need a stable, unique
* identifier string set via the `SDL_PROP_WINDOW_CREATE_WAYLAND_WINDOW_ID_STRING` property at
* creation time.
* Note that for windows to be saved/restored by the session, they also need a
* stable, unique identifier string set via the
* `SDL_PROP_WINDOW_CREATE_WAYLAND_WINDOW_ID_STRING` property at creation
* time.
*
* \since This property is available since SDL 3.6.0.
*
@@ -1380,11 +1384,11 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreatePopupWindow(SDL_Window *paren
* application wants an associated `wl_egl_window` object to be created and
* attached to the window, even if the window does not have the OpenGL
* property or `SDL_WINDOW_OPENGL` flag set.
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_WINDOW_ID_STRING` - a string used as
* a stable identifier for toplevel windows for the purpose of allowing
* the compositor to save/restore their state between runs. This should
* be human readable, but not translated, and must be unique for each
* individual window.
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_WINDOW_ID_STRING` - a string used as a
* stable identifier for toplevel windows for the purpose of allowing the
* compositor to save/restore their state between runs. This should be human
* readable, but not translated, and must be unique for each individual
* window.
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER` - the wl_surface
* associated with the window, if you want to wrap an existing window. See
* [README-wayland](README-wayland) for more information.
@@ -1645,9 +1649,10 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowParent(SDL_Window *window)
* with the window
* - `SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER`: the wl_egl_window
* associated with the window
* - `SDL_PROP_WINDOW_WAYLAND_WINDOW_ID_STRING`: the window identification string,
* initially set with SDL_PROP_WINDOW_CREATE_WAYLAND_WINDOW_ID_STRING, and used
* as an identifier for session management. Setting this to null or an empty
* - `SDL_PROP_WINDOW_WAYLAND_WINDOW_ID_STRING`: the window identification
* string, initially set with
* SDL_PROP_WINDOW_CREATE_WAYLAND_WINDOW_ID_STRING, and used as an
* identifier for session management. Setting this to null or an empty
* string ("") before hiding or destroying the window will cause any session
* information associated with the window to be removed
* - `SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER`: the xdg_surface associated