Mercurial > sdl-ios-xcode

comparison docs/man3/SDL_UpdateRects.3 @ 55:55f1f1b3e27d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
54:028447a8a758 55:55f1f1b3e27d
1 .TH "SDL_UpdateRects" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" 1 .TH "SDL_UpdateRects" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
2 .SH "NAME" 2 .SH "NAME"
3 SDL_UpdateRects\- Makes sure the given list of rectangles is updated on the given screen\&. 3 SDL_UpdateRects\- Makes sure the given list of rectangles is updated on the given screen\&.
4 .SH "SYNOPSIS" 4 .SH "SYNOPSIS"
5 .PP 5 .PP
6 \fB#include "SDL\&.h" 6 \fB#include "SDL\&.h"
7 .sp 7 .sp
8 \fBvoid \fBSDL_UpdateRects\fP\fR(\fBSDL_Surface *screen, int numrects, SDL_Rect *rects\fR); 8 \fBvoid \fBSDL_UpdateRects\fP\fR(\fBSDL_Surface *screen, int numrects, SDL_Rect *rects\fR);
9 .SH "DESCRIPTION" 9 .SH "DESCRIPTION"
10 .PP 10 .PP
11 Makes sure the given list of rectangles is updated on the given screen\&. 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 12 .PP
13 This function should not be called while \fBscreen\fR is \fIlocked\fR\&. 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
14 .SH "SEE ALSO" 22 .SH "SEE ALSO"
15 .PP 23 .PP
16 \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_LockSurface\fP\fR 24 \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_LockSurface\fP\fR
17 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 25 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42