Browse Source

Sync SDL3 wiki -> header

[ci skip]
SDL Wiki Bot 3 days ago
parent
commit
5bbf1dcb44
2 changed files with 11 additions and 6 deletions
  1. 7 3
      include/SDL3/SDL_hints.h
  2. 4 3
      include/SDL3/SDL_mouse.h

+ 7 - 3
include/SDL3/SDL_hints.h

@@ -2693,12 +2693,16 @@ extern "C" {
 #define SDL_HINT_MOUSE_DEFAULT_SYSTEM_CURSOR "SDL_MOUSE_DEFAULT_SYSTEM_CURSOR"
 
 /**
- * A variable setting whether we should scale cursors by the current display scale.
+ * A variable setting whether we should scale cursors by the current display
+ * scale.
  *
  * The variable can be set to the following values:
  *
- * - "0": Cursors will not change size based on the display content scale. (default)
- * - "1": Cursors will automatically match the display content scale (e.g. a 2x sized cursor will be used when the window is on a monitor with 200% scale). This is currently implemented on Windows and Wayland.
+ * - "0": Cursors will not change size based on the display content scale.
+ *   (default)
+ * - "1": Cursors will automatically match the display content scale (e.g. a
+ *   2x sized cursor will be used when the window is on a monitor with 200%
+ *   scale). This is currently implemented on Windows and Wayland.
  *
  * This hint needs to be set before creating cursors.
  *

+ 4 - 3
include/SDL3/SDL_mouse.h

@@ -593,9 +593,10 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateCursor(const Uint8 *data,
  * If this function is passed a surface with alternate representations added
  * with SDL_AddSurfaceAlternateImage(), the surface will be interpreted as the
  * content to be used for 100% display scale, and the alternate
- * representations will be used for high DPI situations if SDL_HINT_MOUSE_DPI_SCALE_CURSORS is enabled. For example, if the
- * original surface is 32x32, then on a 2x macOS display or 200% display scale
- * on Windows, a 64x64 version of the image will be used, if available. If a
+ * representations will be used for high DPI situations if
+ * SDL_HINT_MOUSE_DPI_SCALE_CURSORS is enabled. For example, if the original
+ * surface is 32x32, then on a 2x macOS display or 200% display scale on
+ * Windows, a 64x64 version of the image will be used, if available. If a
  * matching version of the image isn't available, the closest larger size
  * image will be downscaled to the appropriate size and be used instead, if
  * available. Otherwise, the closest smaller image will be upscaled and be