SDL_RenderClear - Man Page
Clear the current rendering target with the drawing color.
Header File
Defined in SDL3/SDL_render.h
Synopsis
#include "SDL3/SDL.h" bool SDL_RenderClear(SDL_Renderer *renderer);
Description
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.
Function Parameters
- renderer
the rendering context.
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
Referenced By
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS