Function sdl2_sys::SDL_RenderReadPixels

pub unsafe extern "C" fn SDL_RenderReadPixels(
    renderer: *mut SDL_Renderer,
    rect: *const SDL_Rect,
    format: Uint32,
    pixels: *mut c_void,
    pitch: c_int
) -> c_int

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.

pitch specifies the number of bytes between rows in the destination pixels data. This allows you to write to a subrectangle or have padded rows in the destination. Generally, pitch should equal the number of pixels per row in the pixels data times the number of bytes per pixel, but it might contain additional padding (for example, 24bit RGB Windows Bitmap data pads all rows to multiples of 4 bytes).

\param renderer the rendering context \param rect an SDL_Rect structure representing the area to read, or NULL for the entire render target \param format an SDL_PixelFormatEnum value of the desired format of the pixel data, or 0 to use the format of the rendering target \param pixels a pointer to the pixel data to copy into \param pitch the pitch of the pixels parameter \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.