SDL_RenderClear(3)

SDL_RenderClear3

Clear the current rendering target with the drawing color.

Usage

#include "SDL3/SDL.h"

bool SDL_RenderClear(SDL_Renderer *renderer);

Header file

Defined in SDL3/SDL_render.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.