SDL_SetRenderTarget - Man Page

Set a texture as the current rendering target.

Header File

Defined in SDL3/SDL_render.h

Synopsis

#include "SDL3/SDL.h"

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

Description

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 .

Function Parameters

renderer

the rendering context.

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

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread Safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_GetRenderTarget(3)

Referenced By

SDL_GetRenderTarget(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS