SDL_FillRect

Perform a fast fill of a rectangle with a specific color.

Header File

Syntax

int SDL_FillRect
    (SDL_Surface * dst, const SDL_Rect * rect, Uint32 color);

Function Parameters

SDL_Surface *	dst	the SDL_Surface structure that is the drawing target.
const SDL_Rect *	rect	the SDL_Rect structure representing the rectangle to fill, or NULL to fill the entire surface.
Uint32	color	the color to fill with.

Return Value

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

Remarks

color should be a pixel of the format used by the surface, and can be generated by SDL_MapRGB() or SDL_MapRGBA(). If the color value contains an alpha component then the destination is simply filled with that alpha information, no blending takes place.

If there is a clip rectangle set on the destination (set via SDL_SetClipRect()), then this function will fill based on the intersection of the clip rectangle and rect.

Version

This function is available since SDL 2.0.0.