Sync SDL3 wiki -> header

2024-09-18 15:33:11 +00:00
parent 95f7e53233
commit 026d3c2306
38 changed files with 779 additions and 806 deletions
--- a/include/SDL3/SDL_video.h
+++ b/include/SDL3/SDL_video.h
@@ -475,8 +475,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetDisplayName(SDL_DisplayID displa
 *
 * \param displayID the instance ID of the display to query.
 * \param rect the SDL_Rect structure filled in with the display bounds.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -499,8 +499,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayBounds(SDL_DisplayID displayID, S
 *
 * \param displayID the instance ID of the display to query.
 * \param rect the SDL_Rect structure filled in with the display bounds.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -598,8 +598,8 @@ extern SDL_DECLSPEC SDL_DisplayMode ** SDLCALL SDL_GetFullscreenDisplayModes(SDL
 *                                   the search.
 * \param mode a pointer filled in with the closest display mode equal to or
 *             larger than the desired mode.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -751,8 +751,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowDisplayScale(SDL_Window *window);
 *             borderless fullscreen desktop mode, or one of the fullscreen
 *             modes returned by SDL_GetFullscreenDisplayModes() to set an
 *             exclusive fullscreen mode.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1321,8 +1321,8 @@ extern SDL_DECLSPEC SDL_WindowFlags SDLCALL SDL_GetWindowFlags(SDL_Window *windo
 *
 * \param window the window to change.
 * \param title the desired window title in UTF-8 format.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1358,8 +1358,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window);
 *
 * \param window the window to change.
 * \param icon an SDL_Surface structure containing the icon for the window.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -1395,8 +1395,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surfa
 *          `SDL_WINDOWPOS_UNDEFINED`.
 * \param y the y coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
 *          `SDL_WINDOWPOS_UNDEFINED`.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1419,8 +1419,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x
 *          NULL.
 * \param y a pointer filled in with the y position of the window, may be
 *          NULL.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1453,8 +1453,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowPosition(SDL_Window *window, int *
 * \param window the window to change.
 * \param w the width of the window, must be > 0.
 * \param h the height of the window, must be > 0.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1474,8 +1474,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, in
 * \param window the window to query the width and height from.
 * \param w a pointer filled in with the width of the window, may be NULL.
 * \param h a pointer filled in with the height of the window, may be NULL.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1498,8 +1498,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, i
 * \param window the window to query.
 * \param rect a pointer filled in with the client area that is safe for
 *             interactive content.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -1534,8 +1534,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSafeArea(SDL_Window *window, SDL_R
 *                   limit.
 * \param max_aspect the maximum aspect ratio of the window, or 0.0f for no
 *                   limit.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1552,8 +1552,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAspectRatio(SDL_Window *window, fl
 *                   window, may be NULL.
 * \param max_aspect a pointer filled in with the maximum aspect ratio of the
 *                   window, may be NULL.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1587,8 +1587,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowAspectRatio(SDL_Window *window, fl
 *               border; NULL is permitted.
 * \param right pointer to variable for storing the size of the right border;
 *              NULL is permitted.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1604,8 +1604,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, in
 *          NULL.
 * \param h a pointer to variable for storing the height in pixels, may be
 *          NULL.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1620,8 +1620,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *window, i
 * \param window the window to change.
 * \param min_w the minimum width of the window, or 0 for no limit.
 * \param min_h the minimum height of the window, or 0 for no limit.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1638,8 +1638,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, in
 *          NULL.
 * \param h a pointer filled in with the minimum height of the window, may be
 *          NULL.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1654,8 +1654,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, in
 * \param window the window to change.
 * \param max_w the maximum width of the window, or 0 for no limit.
 * \param max_h the maximum height of the window, or 0 for no limit.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1672,8 +1672,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, in
 *          NULL.
 * \param h a pointer filled in with the maximum height of the window, may be
 *          NULL.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1693,8 +1693,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, in
 *
 * \param window the window of which to change the border state.
 * \param bordered false to remove border, true to add border.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1713,8 +1713,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowBordered(SDL_Window *window, bool
 *
 * \param window the window of which to change the resizable state.
 * \param resizable true to allow resizing, false to disallow.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1729,10 +1729,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowResizable(SDL_Window *window, bool
 * will bring the window to the front and keep the window above the rest.
 *
 * \param window the window of which to change the always on top state.
- * \param on_top true to set the window always on top, false to
- *               disable.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \param on_top true to set the window always on top, false to disable.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1744,8 +1743,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window, bo
 * Show a window.
 *
 * \param window the window to show.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1758,8 +1757,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShowWindow(SDL_Window *window);
 * Hide a window.
 *
 * \param window the window to hide.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1778,8 +1777,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HideWindow(SDL_Window *window);
 * the window will have the SDL_WINDOW_INPUT_FOCUS flag set.
 *
 * \param window the window to raise.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -1806,8 +1805,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RaiseWindow(SDL_Window *window);
 * and Wayland window managers may vary.
 *
 * \param window the window to maximize.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1830,8 +1829,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_MaximizeWindow(SDL_Window *window);
 * deny the state change.
 *
 * \param window the window to minimize.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1855,8 +1854,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_MinimizeWindow(SDL_Window *window);
 * deny the state change.
 *
 * \param window the window to restore.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1883,10 +1882,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RestoreWindow(SDL_Window *window);
 * is just a request, it can be denied by the windowing system.
 *
 * \param window the window to change.
- * \param fullscreen true for fullscreen mode, false for windowed
- *                   mode.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \param fullscreen true for fullscreen mode, false for windowed mode.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1910,8 +1908,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, boo
 *
 * \param window the window for which to wait for the pending state to be
 *               applied.
- * \returns true on success or false if the operation timed out before
- *          the window was in the requested state.
+ * \returns true on success or false if the operation timed out before the
+ *          window was in the requested state.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1929,8 +1927,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SyncWindow(SDL_Window *window);
 * Return whether the window has a surface associated with it.
 *
 * \param window the window to query.
- * \returns true if there is a surface associated with the window, or
- *          false otherwise.
+ * \returns true if there is a surface associated with the window, or false
+ *          otherwise.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1980,8 +1978,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window *windo
 *
 * \param window the window.
 * \param vsync the vertical refresh sync interval.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -1998,8 +1996,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSurfaceVSync(SDL_Window *window, i
 * \param window the window to query.
 * \param vsync an int filled with the current vertical refresh sync interval.
 *              See SDL_SetWindowSurfaceVSync() for the meaning of the value.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2016,8 +2014,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSurfaceVSync(SDL_Window *window, i
 * This function is equivalent to the SDL 1.2 API SDL_Flip().
 *
 * \param window the window to update.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2043,8 +2041,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurface(SDL_Window *window);
 * \param rects an array of SDL_Rect structures representing areas of the
 *              surface to copy, in pixels.
 * \param numrects the number of rectangles.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2057,8 +2055,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window
 * Destroy the surface associated with the window.
 *
 * \param window the window to update.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2088,8 +2086,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_DestroyWindowSurface(SDL_Window *window);
 *
 * \param window the window for which the keyboard grab mode should be set.
 * \param grabbed this is true to grab keyboard, and false to release.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2105,8 +2103,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *window, b
 *
 * \param window the window for which the mouse grab mode should be set.
 * \param grabbed this is true to grab mouse, and false to release.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2160,8 +2158,8 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
 * \param window the window that will be associated with the barrier.
 * \param rect a rectangle area in window-relative coordinates. If NULL the
 *             barrier for the specified window will be destroyed.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2189,13 +2187,12 @@ extern SDL_DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window *
 * The parameter `opacity` will be clamped internally between 0.0f
 * (transparent) and 1.0f (opaque).
 *
- * This function also returns false if setting the opacity isn't
- * supported.
+ * This function also returns false if setting the opacity isn't supported.
 *
 * \param window the window which will be made transparent or opaque.
 * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque).
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2235,8 +2232,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window);
 *
 * \param window the window that should become the child of a parent.
 * \param parent the new parent window for the child window.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2251,10 +2248,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowParent(SDL_Window *window, SDL_Win
 * window of a parent, or toggling modal status on will fail.
 *
 * \param window the window on which to set the modal state.
- * \param modal true to toggle modal status on, false to toggle it
- *              off.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \param modal true to toggle modal status on, false to toggle it off.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2266,10 +2262,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowModal(SDL_Window *window, bool mod
 * Set whether the window may have input focus.
 *
 * \param window the window to set focusable state.
- * \param focusable true to allow input focus, false to not allow
- *                  input focus.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \param focusable true to allow input focus, false to not allow input focus.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -2292,8 +2287,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFocusable(SDL_Window *window, bool
 *          the client area.
 * \param y the y coordinate of the menu, relative to the origin (top-left) of
 *          the client area.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -2369,8 +2364,8 @@ typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
 * \param window the window to set hit-testing on.
 * \param callback the function to call when doing a hit-test.
 * \param callback_data an app-defined void pointer passed to **callback**.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -2393,8 +2388,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_Hi
 * \param window the window.
 * \param shape the surface representing the shape of the window, or NULL to
 *              remove any current shape.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -2405,8 +2400,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surf
 *
 * \param window the window to be flashed.
 * \param operation the operation to perform.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -2436,8 +2431,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window *window);
 *
 * The default can also be changed using `SDL_HINT_VIDEO_ALLOW_SCREENSAVER`.
 *
- * \returns true if the screensaver is enabled, false if it is
- *          disabled.
+ * \returns true if the screensaver is enabled, false if it is disabled.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2449,8 +2443,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ScreenSaverEnabled(void);
 /**
 * Allow the screen to be blanked by a screen saver.
 *
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2468,8 +2462,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EnableScreenSaver(void);
 * The screensaver is disabled by default, but this may by changed by
 * SDL_HINT_VIDEO_ALLOW_SCREENSAVER.
 *
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2496,8 +2490,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_DisableScreenSaver(void);
 *
 * \param path the platform dependent OpenGL library name, or NULL to open the
 *             default OpenGL library.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2627,8 +2621,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
 * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to
 *             set.
 * \param value the desired value for the attribute.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2643,8 +2637,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value)
 * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to
 *             get.
 * \param value a pointer filled in with the current value of `attr`.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2682,8 +2676,8 @@ extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *windo
 *
 * \param window the window to associate with the context.
 * \param context the OpenGL context to associate with the window.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2790,8 +2784,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_EGL_SetAttributeCallbacks(SDL_EGLAttribArra
 *
 * \param interval 0 for immediate updates, 1 for updates synchronized with
 *                 the vertical retrace, -1 for adaptive vsync.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2809,8 +2803,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetSwapInterval(int interval);
 *                 synchronization, 1 if the buffer swap is synchronized with
 *                 the vertical retrace, and -1 if late swaps happen
 *                 immediately instead of waiting for the next retrace.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *
@@ -2829,8 +2823,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetSwapInterval(int *interval);
 * extra.
 *
 * \param window the window to change.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 */
@@ -2840,8 +2834,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_SwapWindow(SDL_Window *window);
 * Delete an OpenGL context.
 *
 * \param context the OpenGL context to be deleted.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
 *
 * \since This function is available since SDL 3.0.0.
 *