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

SDL_FillRect

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

Syntax

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

Function Parameters

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

Return Value

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.


CategoryAPI


[ 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.