mirror
/
SDL
mirror of https://github.com/libsdl-org/SDL.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-04-30 17:48:27 +00:00
parent c6a70d6898
commit 97d0e78842
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/SDL3/SDL_video.h
View File

@ -908,15 +908,15 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_CreatePopupWindow(SDL_Window *parent, in
* with Metal rendering * with Metal rendering
* - `SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN`: true if the window should * - `SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN`: true if the window should
* start minimized * start minimized
* - `SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN`: true if the window is modal to its * - `SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN`: true if the window is modal to
* parent * its parent
* - `SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN`: true if the window starts * - `SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN`: true if the window starts
* with grabbed mouse focus * with grabbed mouse focus
* - `SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`: true if the window will be used * - `SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`: true if the window will be used
* with OpenGL rendering * with OpenGL rendering
* - `SDL_PROP_WINDOW_CREATE_PARENT_POINTER`: an SDL_Window that will be the * - `SDL_PROP_WINDOW_CREATE_PARENT_POINTER`: an SDL_Window that will be the
* parent of this window, required for windows with the "toolip", "menu", and * parent of this window, required for windows with the "toolip", "menu",
* "modal" properties * and "modal" properties
* - `SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN`: true if the window should be * - `SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN`: true if the window should be
* resizable * resizable
* - `SDL_PROP_WINDOW_CREATE_TITLE_STRING`: the title of the window, in UTF-8 * - `SDL_PROP_WINDOW_CREATE_TITLE_STRING`: the title of the window, in UTF-8
@ -2006,10 +2006,12 @@ extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window *window, float *out_
/** /**
* Set the window as a modal to a parent window. * Set the window as a modal to a parent window.
* *
* If the window is already modal to an existing window, it will be reparented to the new owner. * If the window is already modal to an existing window, it will be reparented
* Setting the parent window to null unparents the modal window and removes modal status. * to the new owner. Setting the parent window to null unparents the modal
* window and removes modal status.
* *
* Setting a window as modal to a parent that is a descendent of the modal window results in undefined behavior. * Setting a window as modal to a parent that is a descendent of the modal
* window results in undefined behavior.
* *
* \param modal_window the window that should be set modal * \param modal_window the window that should be set modal
* \param parent_window the parent window for the modal window * \param parent_window the parent window for the modal window
@ -2190,7 +2192,8 @@ extern DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOperati
/** /**
* Destroy a window. * Destroy a window.
* *
* Any popups or modal windows owned by the window will be recursively destroyed as well. * Any popups or modal windows owned by the window will be recursively
* destroyed as well.
* *
* If `window` is NULL, this function will return immediately after setting * If `window` is NULL, this function will return immediately after setting
* the SDL error message to "Invalid window". See SDL_GetError(). * the SDL error message to "Invalid window". See SDL_GetError().