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

SDL_RenderClear

Clear the current rendering target with the drawing color.

Header File

Syntax

bool SDL_RenderClear(SDL_Renderer *renderer);

Function Parameters

SDL_Renderer *

renderer

the rendering context.

Return Value

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

Remarks

This function clears the entire rendering target, ignoring the viewport and the clip rectangle. Note, that clearing will also set/fill all pixels of the rendering target to current renderer draw color, so make sure to invoke SDL_SetRenderDrawColor() when needed.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.