From 33e7238268b179a19e74a263e964ac054ba5d944 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Thu, 9 May 2024 09:16:46 -0700
Subject: [PATCH] Clarified the meaning of the cursor hotspot (thanks
@nbriggs!)
Fixes https://github.com/libsdl-org/sdlwiki/issues/380
---
include/SDL3/SDL_mouse.h | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/include/SDL3/SDL_mouse.h b/include/SDL3/SDL_mouse.h
index 943203154d022..dc7c94d8a39ed 100644
--- a/include/SDL3/SDL_mouse.h
+++ b/include/SDL3/SDL_mouse.h
@@ -359,10 +359,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void);
* \param mask the mask value for each pixel of the cursor
* \param w the width of the cursor
* \param h the height of the cursor
- * \param hot_x the X-axis location of the upper left corner of the cursor
- * relative to the actual mouse position
- * \param hot_y the Y-axis location of the upper left corner of the cursor
- * relative to the actual mouse position
+ * \param hot_x the x-axis offset from the left of the cursor image to the mouse x position, in the range of 0 to `w` - 1
+ * \param hot_y the y-axis offset from the top of the cursor image to the mouse y position, in the range of 0 to `h` - 1
* \returns a new cursor with the specified parameters on success or NULL on
* failure; call SDL_GetError() for more information.
*