Clarified API documentation
authorSam Lantinga <slouken@libsdl.org>
Sun, 02 Aug 2009 18:39:57 +0000
changeset 3227458e53d8662c
parent 3226 7a9740b1c1a8
child 3228 9ec661afdf5f
Clarified API documentation
include/SDL_video.h
     1.1 --- a/include/SDL_video.h	Sun Aug 02 18:39:24 2009 +0000
     1.2 +++ b/include/SDL_video.h	Sun Aug 02 18:39:57 2009 +0000
     1.3 @@ -1255,7 +1255,7 @@
     1.4   * \brief Read pixels from the current rendering target.
     1.5   *
     1.6   * \param rect A pointer to the rectangle to read, or NULL for the entire render target
     1.7 - * \param pixels A pointer to be filled in with the pixel data
     1.8 + * \param pixels A pointer to be filled in with the pixel data in the rendering target format
     1.9   * \param pitch The pitch of the pixels parameter
    1.10   *
    1.11   * \return 0 on success, or -1 if pixel reading is not supported.