docs: Note SDL_UpdateWindowSurfaceRects can update beyond specified areas.

Reference Issue #8825.
This commit is contained in:
Ryan C. Gordon 2024-01-16 15:23:56 -05:00
parent 9db80adfba
commit f7f9478caf
No known key found for this signature in database
GPG key ID: FA148B892AB48044

View file

@ -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(). * 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 window the window to update
* \param rects an array of SDL_Rect structures representing areas of the * \param rects an array of SDL_Rect structures representing areas of the
* surface to copy, in pixels * surface to copy, in pixels