فهرست منبع

Sync SDL3 wiki -> header

SDL Wiki Bot 1 سال پیش
والد
کامیت
43571769f1
2فایلهای تغییر یافته به همراه49 افزوده شده و 101 حذف شده
  1. 4 38
      include/SDL3/SDL_render.h
  2. 45 63
      include/SDL3/SDL_video.h

+ 4 - 38
include/SDL3/SDL_render.h

@@ -309,13 +309,12 @@ extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_Rend
 /**
  * Get the properties associated with a renderer.
  *
- * The following properties are provided by SDL:
- * ```
- * "SDL.renderer.d3d9.device" - the IDirect3DDevice9 associated with the renderer
+ * The following properties are provided by SDL: "SDL.renderer.d3d9.device" -
+ * the IDirect3DDevice9 associated with the renderer
  * "SDL.renderer.d3d11.device" - the ID3D11Device associated with the renderer
  * "SDL.renderer.d3d12.device" - the ID3D12Device associated with the renderer
- * "SDL.renderer.d3d12.command_queue" - the ID3D12CommandQueue associated with the renderer
- * ```
+ * "SDL.renderer.d3d12.command_queue" - the ID3D12CommandQueue associated with
+ * the renderer
  *
  * \param renderer the rendering context
  * \returns a valid property ID on success or 0 on failure; call
@@ -420,39 +419,6 @@ extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer *
 /**
  * Get the properties associated with a texture.
  *
- * The following properties are provided by SDL:
- *
- * With the direct3d11 renderer:
- * ```
- * "SDL.texture.d3d11.texture" - the ID3D11Texture2D associated with the texture
- * "SDL.texture.d3d11.texture_u" - the ID3D11Texture2D associated with the U plane of a YUV texture
- * "SDL.texture.d3d11.texture_v" - the ID3D11Texture2D associated with the V plane of a YUV texture
- * ```
- *
- * With the direct3d12 renderer:
- * ```
- * "SDL.texture.d3d12.texture" - the ID3D12Resource associated with the texture
- * "SDL.texture.d3d12.texture_u" - the ID3D12Resource associated with the U plane of a YUV texture
- * "SDL.texture.d3d12.texture_v" - the ID3D12Resource associated with the V plane of a YUV texture
- * ```
- *
- * With the opengl renderer:
- * ```
- * "SDL.texture.opengl.texture" - the GLuint texture associated with the texture
- * "SDL.texture.opengl.texture_u" - the GLuint texture associated with the U plane of a YUV texture
- * "SDL.texture.opengl.texture_v" - the GLuint texture associated with the V plane of a YUV texture
- * "SDL.texture.opengl.tex_w" - the 16.16 fixed point texture coordinate width of the texture
- * "SDL.texture.opengl.tex_h" - the 16.16 fixed point texture coordinate height of the texture
- * ```
- *
- * With the opengles2 renderer:
- * ```
- * "SDL.texture.opengles2.texture" - the GLuint texture associated with the texture
- * "SDL.texture.opengles2.texture_uv" - the GLuint texture associated with the UV plane of an NV12 texture
- * "SDL.texture.opengles2.texture_u" - the GLuint texture associated with the U plane of a YUV texture
- * "SDL.texture.opengles2.texture_v" - the GLuint texture associated with the V plane of a YUV texture
- * ```
- *
  * \param texture the texture to query
  * \returns a valid property ID on success or 0 on failure; call
  *          SDL_GetError() for more information.

+ 45 - 63
include/SDL3/SDL_video.h

@@ -936,71 +936,53 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowParent(SDL_Window *window);
  *
  * The following properties are provided by SDL:
  *
- * On Android:
- * ```
- * "SDL.window.android.window" - the ANativeWindow associated with the window
- * "SDL.window.android.surface" - the EGLSurface associated with the window
- * ```
- *
- * On iOS:
- * ```
- * "SDL.window.uikit.window" - the (__unsafe_unretained) UIWindow associated with the window
- * "SDL.window.uikit.metal_view_tag" - the NSInteger tag assocated with metal views on the window
- * ```
- *
- * On KMS/DRM:
- * ```
- * "SDL.window.kmsdrm.dev_index" - the device index associated with the window (e.g. the X in /dev/dri/cardX)
- * "SDL.window.kmsdrm.drm_fd" - the DRM FD associated with the window
- * "SDL.window.kmsdrm.gbm_dev" - the GBM device associated with the window
- * ```
- *
- * On macOS:
- * ```
- * "SDL.window.cocoa.window" - the (__unsafe_unretained) NSWindow associated with the window
- * "SDL.window.cocoa.metal_view_tag" - the NSInteger tag assocated with metal views on the window
- * ```
- *
- * On Vivante:
- * ```
- * "SDL.window.vivante.display" - the EGLNativeDisplayType associated with the window
- * "SDL.window.vivante.window" - the EGLNativeWindowType associated with the window
- * "SDL.window.vivante.surface" - the EGLSurface associated with the window
- * ```
- *
- * On UWP:
- * ```
- * "SDL.window.winrt.window" - the IInspectable CoreWindow associated with the window
- * ```
- *
- * On Windows:
- * ```
- * "SDL.window.win32.hwnd" - the HWND associated with the window
+ * On Android: "SDL.window.android.window" - the ANativeWindow associated with
+ * the window "SDL.window.android.surface" - the EGLSurface associated with
+ * the window
+ *
+ * On iOS: "SDL.window.uikit.window" - the (__unsafe_unretained) UIWindow
+ * associated with the window "SDL.window.uikit.metal_view_tag" - the
+ * NSInteger tag assocated with metal views on the window
+ *
+ * On KMS/DRM: "SDL.window.kmsdrm.dev_index" - the device index associated
+ * with the window (e.g. the X in /dev/dri/cardX) "SDL.window.kmsdrm.drm_fd" -
+ * the DRM FD associated with the window "SDL.window.kmsdrm.gbm_dev" - the GBM
+ * device associated with the window
+ *
+ * On macOS: "SDL.window.cocoa.window" - the (__unsafe_unretained) NSWindow
+ * associated with the window "SDL.window.cocoa.metal_view_tag" - the
+ * NSInteger tag assocated with metal views on the window
+ *
+ * On Vivante: "SDL.window.vivante.display" - the EGLNativeDisplayType
+ * associated with the window "SDL.window.vivante.window" - the
+ * EGLNativeWindowType associated with the window "SDL.window.vivante.surface"
+ * - the EGLSurface associated with the window
+ *
+ * On UWP: "SDL.window.winrt.window" - the IInspectable CoreWindow associated
+ * with the window
+ *
+ * On Windows: "SDL.window.win32.hwnd" - the HWND associated with the window
  * "SDL.window.win32.hdc" - the HDC associated with the window
  * "SDL.window.win32.instance" - the HINSTANCE associated with the window
- * ```
- *
- * On Wayland:
- * ```
- * "SDL.window.wayland.registry" - the wl_registry associated with the window
- * "SDL.window.wayland.display" - the wl_display associated with the window
- * "SDL.window.wayland.surface" - the wl_surface associated with the window
- * "SDL.window.wayland.egl_window" - the wl_egl_window associated with the window
- * "SDL.window.wayland.xdg_surface" - the xdg_surface associated with the window
- * "SDL.window.wayland.xdg_toplevel" - the xdg_toplevel role associated with the window
- * "SDL.window.wayland.xdg_popup" - the xdg_popup role associated with the window
- * "SDL.window.wayland.xdg_positioner" - the xdg_positioner associated with the window, in popup mode
- * ```
- *
- * Note: The xdg_* window objects do not internally persist across window show/hide calls.
- *       They will be null if the window is hidden and must be queried each time it is shown.
- *
- * On X11:
- * ```
- * "SDL.window.x11.display" - the X11 Display associated with the window
- * "SDL.window.x11.screen" - the screen number associated with the window
- * "SDL.window.x11.window" - the X11 Window associated with the window
- * ```
+ *
+ * On Wayland: "SDL.window.wayland.registry" - the wl_registry associated with
+ * the window "SDL.window.wayland.display" - the wl_display associated with
+ * the window "SDL.window.wayland.surface" - the wl_surface associated with
+ * the window "SDL.window.wayland.egl_window" - the wl_egl_window associated
+ * with the window "SDL.window.wayland.xdg_surface" - the xdg_surface
+ * associated with the window "SDL.window.wayland.xdg_toplevel" - the
+ * xdg_toplevel role associated with the window "SDL.window.wayland.xdg_popup"
+ * - the xdg_popup role associated with the window
+ * "SDL.window.wayland.xdg_positioner" - the xdg_positioner associated with
+ * the window, in popup mode
+ *
+ * Note: The xdg_* window objects do not internally persist across window
+ * show/hide calls. They will be null if the window is hidden and must be
+ * queried each time it is shown.
+ *
+ * On X11: "SDL.window.x11.display" - the X11 Display associated with the
+ * window "SDL.window.x11.screen" - the screen number associated with the
+ * window "SDL.window.x11.window" - the X11 Window associated with the window
  *
  * \param window the window to query
  * \returns a valid property ID on success or 0 on failure; call