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

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2023-11-30 15:22:19 +00:00
parent df0fd55891
commit e4582e6edc
5 changed files with 130 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
include/SDL3/SDL_video.h
View File

@@ -750,7 +750,8 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_CreateWindow(const char *title, int w, i
* input events. - 'SDL_WINDOW_POPUP_MENU': The popup window is a popup menu.
* The topmost popup menu will implicitly gain the keyboard focus.
*
* The following flags are not relevant to popup window creation and will be ignored:
* The following flags are not relevant to popup window creation and will be
* ignored:
*
* - 'SDL_WINDOW_MINIMIZED'
* - 'SDL_WINDOW_MAXIMIZED'
@@ -803,45 +804,63 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_CreatePopupWindow(SDL_Window *parent, in
*
* - "always-on-top" (boolean) - true if the window should be always on top
* - "borderless" (boolean) - true if the window has no window decoration
* - "focusable" (boolean) - true if the window should accept keyboard input (defaults true)
* - "fullscreen" (boolean) - true if the window should start in fullscreen mode at desktop resolution
* - "focusable" (boolean) - true if the window should accept keyboard input
* (defaults true)
* - "fullscreen" (boolean) - true if the window should start in fullscreen
* mode at desktop resolution
* - "height" (number) - the height of the window
* - "hidden" (boolean) - true if the window should start hidden
* - "high-pixel-density" (boolean) - true if the window uses a high pixel density buffer if possible
* - "high-pixel-density" (boolean) - true if the window uses a high pixel
* density buffer if possible
* - "maximized" (boolean) - true if the window should start maximized
* - "menu" (boolean) - true if the window is a popup menu
* - "metal" (string) - true if the window will be used with Metal rendering
* - "minimized" (boolean) - true if the window should start minimized
* - "mouse-grabbed" (boolean) - true if the window starts with grabbed mouse focus
* - "opengl" (boolean) - true if the window will be used with OpenGL rendering
* - "parent" (pointer) - an SDL_Window that will be the parent of this window, required for windows with the "toolip" and "menu" properties
* - "mouse-grabbed" (boolean) - true if the window starts with grabbed mouse
* focus
* - "opengl" (boolean) - true if the window will be used with OpenGL
* rendering
* - "parent" (pointer) - an SDL_Window that will be the parent of this
* window, required for windows with the "toolip" and "menu" properties
* - "resizable" (boolean) - true if the window should be resizable
* - "title" (string) - the title of the window, in UTF-8 encoding
* - "transparent" (string) - true if the window show transparent in the areas with alpha of 0
* - "transparent" (string) - true if the window show transparent in the areas
* with alpha of 0
* - "tooltip" (boolean) - true if the window is a tooltip
* - "utility" (boolean) - true if the window is a utility window, not showing in the task bar and window list
* - "utility" (boolean) - true if the window is a utility window, not showing
* in the task bar and window list
* - "vulkan" (string) - true if the window will be used with Vulkan rendering
* - "width" (number) - the width of the window
* - "x" (number) - the x position of the window, or `SDL_WINDOWPOS_CENTERED`, defaults to `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for windows with the "parent" property set.
* - "y" (number) - the y position of the window, or `SDL_WINDOWPOS_CENTERED`, defaults to `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for windows with the "parent" property set.
* - "x" (number) - the x position of the window, or `SDL_WINDOWPOS_CENTERED`,
* defaults to `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for
* windows with the "parent" property set.
* - "y" (number) - the y position of the window, or `SDL_WINDOWPOS_CENTERED`,
* defaults to `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for
* windows with the "parent" property set.
*
* On macOS:
*
* - "cocoa.window" (pointer) - the (__unsafe_unretained) NSWindow associated with the window, if you want to wrap an existing window.
* - "cocoa.view" (pointer) - the (__unsafe_unretained) NSView associated with the window, defaults to [window contentView]
* - "cocoa.window" (pointer) - the (__unsafe_unretained) NSWindow associated
* with the window, if you want to wrap an existing window.
* - "cocoa.view" (pointer) - the (__unsafe_unretained) NSView associated with
* the window, defaults to [window contentView]
*
* On Windows:
*
* - "win32.hwnd" (pointer) - the HWND associated with the window, if you want to wrap an existing window.
* - "win32.pixel_format_hwnd" (pointer) - optional, another window to share pixel format with, useful for OpenGL windows
* - "win32.hwnd" (pointer) - the HWND associated with the window, if you want
* to wrap an existing window.
* - "win32.pixel_format_hwnd" (pointer) - optional, another window to share
* pixel format with, useful for OpenGL windows
*
* On X11:
*
* - "x11.window" (number) - the X11 Window associated with the window, if you want to wrap an existing window.
* - "x11.window" (number) - the X11 Window associated with the window, if you
* want to wrap an existing window.
*
* The SDL_Window is implicitly shown if the "hidden" property is not set.
*
* Windows with the "tooltip" and "menu" properties are popup windows and have the behaviors and guidelines outlined in `SDL_CreatePopupWindow()`.
* Windows with the "tooltip" and "menu" properties are popup windows and have
* the behaviors and guidelines outlined in `SDL_CreatePopupWindow()`.
*
* \param props the properties to use
* \returns the window that was created or NULL on failure; call