(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_RenderClear

Clear the current rendering target with the drawing color.

Header File

Defined in SDL_render.h

Syntax

int SDL_RenderClear(SDL_Renderer * renderer);

Function Parameters

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

This function clears the entire rendering target, ignoring the viewport and the clip rectangle.

Version

This function is available since SDL 2.0.0.

See Also

• SDL_SetRenderDrawColor

CategoryAPI, CategoryAPIFunction, CategoryRender