diff options
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_UpdateRects.3')
| -rw-r--r-- | distrib/sdl-1.2.15/docs/man3/SDL_UpdateRects.3 | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_UpdateRects.3 b/distrib/sdl-1.2.15/docs/man3/SDL_UpdateRects.3 new file mode 100644 index 0000000..9ffdb08 --- /dev/null +++ b/distrib/sdl-1.2.15/docs/man3/SDL_UpdateRects.3 @@ -0,0 +1,25 @@ +.TH "SDL_UpdateRects" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" +.SH "NAME" +SDL_UpdateRects \- Makes sure the given list of rectangles is updated on the given screen\&. +.SH "SYNOPSIS" +.PP +\fB#include "SDL\&.h" +.sp +\fBvoid \fBSDL_UpdateRects\fP\fR(\fBSDL_Surface *screen, int numrects, SDL_Rect *rects\fR); +.SH "DESCRIPTION" +.PP +Makes sure the given list of rectangles is updated on the given screen\&. The rectangles must all be confined within the screen boundaries (no clipping is done)\&. +.PP +This function should not be called while \fBscreen\fR is \fIlocked\fR\&. +.PP +.RS +\fBNote: +.PP +It is adviced to call this function only once per frame, since each call has some processing overhead\&. This is no restriction since you can pass any number of rectangles each time\&. +.PP +The rectangles are not automatically merged or checked for overlap\&. In general, the programmer can use his knowledge about his particular rectangles to merge them in an efficient way, to avoid overdraw\&. +.RE +.SH "SEE ALSO" +.PP +\fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_LockSurface\fP\fR +.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |