table of contents
SDL_RenderReadPixels(3) | SDL3 FUNCTIONS | SDL_RenderReadPixels(3) |
NAME¶
SDL_RenderReadPixels - Read pixels from the current rendering target.
HEADER FILE¶
Defined in SDL3/SDL_render.h
SYNOPSIS¶
#include "SDL3/SDL.h"
SDL_Surface * SDL_RenderReadPixels(SDL_Renderer *renderer, const SDL_Rect *rect);
DESCRIPTION¶
The returned surface should be freed with
SDL_DestroySurface () WARNING : This is a very slow operation, and should not be used frequently. If you're using this on the main rendering target, it should be called after rendering and before SDL_RenderPresent ().
FUNCTION PARAMETERS¶
RETURN VALUE¶
( SDL_Surface
*) Returns a new SDL_Surface
on success or NULL on failure; call SDL_GetError () for more
information.
THREAD SAFETY¶
You may only call this function from the main thread.
AVAILABILITY¶
This function is available since SDL 3.1.3.
SDL 3.1.6 | Simple Directmedia Layer |