(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetRenderTarget

Set a texture as the current rendering target.

Header File

Syntax

bool SDL_SetRenderTarget(SDL_Renderer *renderer, SDL_Texture *texture);

Function Parameters

SDL_Renderer *	renderer	the rendering context.
SDL_Texture *	texture	the targeted texture, which must be created with the `SDL_TEXTUREACCESS_TARGET` flag, or NULL to render to the window instead of a texture.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

The default render target is the window for which the renderer was created. To stop rendering to a texture and render to the window again, call this function with a NULL texture.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.