SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Clear the current rendering target with the drawing color.


int SDL_RenderClear(SDL_Renderer *renderer);

Function Parameters

renderer the rendering context

Return Value

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


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


This function is available since SDL 3.0.0.

Code Examples

#include "SDL.h"

int main(int argc, char* argv[])
        SDL_Window* window;
        SDL_Renderer* renderer;

        /* Initialize SDL. */
        if (SDL_Init(SDL_INIT_VIDEO) < 0)
                return 1;

        /* Create the window where we will draw. */
        window = SDL_CreateWindow("SDL_RenderClear",
                        512, 512,

        /* We must call SDL_CreateRenderer in order for draw calls to affect this window. */
        renderer = SDL_CreateRenderer(window, NULL, 0);

        /* Select the color for drawing. It is set to red here. */
        SDL_SetRenderDrawColor(renderer, 255, 0, 0, 255);

        /* Clear the entire screen to our selected color. */

        /* Up until now everything was drawn behind the scenes.
           This will show the new, red contents of the window. */

        /* Give us time to see the window. */

        /* Always be sure to clean up */
        return 0;

CategoryAPI, CategoryRender

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.