Mercurial > sdl-ios-xcode
annotate docs/html/sdlupdaterects.html @ 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 |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_UpdateRects</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
0 | 8 "><LINK |
9 REL="HOME" | |
10 TITLE="SDL Library Documentation" | |
11 HREF="index.html"><LINK | |
12 REL="UP" | |
13 TITLE="Video" | |
14 HREF="video.html"><LINK | |
15 REL="PREVIOUS" | |
16 TITLE="SDL_UpdateRect" | |
17 HREF="sdlupdaterect.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_Flip" | |
20 HREF="sdlflip.html"></HEAD | |
21 ><BODY | |
22 CLASS="REFENTRY" | |
23 BGCOLOR="#FFF8DC" | |
24 TEXT="#000000" | |
25 LINK="#0000ee" | |
26 VLINK="#551a8b" | |
27 ALINK="#ff0000" | |
28 ><DIV | |
29 CLASS="NAVHEADER" | |
30 ><TABLE | |
31 WIDTH="100%" | |
32 BORDER="0" | |
33 CELLPADDING="0" | |
34 CELLSPACING="0" | |
35 ><TR | |
36 ><TH | |
37 COLSPAN="3" | |
38 ALIGN="center" | |
39 >SDL Library Documentation</TH | |
40 ></TR | |
41 ><TR | |
42 ><TD | |
43 WIDTH="10%" | |
44 ALIGN="left" | |
45 VALIGN="bottom" | |
46 ><A | |
47 HREF="sdlupdaterect.html" | |
48 >Prev</A | |
49 ></TD | |
50 ><TD | |
51 WIDTH="80%" | |
52 ALIGN="center" | |
53 VALIGN="bottom" | |
54 ></TD | |
55 ><TD | |
56 WIDTH="10%" | |
57 ALIGN="right" | |
58 VALIGN="bottom" | |
59 ><A | |
60 HREF="sdlflip.html" | |
61 >Next</A | |
62 ></TD | |
63 ></TR | |
64 ></TABLE | |
65 ><HR | |
66 ALIGN="LEFT" | |
67 WIDTH="100%"></DIV | |
68 ><H1 | |
69 ><A | |
70 NAME="SDLUPDATERECTS" | |
71 >SDL_UpdateRects</A | |
72 ></H1 | |
73 ><DIV | |
74 CLASS="REFNAMEDIV" | |
75 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
76 NAME="AEN977" |
0 | 77 ></A |
78 ><H2 | |
79 >Name</H2 | |
80 >SDL_UpdateRects -- Makes sure the given list of rectangles is updated on the given screen.</DIV | |
81 ><DIV | |
82 CLASS="REFSYNOPSISDIV" | |
83 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
84 NAME="AEN980" |
0 | 85 ></A |
86 ><H2 | |
87 >Synopsis</H2 | |
88 ><DIV | |
89 CLASS="FUNCSYNOPSIS" | |
90 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
91 NAME="AEN981" |
0 | 92 ></A |
93 ><P | |
94 ></P | |
95 ><PRE | |
96 CLASS="FUNCSYNOPSISINFO" | |
97 >#include "SDL.h"</PRE | |
98 ><P | |
99 ><CODE | |
100 ><CODE | |
101 CLASS="FUNCDEF" | |
102 >void <B | |
103 CLASS="FSFUNC" | |
104 >SDL_UpdateRects</B | |
105 ></CODE | |
106 >(SDL_Surface *screen, int numrects, SDL_Rect *rects);</CODE | |
107 ></P | |
108 ><P | |
109 ></P | |
110 ></DIV | |
111 ></DIV | |
112 ><DIV | |
113 CLASS="REFSECT1" | |
114 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
115 NAME="AEN987" |
0 | 116 ></A |
117 ><H2 | |
118 >Description</H2 | |
119 ><P | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
120 >Makes sure the given list of rectangles is updated on the given screen. |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
121 The rectangles must all be confined within the screen boundaries (no |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
122 clipping is done).</P |
0 | 123 ><P |
124 >This function should not be called while <TT | |
125 CLASS="PARAMETER" | |
126 ><I | |
127 >screen</I | |
128 ></TT | |
129 > is | |
130 <A | |
131 HREF="sdllocksurface.html" | |
132 >locked</A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
133 >.</P |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
134 ><DIV |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
135 CLASS="NOTE" |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
136 ><BLOCKQUOTE |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
137 CLASS="NOTE" |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
138 ><P |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
139 ><B |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
140 >Note: </B |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
141 >It is adviced to call this function only once per frame, since each |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
142 call has some processing overhead. This is no restriction since you |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
143 can pass any number of rectangles each time.</P |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
144 ><P |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
145 >The rectangles are not automatically merged or checked for overlap. In |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
146 general, the programmer can use his knowledge about his particular |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
147 rectangles to merge them in an efficient way, to avoid overdraw.</P |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
148 ></BLOCKQUOTE |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
149 ></DIV |
0 | 150 ></DIV |
151 ><DIV | |
152 CLASS="REFSECT1" | |
153 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
154 NAME="AEN996" |
0 | 155 ></A |
156 ><H2 | |
157 >See Also</H2 | |
158 ><P | |
159 ><A | |
160 HREF="sdlupdaterect.html" | |
161 ><TT | |
162 CLASS="FUNCTION" | |
163 >SDL_UpdateRect</TT | |
164 ></A | |
165 >, | |
166 <A | |
167 HREF="sdlrect.html" | |
168 ><SPAN | |
169 CLASS="STRUCTNAME" | |
170 >SDL_Rect</SPAN | |
171 ></A | |
172 >, | |
173 <A | |
174 HREF="sdlsurface.html" | |
175 ><SPAN | |
176 CLASS="STRUCTNAME" | |
177 >SDL_Surface</SPAN | |
178 ></A | |
179 >, | |
180 <A | |
181 HREF="sdllocksurface.html" | |
182 ><TT | |
183 CLASS="FUNCTION" | |
184 >SDL_LockSurface</TT | |
185 ></A | |
186 ></P | |
187 ></DIV | |
188 ><DIV | |
189 CLASS="NAVFOOTER" | |
190 ><HR | |
191 ALIGN="LEFT" | |
192 WIDTH="100%"><TABLE | |
193 WIDTH="100%" | |
194 BORDER="0" | |
195 CELLPADDING="0" | |
196 CELLSPACING="0" | |
197 ><TR | |
198 ><TD | |
199 WIDTH="33%" | |
200 ALIGN="left" | |
201 VALIGN="top" | |
202 ><A | |
203 HREF="sdlupdaterect.html" | |
204 >Prev</A | |
205 ></TD | |
206 ><TD | |
207 WIDTH="34%" | |
208 ALIGN="center" | |
209 VALIGN="top" | |
210 ><A | |
211 HREF="index.html" | |
212 >Home</A | |
213 ></TD | |
214 ><TD | |
215 WIDTH="33%" | |
216 ALIGN="right" | |
217 VALIGN="top" | |
218 ><A | |
219 HREF="sdlflip.html" | |
220 >Next</A | |
221 ></TD | |
222 ></TR | |
223 ><TR | |
224 ><TD | |
225 WIDTH="33%" | |
226 ALIGN="left" | |
227 VALIGN="top" | |
228 >SDL_UpdateRect</TD | |
229 ><TD | |
230 WIDTH="34%" | |
231 ALIGN="center" | |
232 VALIGN="top" | |
233 ><A | |
234 HREF="video.html" | |
235 >Up</A | |
236 ></TD | |
237 ><TD | |
238 WIDTH="33%" | |
239 ALIGN="right" | |
240 VALIGN="top" | |
241 >SDL_Flip</TD | |
242 ></TR | |
243 ></TABLE | |
244 ></DIV | |
245 ></BODY | |
246 ></HTML | |
247 > |