Initial bulk commit for "Git on MSys"
[msysgit/historical-msysgit.git] / mingw / man / man3 / SDL_UpdateRects.3
blob0db2dee8925cc0a58df98c372f5f0b421c2a77bf
1 .TH "SDL_UpdateRects" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_UpdateRects\- Makes sure the given list of rectangles is updated on the given screen\&.
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBvoid \fBSDL_UpdateRects\fP\fR(\fBSDL_Surface *screen, int numrects, SDL_Rect *rects\fR);
9 .SH "DESCRIPTION"
10 .PP
11 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)\&.
12 .PP
13 This function should not be called while \fBscreen\fR is \fIlocked\fR\&.
14 .PP
15 .RS
16 \fBNote:  
17 .PP
18 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\&.
19 .PP
20 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\&.
21 .RE
22 .SH "SEE ALSO"
23 .PP
24 \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_LockSurface\fP\fR
25 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01