mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-22 17:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: Remove string literals from properties documentation.

Browse Source 
I'm going to let the wiki bridge clean up the word wrapping for me, here. :)
This commit is contained in:
Ryan C. Gordon
2024-01-08 12:33:29 -05:00
parent e8c595af5c
commit e056f52f7d
2 changed files with 104 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
include/SDL3/SDL_render.h
View File

@@ -240,14 +240,14 @@ extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window, co
* *
* These are the supported properties: * These are the supported properties:
* *
* - `SDL_PROPERTY_RENDERER_CREATE_WINDOW_POINTER` ("window"): the window * - `SDL_PROPERTY_RENDERER_CREATE_WINDOW_POINTER`: the window
* where rendering is displayed * where rendering is displayed
* - `SDL_PROPERTY_RENDERER_CREATE_SURFACE_POINTER` ("surface"): the surface * - `SDL_PROPERTY_RENDERER_CREATE_SURFACE_POINTER`: the surface
* where rendering is displayed, if you want a software renderer without a * where rendering is displayed, if you want a software renderer without a
* window * window
* - `SDL_PROPERTY_RENDERER_CREATE_NAME_STRING` ("name"): the name of the * - `SDL_PROPERTY_RENDERER_CREATE_NAME_STRING`: the name of the
* rendering driver to use, if a specific one is desired * rendering driver to use, if a specific one is desired
* - `SDL_PROPERTY_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN` ("present_vsync"): * - `SDL_PROPERTY_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN`:
* true if you want present synchronized with the refresh rate * true if you want present synchronized with the refresh rate
* *
* \param props the properties to use * \param props the properties to use
@@ -333,17 +333,14 @@ extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_Rend
* *
* The following read-only properties are provided by SDL: * The following read-only properties are provided by SDL:
* *
* - `SDL_PROPERTY_RENDERER_D3D9_DEVICE_POINTER` ("SDL.renderer.d3d9.device"): * - `SDL_PROPERTY_RENDERER_D3D9_DEVICE_POINTER`: the IDirect3DDevice9
* the IDirect3DDevice9 associated with the renderer * associated with the renderer
* - `SDL_PROPERTY_RENDERER_D3D11_DEVICE_POINTER` * - `SDL_PROPERTY_RENDERER_D3D11_DEVICE_POINTER`: the ID3D11Device
* ("SDL.renderer.d3d11.device"): the ID3D11Device associated with the * associated with the renderer
* renderer * - `SDL_PROPERTY_RENDERER_D3D12_DEVICE_POINTER`: the ID3D12Device
* - `SDL_PROPERTY_RENDERER_D3D12_DEVICE_POINTER` * associated with the renderer
* ("SDL.renderer.d3d12.device"): the ID3D12Device associated with the * - `SDL_PROPERTY_RENDERER_D3D12_COMMAND_QUEUE_POINTER`: the
* renderer * ID3D12CommandQueue associated with the renderer
* - `SDL_PROPERTY_RENDERER_D3D12_COMMAND_QUEUE_POINTER`
* ("SDL.renderer.d3d12.command_queue"): the ID3D12CommandQueue associated
* with the renderer /*
* *
* \param renderer the rendering context * \param renderer the rendering context
* \returns a valid property ID on success or 0 on failure; call * \returns a valid property ID on success or 0 on failure; call
@@ -457,72 +454,61 @@ extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer *
* *
* These are the supported properties: * These are the supported properties:
* *
* - `SDL_PROPERTY_TEXTURE_CREATE_FORMAT_NUMBER` ("format"): one of the * - `SDL_PROPERTY_TEXTURE_CREATE_FORMAT_NUMBER`: one of the
* enumerated values in SDL_PixelFormatEnum, defaults to the best RGBA * enumerated values in SDL_PixelFormatEnum, defaults to the best RGBA
* format for the renderer * format for the renderer
* - `SDL_PROPERTY_TEXTURE_CREATE_ACCESS_NUMBER` ("access"): one of the * - `SDL_PROPERTY_TEXTURE_CREATE_ACCESS_NUMBER`: one of the
* enumerated values in SDL_TextureAccess, defaults to * enumerated values in SDL_TextureAccess, defaults to
* SDL_TEXTUREACCESS_STATIC * SDL_TEXTUREACCESS_STATIC
* - `SDL_PROPERTY_TEXTURE_CREATE_WIDTH_NUMBER` ("width"): the width of the * - `SDL_PROPERTY_TEXTURE_CREATE_WIDTH_NUMBER`: the width of the
* texture in pixels, required
* - `SDL_PROPERTY_TEXTURE_CREATE_HEIGHT_NUMBER` ("height"): the height of the
* texture in pixels, required * texture in pixels, required
* - `SDL_PROPERTY_TEXTURE_CREATE_HEIGHT_NUMBER`: the height of the texture
* in pixels, required
* *
* With the direct3d11 renderer: * With the direct3d11 renderer:
* *
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_POINTER` ("d3d11.texture"): * - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_POINTER`:
* the ID3D11Texture2D associated with the texture, if you want to wrap an * the ID3D11Texture2D associated with the texture, if you want to wrap an
* existing texture. * existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER` * - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER`: the ID3D11Texture2D associated with the U plane of a
* ("d3d11.texture_u"): the ID3D11Texture2D associated with the U plane of a
* YUV texture, if you want to wrap an existing texture. * YUV texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER` * - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER`: the ID3D11Texture2D associated with the V plane of a
* ("d3d11.texture_v"): the ID3D11Texture2D associated with the V plane of a
* YUV texture, if you want to wrap an existing texture. * YUV texture, if you want to wrap an existing texture.
* *
* With the direct3d12 renderer: * With the direct3d12 renderer:
* *
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_POINTER` ("d3d12.texture"): * - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_POINTER`:
* the ID3D12Resource associated with the texture, if you want to wrap an * the ID3D12Resource associated with the texture, if you want to wrap an
* existing texture. * existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER` * - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER`: the
* ("d3d12.texture_u"): the ID3D12Resource associated with the U plane of a * ID3D12Resource associated with the U plane of a
* YUV texture, if you want to wrap an existing texture. * YUV texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER` * - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER`: the ID3D12Resource associated with the V plane of a
* ("d3d12.texture_v"): the ID3D12Resource associated with the V plane of a
* YUV texture, if you want to wrap an existing texture. * YUV texture, if you want to wrap an existing texture.
* *
* With the opengl renderer: * With the opengl renderer:
* *
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER` ("opengl.texture"): * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER`:
* the GLuint texture associated with the texture, if you want to wrap an * the GLuint texture associated with the texture, if you want to wrap an
* existing texture. * existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER` * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER`: the GLuint texture associated with the UV plane of
* ("opengl.texture_uv"): the GLuint texture associated with the UV plane of
* an NV12 texture, if you want to wrap an existing texture. * an NV12 texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER` * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER`: the GLuint texture associated with the U plane of a
* ("opengl.texture_u"): the GLuint texture associated with the U plane of a
* YUV texture, if you want to wrap an existing texture. * YUV texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER` * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER`: the GLuint texture associated with the V plane of a
* ("opengl.texture_v"): the GLuint texture associated with the V plane of a
* YUV texture, if you want to wrap an existing texture. * YUV texture, if you want to wrap an existing texture.
* *
* With the opengles2 renderer: * With the opengles2 renderer:
* *
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER` * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture associated with the texture, if
* ("opengles2.texture"): the GLuint texture associated with the texture, if
* you want to wrap an existing texture. * you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER` * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture associated with the texture, if
* ("opengles2.texture"): the GLuint texture associated with the texture, if
* you want to wrap an existing texture. * you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER` * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER`: the GLuint texture associated with the UV plane
* ("opengles2.texture_uv"): the GLuint texture associated with the UV plane
* of an NV12 texture, if you want to wrap an existing texture. * of an NV12 texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER` * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER`: the GLuint texture associated with the U plane
* ("opengles2.texture_u"): the GLuint texture associated with the U plane
* of a YUV texture, if you want to wrap an existing texture. * of a YUV texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER` * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER`: the GLuint texture associated with the V plane
* ("opengles2.texture_v"): the GLuint texture associated with the V plane
* of a YUV texture, if you want to wrap an existing texture. * of a YUV texture, if you want to wrap an existing texture.
* *
* \param renderer the rendering context * \param renderer the rendering context
@@ -569,60 +555,46 @@ extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureWithProperties(SDL_Rendere
* *
* With the direct3d11 renderer: * With the direct3d11 renderer:
* *
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_POINTER` * - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_POINTER`: the ID3D11Texture2D associated with the
* ("SDL.texture.d3d11.texture"): the ID3D11Texture2D associated with the
* texture * texture
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_U_POINTER` * - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_U_POINTER`: the ID3D11Texture2D associated with the
* ("SDL.texture.d3d11.texture_u"): the ID3D11Texture2D associated with the
* U plane of a YUV texture * U plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_V_POINTER` * - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_V_POINTER`: the ID3D11Texture2D associated with the
* ("SDL.texture.d3d11.texture_v"): the ID3D11Texture2D associated with the
* V plane of a YUV texture * V plane of a YUV texture
* *
* With the direct3d12 renderer: * With the direct3d12 renderer:
* *
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_POINTER` * - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_POINTER`: the ID3D12Resource associated with the
* ("SDL.texture.d3d12.texture"): the ID3D12Resource associated with the
* texture * texture
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_U_POINTER` * - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_U_POINTER`: the ID3D12Resource associated with the U
* ("SDL.texture.d3d12.texture_u"): the ID3D12Resource associated with the U
* plane of a YUV texture * plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_V_POINTER` * - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_V_POINTER`: the ID3D12Resource associated with the V
* ("SDL.texture.d3d12.texture_v"): the ID3D12Resource associated with the V
* plane of a YUV texture * plane of a YUV texture
* *
* With the opengl renderer: * With the opengl renderer:
* *
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_NUMBER` * - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_NUMBER`: the GLuint texture associated with the
* ("SDL.texture.opengl.texture"): the GLuint texture associated with the
* texture * texture
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_UV_NUMBER` * - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_UV_NUMBER`: the GLuint texture associated with the
* ("SDL.texture.opengl.texture_uv"): the GLuint texture associated with the
* UV plane of an NV12 texture * UV plane of an NV12 texture
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_U_NUMBER` * - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_U_NUMBER`: the GLuint texture associated with the
* ("SDL.texture.opengl.texture_u"): the GLuint texture associated with the
* U plane of a YUV texture * U plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_V_NUMBER` * - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_V_NUMBER`: the GLuint texture associated with the
* ("SDL.texture.opengl.texture_v"): the GLuint texture associated with the
* V plane of a YUV texture * V plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_W_FLOAT` ("SDL.texture.opengl.tex_w"): * - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_W_FLOAT`:
* the texture coordinate width of the texture (0.0 - 1.0) * the texture coordinate width of the texture (0.0 - 1.0)
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_H_FLOAT` ("SDL.texture.opengl.tex_h"): * - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_H_FLOAT`:
* the texture coordinate height of the texture (0.0 - 1.0) * the texture coordinate height of the texture (0.0 - 1.0)
* *
* With the opengles2 renderer: * With the opengles2 renderer:
* *
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_NUMBER` * - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture associated with the
* ("SDL.texture.opengles2.texture"): the GLuint texture associated with the
* texture * texture
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER` * - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER`: the GLuint texture associated with
* ("SDL.texture.opengles2.texture_uv"): the GLuint texture associated with
* the UV plane of an NV12 texture * the UV plane of an NV12 texture
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER` * - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER`: the GLuint texture associated with
* ("SDL.texture.opengles2.texture_u"): the GLuint texture associated with
* the U plane of a YUV texture * the U plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER` * - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER`: the GLuint texture associated with
* ("SDL.texture.opengles2.texture_v"): the GLuint texture associated with
* the V plane of a YUV texture * the V plane of a YUV texture
* *
* \param texture the texture to query * \param texture the texture to query

130
include/SDL3/SDL_video.h
View File

@@ -809,79 +809,77 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_CreatePopupWindow(SDL_Window *parent, in
* *
* These are the supported properties: * These are the supported properties:
* *
* - `SDL_PROPERTY_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN` ("always-on-top"): * - `SDL_PROPERTY_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN`:
* true if the window should be always on top * true if the window should be always on top
* - `SDL_PROPERTY_WINDOW_CREATE_BORDERLESS_BOOLEAN` ("borderless"): true if * - `SDL_PROPERTY_WINDOW_CREATE_BORDERLESS_BOOLEAN`: true if
* the window has no window decoration * the window has no window decoration
* - `SDL_PROPERTY_WINDOW_CREATE_FOCUSABLE_BOOLEAN` ("focusable"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_FOCUSABLE_BOOLEAN`: true if the
* window should accept keyboard input (defaults true) * window should accept keyboard input (defaults true)
* - `SDL_PROPERTY_WINDOW_CREATE_FULLSCREEN_BOOLEAN` ("fullscreen"): true if * - `SDL_PROPERTY_WINDOW_CREATE_FULLSCREEN_BOOLEAN`: true if
* the window should start in fullscreen mode at desktop resolution * the window should start in fullscreen mode at desktop resolution
* - `SDL_PROPERTY_WINDOW_CREATE_HEIGHT_NUMBER` ("height"): the height of the * - `SDL_PROPERTY_WINDOW_CREATE_HEIGHT_NUMBER`: the height of the
* window * window
* - `SDL_PROPERTY_WINDOW_CREATE_HIDDEN_BOOLEAN` ("hidden"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_HIDDEN_BOOLEAN`: true if the
* window should start hidden * window should start hidden
* - `SDL_PROPERTY_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN` * - `SDL_PROPERTY_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN`: true if the window uses a high pixel density
* ("high-pixel-density"): true if the window uses a high pixel density
* buffer if possible * buffer if possible
* - `SDL_PROPERTY_WINDOW_CREATE_MAXIMIZED_BOOLEAN` ("maximized"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_MAXIMIZED_BOOLEAN`: true if the
* window should start maximized * window should start maximized
* - `SDL_PROPERTY_WINDOW_CREATE_MENU_BOOLEAN` ("menu"): true if the window is * - `SDL_PROPERTY_WINDOW_CREATE_MENU_BOOLEAN`: true if the window is
* a popup menu * a popup menu
* - `SDL_PROPERTY_WINDOW_CREATE_METAL_BOOLEAN` ("metal"): true if the window * - `SDL_PROPERTY_WINDOW_CREATE_METAL_BOOLEAN`: true if the window
* will be used with Metal rendering * will be used with Metal rendering
* - `SDL_PROPERTY_WINDOW_CREATE_MINIMIZED_BOOLEAN` ("minimized"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_MINIMIZED_BOOLEAN`: true if the
* window should start minimized * window should start minimized
* - `SDL_PROPERTY_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN` ("mouse-grabbed"): * - `SDL_PROPERTY_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN`:
* true if the window starts with grabbed mouse focus * true if the window starts with grabbed mouse focus
* - `SDL_PROPERTY_WINDOW_CREATE_OPENGL_BOOLEAN` ("opengl"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_OPENGL_BOOLEAN`: true if the
* window will be used with OpenGL rendering * window will be used with OpenGL rendering
* - `SDL_PROPERTY_WINDOW_CREATE_PARENT_POINTER` ("parent"): an SDL_Window * - `SDL_PROPERTY_WINDOW_CREATE_PARENT_POINTER`: an SDL_Window
* that will be the parent of this window, required for windows with the * that will be the parent of this window, required for windows with the
* "toolip" and "menu" properties * "toolip" and "menu" properties
* - `SDL_PROPERTY_WINDOW_CREATE_RESIZABLE_BOOLEAN` ("resizable"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_RESIZABLE_BOOLEAN`: true if the
* window should be resizable * window should be resizable
* - `SDL_PROPERTY_WINDOW_CREATE_TITLE_STRING` ("title"): the title of the * - `SDL_PROPERTY_WINDOW_CREATE_TITLE_STRING`: the title of the
* window, in UTF-8 encoding * window, in UTF-8 encoding
* - `SDL_PROPERTY_WINDOW_CREATE_TRANSPARENT_BOOLEAN` ("transparent"): true if * - `SDL_PROPERTY_WINDOW_CREATE_TRANSPARENT_BOOLEAN`: true if
* the window show transparent in the areas with alpha of 0 * the window show transparent in the areas with alpha of 0
* - `SDL_PROPERTY_WINDOW_CREATE_TOOLTIP_BOOLEAN` ("tooltip"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_TOOLTIP_BOOLEAN`: true if the
* window is a tooltip * window is a tooltip
* - `SDL_PROPERTY_WINDOW_CREATE_UTILITY_BOOLEAN` ("utility"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_UTILITY_BOOLEAN`: true if the
* window is a utility window, not showing in the task bar and window list * window is a utility window, not showing in the task bar and window list
* - `SDL_PROPERTY_WINDOW_CREATE_VULKAN_BOOLEAN` ("vulkan"): true if the * - `SDL_PROPERTY_WINDOW_CREATE_VULKAN_BOOLEAN`: true if the
* window will be used with Vulkan rendering * window will be used with Vulkan rendering
* - `SDL_PROPERTY_WINDOW_CREATE_WIDTH_NUMBER` ("width"): the width of the * - `SDL_PROPERTY_WINDOW_CREATE_WIDTH_NUMBER`: the width of the
* window * window
* - `SDL_PROPERTY_WINDOW_CREATE_X_NUMBER` ("x"): the x position of the * - `SDL_PROPERTY_WINDOW_CREATE_X_NUMBER`: the x position of the
* window, or `SDL_WINDOWPOS_CENTERED`, defaults to * window, or `SDL_WINDOWPOS_CENTERED`, defaults to
* `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for windows * `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for windows
* with the "parent" property set. * with the "parent" property set.
* - `SDL_PROPERTY_WINDOW_CREATE_Y_NUMBER` ("y"): the y position of the * - `SDL_PROPERTY_WINDOW_CREATE_Y_NUMBER`: the y position of the
* window, or `SDL_WINDOWPOS_CENTERED`, defaults to * window, or `SDL_WINDOWPOS_CENTERED`, defaults to
* `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for windows * `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for windows
* with the "parent" property set. * with the "parent" property set.
* *
* These are additional supported properties on macOS: * These are additional supported properties on macOS:
* *
* - `SDL_PROPERTY_WINDOW_CREATE_COCOA_WINDOW_POINTER` ("cocoa.window"): the * - `SDL_PROPERTY_WINDOW_CREATE_COCOA_WINDOW_POINTER`: the
* `(__unsafe_unretained)` NSWindow associated with the window, if you want * `(__unsafe_unretained)` NSWindow associated with the window, if you want
* to wrap an existing window. * to wrap an existing window.
* - `SDL_PROPERTY_WINDOW_CREATE_COCOA_VIEW_POINTER` ("cocoa.view"): the * - `SDL_PROPERTY_WINDOW_CREATE_COCOA_VIEW_POINTER`: the
* `(__unsafe_unretained)` NSView associated with the window, defaults to * `(__unsafe_unretained)` NSView associated with the window, defaults to
* `[window contentView]` * `[window contentView]`
* *
* These are additional supported properties on Windows: * These are additional supported properties on Windows:
* *
* - `SDL_PROPERTY_WINDOW_CREATE_WIN32_HWND_POINTER` ("win32.hwnd"): the HWND * - `SDL_PROPERTY_WINDOW_CREATE_WIN32_HWND_POINTER`: the HWND
* associated with the window, if you want to wrap an existing window. * associated with the window, if you want to wrap an existing window.
* - `SDL_PROPERTY_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER` * - `SDL_PROPERTY_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER`: optional, another window to share pixel
* ("win32.pixel_format_hwnd"): optional, another window to share pixel
* format with, useful for OpenGL windows * format with, useful for OpenGL windows
* *
* These are additional supported properties with X11: * These are additional supported properties with X11:
* *
* - `SDL_PROPERTY_WINDOW_CREATE_X11_WINDOW_NUMBER` ("x11.window"): the X11 * - `SDL_PROPERTY_WINDOW_CREATE_X11_WINDOW_NUMBER`: the X11
* Window associated with the window, if you want to wrap an existing * Window associated with the window, if you want to wrap an existing
* window. * window.
* *
@@ -983,62 +981,52 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowParent(SDL_Window *window);
* *
* On Android: * On Android:
* *
* - `SDL_PROPERTY_WINDOW_ANDROID_WINDOW_POINTER` * - `SDL_PROPERTY_WINDOW_ANDROID_WINDOW_POINTER`: the ANativeWindow associated with the
* ("SDL.window.android.window"): the ANativeWindow associated with the
* window * window
* - `SDL_PROPERTY_WINDOW_ANDROID_SURFACE_POINTER` * - `SDL_PROPERTY_WINDOW_ANDROID_SURFACE_POINTER`: the EGLSurface associated with the window
* ("SDL.window.android.surface"): the EGLSurface associated with the window
* *
* On iOS: * On iOS:
* *
* - `SDL_PROPERTY_WINDOW_UIKIT_WINDOW_POINTER` ("SDL.window.uikit.window"): * - `SDL_PROPERTY_WINDOW_UIKIT_WINDOW_POINTER`:
* the `(__unsafe_unretained)` UIWindow associated with the window * the `(__unsafe_unretained)` UIWindow associated with the window
* - `SDL_PROPERTY_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER` * - `SDL_PROPERTY_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER`: the NSInteger tag assocated with
* ("SDL.window.uikit.metal_view_tag"): the NSInteger tag assocated with
* metal views on the window * metal views on the window
* *
* On KMS/DRM: * On KMS/DRM:
* *
* - `SDL_PROPERTY_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER` * - `SDL_PROPERTY_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER`: the device index associated with the
* ("SDL.window.kmsdrm.dev_index"): the device index associated with the
* window (e.g. the X in /dev/dri/cardX) * window (e.g. the X in /dev/dri/cardX)
* - `SDL_PROPERTY_WINDOW_KMSDRM_DRM_FD_NUMBER` ("SDL.window.kmsdrm.drm_fd"): * - `SDL_PROPERTY_WINDOW_KMSDRM_DRM_FD_NUMBER`:
* the DRM FD associated with the window * the DRM FD associated with the window
* - `SDL_PROPERTY_WINDOW_KMSDRM_GBM_DEVICE_POINTER` * - `SDL_PROPERTY_WINDOW_KMSDRM_GBM_DEVICE_POINTER`: the GBM device associated with the window
* ("SDL.window.kmsdrm.gbm_dev"): the GBM device associated with the window
* *
* On macOS: * On macOS:
* *
* - `SDL_PROPERTY_WINDOW_COCOA_WINDOW_POINTER` ("SDL.window.cocoa.window"): * - `SDL_PROPERTY_WINDOW_COCOA_WINDOW_POINTER`:
* the `(__unsafe_unretained)` NSWindow associated with the window * the `(__unsafe_unretained)` NSWindow associated with the window
* - `SDL_PROPERTY_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER` * - `SDL_PROPERTY_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER`: the NSInteger tag assocated with
* ("SDL.window.cocoa.metal_view_tag"): the NSInteger tag assocated with
* metal views on the window * metal views on the window
* *
* On Vivante: * On Vivante:
* *
* - `SDL_PROPERTY_WINDOW_VIVANTE_DISPLAY_POINTER` * - `SDL_PROPERTY_WINDOW_VIVANTE_DISPLAY_POINTER`: the EGLNativeDisplayType associated with
* ("SDL.window.vivante.display"): the EGLNativeDisplayType associated with
* the window * the window
* - `SDL_PROPERTY_WINDOW_VIVANTE_WINDOW_POINTER` * - `SDL_PROPERTY_WINDOW_VIVANTE_WINDOW_POINTER`: the EGLNativeWindowType associated with
* ("SDL.window.vivante.window"): the EGLNativeWindowType associated with
* the window * the window
* - `SDL_PROPERTY_WINDOW_VIVANTE_SURFACE_POINTER` * - `SDL_PROPERTY_WINDOW_VIVANTE_SURFACE_POINTER`: the EGLSurface associated with the window
* ("SDL.window.vivante.surface"): the EGLSurface associated with the window
* *
* On UWP: * On UWP:
* *
* - `SDL_PROPERTY_WINDOW_WINRT_WINDOW_POINTER` ("SDL.window.winrt.window"): * - `SDL_PROPERTY_WINDOW_WINRT_WINDOW_POINTER`:
* the IInspectable CoreWindow associated with the window * the IInspectable CoreWindow associated with the window
* *
* On Windows: * On Windows:
* *
* - `SDL_PROPERTY_WINDOW_WIN32_HWND_POINTER` ("SDL.window.win32.hwnd"): the * - `SDL_PROPERTY_WINDOW_WIN32_HWND_POINTER`: the
* HWND associated with the window * HWND associated with the window
* - `SDL_PROPERTY_WINDOW_WIN32_HDC_POINTER` ("SDL.window.win32.hdc"): the HDC * - `SDL_PROPERTY_WINDOW_WIN32_HDC_POINTER`: the HDC
* associated with the window * associated with the window
* - `SDL_PROPERTY_WINDOW_WIN32_INSTANCE_POINTER` * - `SDL_PROPERTY_WINDOW_WIN32_INSTANCE_POINTER`: the HINSTANCE associated with the window
* ("SDL.window.win32.instance"): the HINSTANCE associated with the window
* *
* On Wayland: * On Wayland:
* *
@@ -1046,36 +1034,28 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowParent(SDL_Window *window);
* show/hide calls. They will be null if the window is hidden and must be * show/hide calls. They will be null if the window is hidden and must be
* queried each time it is shown. * queried each time it is shown.
* *
* - `SDL_PROPERTY_WINDOW_WAYLAND_REGISTRY_POINTER` * - `SDL_PROPERTY_WINDOW_WAYLAND_REGISTRY_POINTER`: the wl_registry associated with the
* ("SDL.window.wayland.registry"): the wl_registry associated with the
* window * window
* - `SDL_PROPERTY_WINDOW_WAYLAND_DISPLAY_POINTER` * - `SDL_PROPERTY_WINDOW_WAYLAND_DISPLAY_POINTER`: the wl_display associated with the window
* ("SDL.window.wayland.display"): the wl_display associated with the window * - `SDL_PROPERTY_WINDOW_WAYLAND_SURFACE_POINTER`: the wl_surface associated with the window
* - `SDL_PROPERTY_WINDOW_WAYLAND_SURFACE_POINTER` * - `SDL_PROPERTY_WINDOW_WAYLAND_EGL_WINDOW_POINTER`: the wl_egl_window associated with the
* ("SDL.window.wayland.surface"): the wl_surface associated with the window
* - `SDL_PROPERTY_WINDOW_WAYLAND_EGL_WINDOW_POINTER`
* ("SDL.window.wayland.egl_window"): the wl_egl_window associated with the
* window * window
* - `SDL_PROPERTY_WINDOW_WAYLAND_XDG_SURFACE_POINTER` * - `SDL_PROPERTY_WINDOW_WAYLAND_XDG_SURFACE_POINTER`: the xdg_surface associated with the
* ("SDL.window.wayland.xdg_surface"): the xdg_surface associated with the
* window * window
* - `SDL_PROPERTY_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER` * - `SDL_PROPERTY_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER`: the xdg_toplevel role associated
* ("SDL.window.wayland.xdg_toplevel"): the xdg_toplevel role associated
* with the window * with the window
* - `SDL_PROPERTY_WINDOW_WAYLAND_XDG_POPUP_POINTER` * - `SDL_PROPERTY_WINDOW_WAYLAND_XDG_POPUP_POINTER`: the xdg_popup role associated with the
* ("SDL.window.wayland.xdg_popup"): the xdg_popup role associated with the
* window * window
* - `SDL_PROPERTY_WINDOW_WAYLAND_XDG_POSITIONER_POINTER` * - `SDL_PROPERTY_WINDOW_WAYLAND_XDG_POSITIONER_POINTER`: the xdg_positioner associated with
* ("SDL.window.wayland.xdg_positioner"): the xdg_positioner associated with
* the window, in popup mode * the window, in popup mode
* *
* On X11: * On X11:
* *
* - `SDL_PROPERTY_WINDOW_X11_DISPLAY_POINTER` ("SDL.window.x11.display"): the * - `SDL_PROPERTY_WINDOW_X11_DISPLAY_POINTER`: the
* X11 Display associated with the window * X11 Display associated with the window
* - `SDL_PROPERTY_WINDOW_X11_SCREEN_NUMBER` ("SDL.window.x11.screen"): the * - `SDL_PROPERTY_WINDOW_X11_SCREEN_NUMBER`: the
* screen number associated with the window * screen number associated with the window
* - `SDL_PROPERTY_WINDOW_X11_WINDOW_NUMBER` ("SDL.window.x11.window"): the * - `SDL_PROPERTY_WINDOW_X11_WINDOW_NUMBER`: the
* X11 Window associated with the window * X11 Window associated with the window
* *
* \param window the window to query * \param window the window to query