diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_FillRect.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,22 @@
+.TH "SDL_FillRect" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" 
+.SH "NAME"
+SDL_FillRect\- This function performs a fast fill of the given rectangle with some color
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBint \fBSDL_FillRect\fP\fR(\fBSDL_Surface *dst, SDL_Rect *dstrect, Uint32 color\fR);
+.SH "DESCRIPTION"
+.PP
+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\&.
+.PP
+The color should be a pixel of the format used by the surface, and can be generated by the \fISDL_MapRGB\fR function\&.
+.PP
+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\&.
+.SH "RETURN VALUE"
+.PP
+This function returns \fB0\fR on success, or \fB-1\fR on error\&.
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Rect\fR\fR
+...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04