misc/builddeps/win64/sdl/share/man/man3/SDL_FillRect.3

   1 .TH "SDL_FillRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
   2 .SH "NAME"
   3 SDL_FillRect \- This function performs a fast fill of the given rectangle with some color
   4 .SH "SYNOPSIS"
   5 .PP
   6 \fB#include "SDL\&.h"
   7 .sp
   8 \fBint \fBSDL_FillRect\fP\fR(\fBSDL_Surface *dst, SDL_Rect *dstrect, Uint32 color\fR);
   9 .SH "DESCRIPTION"
  10 .PP
  11 This function performs a fast fill of the given rectangle with \fBcolor\fR\&. If \fBdstrect\fR is \fBNULL\fP, the whole surface will be filled with \fBcolor\fR\&.
  12 .PP
  13 The color should be a pixel of the format used by the surface, and can be generated by the \fISDL_MapRGB\fR or \fISDL_MapRGBA\fR functions\&. If the color value contains an alpha value then the destination is simply "filled" with that alpha information, no blending takes place\&.
  14 .PP
  15 If there is a clip rectangle set on the destination (set via \fISDL_SetClipRect\fR) then this function will clip based on the intersection of the clip rectangle and the \fBdstrect\fR rectangle and the dstrect rectangle will be modified to represent the area actually filled\&.
  16 .SH "RETURN VALUE"
  17 .PP
  18 This function returns \fB0\fR on success, or \fB-1\fR on error\&.
  19 .SH "SEE ALSO"
  20 .PP
  21 \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Rect\fR\fR
  22 .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01