SDL_FillSurfaceRect(3)

SDL_FillSurfaceRect3

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

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_surface.h

Overview

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 is not thread safe.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.