Scroll to navigation

SDL_FillSurfaceRect(3) SDL3 FUNCTIONS SDL_FillSurfaceRect(3)

NAME

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

HEADER FILE

Defined in SDL3/SDL_surface.h

SYNOPSIS

#include "SDL3/SDL.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

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

RETURN VALUE

Returns true on success or false on failure; call

SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

(3), SDL_FillSurfaceRects(3)

SDL 3.1.6 Simple Directmedia Layer