Commit 40b7326b384aef84d3a688babb304bc2f333b6f7

Sam Lantinga 2022-03-18T10:28:38

Added a note that SDL_RenderReadPixels() should be called before SDL_RenderPresent()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
diff --git a/include/SDL_render.h b/include/SDL_render.h
index c33094d..53d6995 100644
--- a/include/SDL_render.h
+++ b/include/SDL_render.h
@@ -1662,7 +1662,8 @@ extern DECLSPEC int SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer,
  * Read pixels from the current rendering target to an array of pixels.
  *
  * **WARNING**: This is a very slow operation, and should not be used
- * frequently.
+ * frequently. If you're using this on the main rendering target, it
+ * should be called after rendering and before SDL_RenderPresent().
  *
  * `pitch` specifies the number of bytes between rows in the destination
  * `pixels` data. This allows you to write to a subrectangle or have padded