Mercurial > sdl-ios-xcode
comparison docs/man3/SDL_FillRect.3 @ 0:74212992fb08
Initial revision
| author | Sam Lantinga <slouken@lokigames.com> |
|---|---|
| date | Thu, 26 Apr 2001 16:45:43 +0000 |
| parents | |
| children | 55f1f1b3e27d |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:74212992fb08 |
|---|---|
| 1 .TH "SDL_FillRect" "3" "Mon 12 Mar 2001, 01:04" "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 function\&. | |
| 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\&. | |
| 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_BlitSurface\fP\fR, \fI\fBSDL_Rect\fR\fR | |
| 22 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 |