Mercurial > sdl-ios-xcode

comparison include/SDL_video.h @ 3227:458e53d8662c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clarified API documentation
author Sam Lantinga <slouken@libsdl.org>
date Sun, 02 Aug 2009 18:39:57 +0000
parents b425c3e2b796
children 4ec48602f1db
comparison
equal deleted inserted replaced
3226:7a9740b1c1a8 3227:458e53d8662c
1253 * \fn int SDL_RenderReadPixels(const SDL_Rect *rect, void *pixels, int pitch) 1253 * \fn int SDL_RenderReadPixels(const SDL_Rect *rect, void *pixels, int pitch)
1254 * 1254 *
1255 * \brief Read pixels from the current rendering target. 1255 * \brief Read pixels from the current rendering target.
1256 * 1256 *
1257 * \param rect A pointer to the rectangle to read, or NULL for the entire render target 1257 * \param rect A pointer to the rectangle to read, or NULL for the entire render target
1258 * \param pixels A pointer to be filled in with the pixel data 1258 * \param pixels A pointer to be filled in with the pixel data in the rendering target format
1259 * \param pitch The pitch of the pixels parameter 1259 * \param pitch The pitch of the pixels parameter
1260 * 1260 *
1261 * \return 0 on success, or -1 if pixel reading is not supported. 1261 * \return 0 on success, or -1 if pixel reading is not supported.
1262 * 1262 *
1263 * \warning This is a very slow operation, and should not be used frequently. 1263 * \warning This is a very slow operation, and should not be used frequently.