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

This commit is contained in:
Sam Lantinga 2022-03-18 10:28:38 -07:00
parent 6c96217727
commit 40b7326b38

View file

@ -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