SDL: docs: Note SDL_UpdateWindowSurfaceRects can update beyond specified areas. (8bf74)

From 8bf74280e0a469c9225c6c3b3ed8823ab939fbc4 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Tue, 16 Jan 2024 15:26:13 -0500
Subject: [PATCH] docs: Note SDL_UpdateWindowSurfaceRects can update beyond
 specified areas.

Reference Issue #8825.
---
 include/SDL3/SDL_video.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h
index 0f4f5bb9cc87..e57756c7d3be 100644
--- a/include/SDL3/SDL_video.h
+++ b/include/SDL3/SDL_video.h
@@ -1729,6 +1729,11 @@ extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window *window);
  *
  * This function is equivalent to the SDL 1.2 API SDL_UpdateRects().
  *
+ * Note that this function will update _at least_ the rectangles specified,
+ * but this is only intended as an optimization; in practice, this might
+ * update more of the screen (or all of the screen!), depending on what
+ * method SDL uses to send pixels to the system.
+ *
  * \param window the window to update
  * \param rects an array of SDL_Rect structures representing areas of the
  *              surface to copy, in pixels