SDL Wiki
(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_FillSurfaceRect

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

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

bool SDL_FillSurfaceRect(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

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

Version

This function is available since SDL 3.1.3.

See Also


CategoryAPI, CategoryAPIFunction, CategorySurface


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