changeset 3227:458e53d8662c

Clarified API documentation
author Sam Lantinga <slouken@libsdl.org>
date Sun, 02 Aug 2009 18:39:57 +0000
parents 7a9740b1c1a8
children 9ec661afdf5f
files include/SDL_video.h
diffstat 1 files changed, 1 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/include/SDL_video.h	Sun Aug 02 18:39:24 2009 +0000
+++ b/include/SDL_video.h	Sun Aug 02 18:39:57 2009 +0000
@@ -1255,7 +1255,7 @@
  * \brief Read pixels from the current rendering target.
  *
  * \param rect A pointer to the rectangle to read, or NULL for the entire render target
- * \param pixels A pointer to be filled in with the pixel data
+ * \param pixels A pointer to be filled in with the pixel data in the rendering target format
  * \param pitch The pitch of the pixels parameter
  *
  * \return 0 on success, or -1 if pixel reading is not supported.