mirror of
https://github.com/libsdl-org/SDL.git
synced 2026-05-27 10:57:22 +08:00
Sync SDL3 wiki -> header
[ci skip]
This commit is contained in:
+19
-17
@@ -975,8 +975,8 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, int
|
|||||||
*
|
*
|
||||||
* - `SDL_WINDOW_TOOLTIP`: The popup window is a tooltip and will not pass any
|
* - `SDL_WINDOW_TOOLTIP`: The popup window is a tooltip and will not pass any
|
||||||
* input events.
|
* input events.
|
||||||
* - `SDL_WINDOW_POPUP_MENU`: The popup window is a popup menu.
|
* - `SDL_WINDOW_POPUP_MENU`: The popup window is a popup menu. The topmost
|
||||||
* The topmost popup menu will implicitly gain the keyboard focus.
|
* popup menu will implicitly gain the keyboard focus.
|
||||||
*
|
*
|
||||||
* The following flags are not relevant to popup window creation and will be
|
* The following flags are not relevant to popup window creation and will be
|
||||||
* ignored:
|
* ignored:
|
||||||
@@ -986,8 +986,8 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, int
|
|||||||
* - `SDL_WINDOW_FULLSCREEN`
|
* - `SDL_WINDOW_FULLSCREEN`
|
||||||
* - `SDL_WINDOW_BORDERLESS`
|
* - `SDL_WINDOW_BORDERLESS`
|
||||||
*
|
*
|
||||||
* The following flags are incompatible with popup window creation and will cause
|
* The following flags are incompatible with popup window creation and will
|
||||||
* it to fail:
|
* cause it to fail:
|
||||||
*
|
*
|
||||||
* - `SDL_WINDOW_UTILITY`
|
* - `SDL_WINDOW_UTILITY`
|
||||||
* - `SDL_WINDOW_MODAL`
|
* - `SDL_WINDOW_MODAL`
|
||||||
@@ -997,15 +997,15 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, int
|
|||||||
* window.
|
* window.
|
||||||
*
|
*
|
||||||
* Popup windows cannot be minimized, maximized, made fullscreen, raised,
|
* Popup windows cannot be minimized, maximized, made fullscreen, raised,
|
||||||
* flash, be made a modal window, be the parent of a toplevel window, or grab the
|
* flash, be made a modal window, be the parent of a toplevel window, or grab
|
||||||
* mouse and/or keyboard. Attempts to do so will fail.
|
* the mouse and/or keyboard. Attempts to do so will fail.
|
||||||
*
|
*
|
||||||
* Popup windows implicitly do not have a border/decorations and do not appear
|
* Popup windows implicitly do not have a border/decorations and do not appear
|
||||||
* on the taskbar/dock or in lists of windows such as alt-tab menus.
|
* on the taskbar/dock or in lists of windows such as alt-tab menus.
|
||||||
*
|
*
|
||||||
* If a parent window is hidden or destroyed, any child popup windows will be recursively
|
* If a parent window is hidden or destroyed, any child popup windows will be
|
||||||
* hidden or destroyed as well. Child popup windows not explicitly hidden will be restored
|
* recursively hidden or destroyed as well. Child popup windows not explicitly
|
||||||
* when the parent is shown.
|
* hidden will be restored when the parent is shown.
|
||||||
*
|
*
|
||||||
* \param parent the parent of the window, must not be NULL.
|
* \param parent the parent of the window, must not be NULL.
|
||||||
* \param offset_x the x position of the popup window relative to the origin
|
* \param offset_x the x position of the popup window relative to the origin
|
||||||
@@ -1100,8 +1100,8 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreatePopupWindow(SDL_Window *paren
|
|||||||
* surfaces.
|
* surfaces.
|
||||||
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN` - true if the
|
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN` - true if the
|
||||||
* application wants an associated `wl_egl_window` object to be created and
|
* 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
|
* attached to the window, even if the window does not have the OpenGL
|
||||||
* or `SDL_WINDOW_OPENGL` flag set.
|
* property or `SDL_WINDOW_OPENGL` flag set.
|
||||||
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER` - the wl_surface
|
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER` - the wl_surface
|
||||||
* associated with the window, if you want to wrap an existing window. See
|
* associated with the window, if you want to wrap an existing window. See
|
||||||
* [README/wayland](README/wayland) for more information.
|
* [README/wayland](README/wayland) for more information.
|
||||||
@@ -2299,13 +2299,14 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window);
|
|||||||
* reparented to the new owner. Setting the parent window to NULL unparents
|
* reparented to the new owner. Setting the parent window to NULL unparents
|
||||||
* the window and removes child window status.
|
* the window and removes child window status.
|
||||||
*
|
*
|
||||||
* If a parent window is hidden or destroyed, the operation will be recursively
|
* If a parent window is hidden or destroyed, the operation will be
|
||||||
* applied to child windows. Child windows hidden with the parent that did not
|
* recursively applied to child windows. Child windows hidden with the parent
|
||||||
* have their hidden status explicitly set will be restored when the parent is shown.
|
* that did not have their hidden status explicitly set will be restored when
|
||||||
|
* the parent is shown.
|
||||||
*
|
*
|
||||||
* Attempting to set the parent of a window that is currently in the modal
|
* Attempting to set the parent of a window that is currently in the modal
|
||||||
* state will fail. Use SDL_SetWindowModal() to cancel the modal status before attempting
|
* state will fail. Use SDL_SetWindowModal() to cancel the modal status before
|
||||||
* to change the parent.
|
* attempting to change the parent.
|
||||||
*
|
*
|
||||||
* Popup windows cannot change parents and attempts to do so will fail.
|
* Popup windows cannot change parents and attempts to do so will fail.
|
||||||
*
|
*
|
||||||
@@ -2492,7 +2493,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOp
|
|||||||
/**
|
/**
|
||||||
* Destroy a window.
|
* Destroy a window.
|
||||||
*
|
*
|
||||||
* Any child windows owned by the window will be recursively destroyed as well.
|
* Any child windows owned by the window will be recursively destroyed as
|
||||||
|
* well.
|
||||||
*
|
*
|
||||||
* \param window the window to destroy.
|
* \param window the window to destroy.
|
||||||
*
|
*
|
||||||
|
|||||||
Reference in New Issue
Block a user