From 2a0223487fb0f9b07c1b980d97e875d38fea634e Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Sun, 2 Mar 2025 15:53:56 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
[ci skip]
---
include/SDL3/SDL_mouse.h | 46 +++++++++++++++++++++++----------------
include/SDL3/SDL_render.h | 5 +++--
2 files changed, 30 insertions(+), 21 deletions(-)
diff --git a/include/SDL3/SDL_mouse.h b/include/SDL3/SDL_mouse.h
index b190e9d4359f8..c49285e65d04c 100644
--- a/include/SDL3/SDL_mouse.h
+++ b/include/SDL3/SDL_mouse.h
@@ -150,22 +150,29 @@ typedef Uint32 SDL_MouseButtonFlags;
/**
* A callback used to transform mouse motion delta from raw values.
*
- * This is called during SDL's handling of platform mouse events to
- * scale the values of the resulting motion delta.
- *
- * \param userdata what was passed as `userdata` to SDL_SetRelativeMouseTransform().
- * \param timestamp the associated time at which this mouse motion event was received.
- * \param window the associated window to which this mouse motion event was addressed.
- * \param mouseID the associated mouse from which this mouse motion event was emitted.
- * \param x pointer to a variable that will be treated as the resulting x-axis motion.
- * \param y pointer to a variable that will be treated as the resulting y-axis motion.
- *
- * \threadsafety This callback is called by SDL's internal mouse input processing
- * procedure, which may be a thread separate from the main event loop
- * that is run at realtime priority. Stalling this thread with too much
- * work in the callback can therefore potentially freeze the entire
- * system. Care should be taken with proper synchronization practices
- * when adding other side effects beyond mutation of the x and y values.
+ * This is called during SDL's handling of platform mouse events to scale the
+ * values of the resulting motion delta.
+ *
+ * \param userdata what was passed as `userdata` to
+ * SDL_SetRelativeMouseTransform().
+ * \param timestamp the associated time at which this mouse motion event was
+ * received.
+ * \param window the associated window to which this mouse motion event was
+ * addressed.
+ * \param mouseID the associated mouse from which this mouse motion event was
+ * emitted.
+ * \param x pointer to a variable that will be treated as the resulting x-axis
+ * motion.
+ * \param y pointer to a variable that will be treated as the resulting y-axis
+ * motion.
+ *
+ * \threadsafety This callback is called by SDL's internal mouse input
+ * processing procedure, which may be a thread separate from the
+ * main event loop that is run at realtime priority. Stalling
+ * this thread with too much work in the callback can therefore
+ * potentially freeze the entire system. Care should be taken
+ * with proper synchronization practices when adding other side
+ * effects beyond mutation of the x and y values.
*
* \since This datatype is available since SDL 3.2.6.
*
@@ -414,11 +421,12 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WarpMouseGlobal(float x, float y);
/**
* Set a user-defined function by which to transform relative mouse inputs.
+ *
* This overrides the relative system scale and relative speed scale hints.
* Should be called prior to enabling relative mouse mode, fails otherwise.
- *
- * \param callback a callback used to transform relative mouse motion,
- or NULL for default behavior.
+ *
+ * \param callback a callback used to transform relative mouse motion, or NULL
+ * for default behavior.
* \param userdata a pointer that will be passed to `callback`.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h
index a41cb46c15f58..29ddfa35ca5f2 100644
--- a/include/SDL3/SDL_render.h
+++ b/include/SDL3/SDL_render.h
@@ -2258,8 +2258,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTexture9Grid(SDL_Renderer *renderer,
* corner of `dstrect`, or 0.0f for an unscaled copy.
* \param dstrect a pointer to the destination rectangle, or NULL for the
* entire rendering target.
- * \param tileScale the scale used to transform the borders and center of `srcrect` into the
- * borders and middle of `dstrect`, or 1.0f for an unscaled copy.
+ * \param tileScale the scale used to transform the borders and center of
+ * `srcrect` into the borders and middle of `dstrect`, or
+ * 1.0f for an unscaled copy.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*