From f7f9478caf2fb61fabfc9b31bd6a0b3abc56a791 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Tue, 16 Jan 2024 15:23:56 -0500 Subject: [PATCH] docs: Note SDL_UpdateWindowSurfaceRects can update beyond specified areas. Reference Issue #8825. --- include/SDL_video.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/SDL_video.h b/include/SDL_video.h index 3e1c8a86a..fa47d3099 100644 --- a/include/SDL_video.h +++ b/include/SDL_video.h @@ -1341,6 +1341,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