SDL_RenderReadPixels
Use this function to read pixels from the current rendering target.
使用该函数可以从当前渲染目标中读取像素数据。
Syntax 语法
int SDL_RenderReadPixels(SDL_Renderer* renderer,
const SDL_Rect* rect,
Uint32 format,
void* pixels,
int pitch)
Function Parameters 函数参数
renderer | the rendering context | 渲染器 |
rect | an SDL_Rect structure representing the area to read, or NULL for the entire render target | 代表要读取的矩形区域的SDL_Rect结构 |
format | the desired format of the pixel data, or 0 to use the format of the rendering target; see Remarks for details | 像素数据所需求的格式,或者为0表示用渲染目标的格式。查看注意以获取详细信息 |
pixels | a pointer filled in with the pixel data | 用来储存像素数据的指针 |
pitch | the pitch of the pixels parameter | pixels参数的对齐值(pitch: 矩形中每一行像素的字节数,译注) |
Return Value 返回值
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
执行成功返回0,若失败则返回一个负的错误码。调用SDL_GetError()以获取更多错误信息。
Code Examples 代码示例
暂无
Remarks 注意
WARNING: This is a very slow operation, and should not be used frequently.
警告:该操作很缓慢,不应该频繁使用。
format may be one of the following:
参数format可以是以下值中的一个:
SDL_PIXELFORMAT_UNKNOWN | |
SDL_PIXELFORMAT_INDEX1LSB | |
SDL_PIXELFORMAT_INDEX1MSB | |
SDL_PIXELFORMAT_INDEX4LSB | |
SDL_PIXELFORMAT_INDEX4MSB | |
SDL_PIXELFORMAT_INDEX8 | |
SDL_PIXELFORMAT_RGB332 | |
SDL_PIXELFORMAT_RGB444 | |
SDL_PIXELFORMAT_RGB555 | |
SDL_PIXELFORMAT_BGR555 | |
SDL_PIXELFORMAT_ARGB4444 | |
SDL_PIXELFORMAT_RGBA4444 | |
SDL_PIXELFORMAT_ABGR4444 | |
SDL_PIXELFORMAT_BGRA4444 | |
SDL_PIXELFORMAT_ARGB1555 | |
SDL_PIXELFORMAT_RGBA5551 | |
SDL_PIXELFORMAT_ABGR1555 | |
SDL_PIXELFORMAT_BGRA5551 | |
SDL_PIXELFORMAT_RGB565 | |
SDL_PIXELFORMAT_BGR565 | |
SDL_PIXELFORMAT_RGB24 | |
SDL_PIXELFORMAT_BGR24 | |
SDL_PIXELFORMAT_RGB888 | |
SDL_PIXELFORMAT_RGBX8888 | |
SDL_PIXELFORMAT_BGR888 | |
SDL_PIXELFORMAT_BGRX8888 | |
SDL_PIXELFORMAT_ARGB8888 | |
SDL_PIXELFORMAT_RGBA8888 | |
SDL_PIXELFORMAT_ABGR8888 | |
SDL_PIXELFORMAT_BGRA8888 | |
SDL_PIXELFORMAT_ARGB2101010 | |
SDL_PIXELFORMAT_RGBA32 | alias for RGBA byte array of color data, for the current platform (>= SDL 2.0.5) |
SDL_PIXELFORMAT_ARGB32 | alias for ARGB byte array of color data, for the current platform (>= SDL 2.0.5) |
SDL_PIXELFORMAT_BGRA32 | alias for BGRA byte array of color data, for the current platform (>= SDL 2.0.5) |
SDL_PIXELFORMAT_ABGR32 | alias for ABGR byte array of color data, for the current platform (>= SDL 2.0.5) |
SDL_PIXELFORMAT_YV12 | planar mode: Y + V + U (3 planes) |
SDL_PIXELFORMAT_IYUV | planar mode: Y + U + V (3 planes) |
SDL_PIXELFORMAT_YUY2 | packed mode: Y0+U0+Y1+V0 (1 plane) |
SDL_PIXELFORMAT_UYVY | packed mode: U0+Y0+V0+Y1 (1 plane) |
SDL_PIXELFORMAT_YVYU | packed mode: Y0+V0+Y1+U0 (1 plane) |
SDL_PIXELFORMAT_NV12 | planar mode: Y + U/V interleaved (2 planes) (>= SDL 2.0.4) |
SDL_PIXELFORMAT_NV21 | planar mode: Y + V/U interleaved (2 planes) (>= SDL 2.0.4) |
Translated by SteDeshain
Reference to http://wiki.libsdl.org/SDL_RenderReadPixels