SDL_FillSurfaceRect - Man Page

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

Synopsis

#include <SDL3/SDL_surface.h>

bool SDL_FillSurfaceRect(SDL_Surface *dst, const SDL_Rect *rect, Uint32 color);

Description

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_SetSurfaceClipRect()), then this function will fill based on the intersection of the clip rectangle and rect.

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 true on success or false on failure; call SDL_GetError() for more information.

Thread Safety

This function can be called on different threads with different surfaces.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_FillSurfaceRects(3)

Referenced By

SDL_FillSurfaceRects(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS