Mercurial > sdl-ios-xcode
diff docs/man3/SDL_UpdateRects.3 @ 55:55f1f1b3e27d
Added new docs for SDL 1.2.1
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Sun, 10 Jun 2001 19:31:57 +0000 |
parents | 74212992fb08 |
children | e5bc29de3f0a |
line wrap: on
line diff
--- a/docs/man3/SDL_UpdateRects.3 Sun Jun 10 18:39:47 2001 +0000 +++ b/docs/man3/SDL_UpdateRects.3 Sun Jun 10 19:31:57 2001 +0000 @@ -1,4 +1,4 @@ -.TH "SDL_UpdateRects" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_UpdateRects" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_UpdateRects\- Makes sure the given list of rectangles is updated on the given screen\&. .SH "SYNOPSIS" @@ -8,10 +8,18 @@ \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\&. +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 -This function should not be called while \fBscreen\fR is \fIlocked\fR\&. +.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, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42