SDL_ClearSurface - Man Page
Clear a surface with a specific color, with floating point precision.
Header File
Defined in SDL3/SDL_surface.h
Synopsis
#include "SDL3/SDL.h" bool SDL_ClearSurface(SDL_Surface *surface, float r, float g, float b, float a);
Description
This function handles all surface formats, and ignores any clip rectangle.
If the surface is YUV, the color is assumed to be in the sRGB colorspace, otherwise the color is assumed to be in the colorspace of the suface.
Function Parameters
- surface
the SDL_Surface
to clear.- r
the red component of the pixel, normally in the range 0-1.
- g
the green component of the pixel, normally in the range 0-1.
- b
the blue component of the pixel, normally in the range 0-1.
- a
the alpha component of the pixel, normally in the range 0-1.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Availability
This function is available since SDL 3.2.0.
Info
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS