|
1 <HTML |
|
2 ><HEAD |
|
3 ><TITLE |
|
4 >SDL_FillRect</TITLE |
|
5 ><META |
|
6 NAME="GENERATOR" |
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
|
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_BlitSurface" |
|
17 HREF="sdlblitsurface.html"><LINK |
|
18 REL="NEXT" |
|
19 TITLE="SDL_DisplayFormat" |
|
20 HREF="sdldisplayformat.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 SUMMARY="Header navigation table" |
|
32 WIDTH="100%" |
|
33 BORDER="0" |
|
34 CELLPADDING="0" |
|
35 CELLSPACING="0" |
|
36 ><TR |
|
37 ><TH |
|
38 COLSPAN="3" |
|
39 ALIGN="center" |
|
40 >SDL Library Documentation</TH |
|
41 ></TR |
|
42 ><TR |
|
43 ><TD |
|
44 WIDTH="10%" |
|
45 ALIGN="left" |
|
46 VALIGN="bottom" |
|
47 ><A |
|
48 HREF="sdlblitsurface.html" |
|
49 ACCESSKEY="P" |
|
50 >Prev</A |
|
51 ></TD |
|
52 ><TD |
|
53 WIDTH="80%" |
|
54 ALIGN="center" |
|
55 VALIGN="bottom" |
|
56 ></TD |
|
57 ><TD |
|
58 WIDTH="10%" |
|
59 ALIGN="right" |
|
60 VALIGN="bottom" |
|
61 ><A |
|
62 HREF="sdldisplayformat.html" |
|
63 ACCESSKEY="N" |
|
64 >Next</A |
|
65 ></TD |
|
66 ></TR |
|
67 ></TABLE |
|
68 ><HR |
|
69 ALIGN="LEFT" |
|
70 WIDTH="100%"></DIV |
|
71 ><H1 |
|
72 ><A |
|
73 NAME="SDLFILLRECT" |
|
74 ></A |
|
75 >SDL_FillRect</H1 |
|
76 ><DIV |
|
77 CLASS="REFNAMEDIV" |
|
78 ><A |
|
79 NAME="AEN2351" |
|
80 ></A |
|
81 ><H2 |
|
82 >Name</H2 |
|
83 >SDL_FillRect -- This function performs a fast fill of the given rectangle with some color</DIV |
|
84 ><DIV |
|
85 CLASS="REFSYNOPSISDIV" |
|
86 ><A |
|
87 NAME="AEN2354" |
|
88 ></A |
|
89 ><H2 |
|
90 >Synopsis</H2 |
|
91 ><DIV |
|
92 CLASS="FUNCSYNOPSIS" |
|
93 ><A |
|
94 NAME="AEN2355" |
|
95 ></A |
|
96 ><P |
|
97 ></P |
|
98 ><PRE |
|
99 CLASS="FUNCSYNOPSISINFO" |
|
100 >#include "SDL.h"</PRE |
|
101 ><P |
|
102 ><CODE |
|
103 ><CODE |
|
104 CLASS="FUNCDEF" |
|
105 >int <B |
|
106 CLASS="FSFUNC" |
|
107 >SDL_FillRect</B |
|
108 ></CODE |
|
109 >(SDL_Surface *dst, SDL_Rect *dstrect, Uint32 color);</CODE |
|
110 ></P |
|
111 ><P |
|
112 ></P |
|
113 ></DIV |
|
114 ></DIV |
|
115 ><DIV |
|
116 CLASS="REFSECT1" |
|
117 ><A |
|
118 NAME="AEN2361" |
|
119 ></A |
|
120 ><H2 |
|
121 >Description</H2 |
|
122 ><P |
|
123 >This function performs a fast fill of the given rectangle with |
|
124 <TT |
|
125 CLASS="PARAMETER" |
|
126 ><I |
|
127 >color</I |
|
128 ></TT |
|
129 >. If <TT |
|
130 CLASS="PARAMETER" |
|
131 ><I |
|
132 >dstrect</I |
|
133 ></TT |
|
134 > |
|
135 is <TT |
|
136 CLASS="LITERAL" |
|
137 >NULL</TT |
|
138 >, the whole surface will be filled with |
|
139 <TT |
|
140 CLASS="PARAMETER" |
|
141 ><I |
|
142 >color</I |
|
143 ></TT |
|
144 >.</P |
|
145 ><P |
|
146 >The color should be a pixel of the format used by the surface, and |
|
147 can be generated by the |
|
148 <A |
|
149 HREF="sdlmaprgb.html" |
|
150 >SDL_MapRGB</A |
|
151 > or <A |
|
152 HREF="sdlmaprgba.html" |
|
153 >SDL_MapRGBA</A |
|
154 > |
|
155 functions. If the color value contains an alpha value then the |
|
156 destination is simply "filled" with that alpha information, no blending |
|
157 takes place.</P |
|
158 ><P |
|
159 >If there is a clip rectangle set on the destination (set via |
|
160 <A |
|
161 HREF="sdlsetcliprect.html" |
|
162 >SDL_SetClipRect</A |
|
163 >) then this |
|
164 function will clip based on the intersection of the clip rectangle and |
|
165 the <TT |
|
166 CLASS="PARAMETER" |
|
167 ><I |
|
168 >dstrect</I |
|
169 ></TT |
|
170 > rectangle and the dstrect rectangle |
|
171 will be modified to represent the area actually filled.</P |
|
172 ></DIV |
|
173 ><DIV |
|
174 CLASS="REFSECT1" |
|
175 ><A |
|
176 NAME="AEN2374" |
|
177 ></A |
|
178 ><H2 |
|
179 >Return Value</H2 |
|
180 ><P |
|
181 >This function returns <SPAN |
|
182 CLASS="RETURNVALUE" |
|
183 >0</SPAN |
|
184 > on success, or |
|
185 <SPAN |
|
186 CLASS="RETURNVALUE" |
|
187 >-1</SPAN |
|
188 > on error.</P |
|
189 ></DIV |
|
190 ><DIV |
|
191 CLASS="REFSECT1" |
|
192 ><A |
|
193 NAME="AEN2379" |
|
194 ></A |
|
195 ><H2 |
|
196 >See Also</H2 |
|
197 ><P |
|
198 ><A |
|
199 HREF="sdlmaprgb.html" |
|
200 ><TT |
|
201 CLASS="FUNCTION" |
|
202 >SDL_MapRGB</TT |
|
203 ></A |
|
204 >, |
|
205 <A |
|
206 HREF="sdlmaprgb.html" |
|
207 ><TT |
|
208 CLASS="FUNCTION" |
|
209 >SDL_MapRGBA</TT |
|
210 ></A |
|
211 >, |
|
212 <A |
|
213 HREF="sdlblitsurface.html" |
|
214 ><TT |
|
215 CLASS="FUNCTION" |
|
216 >SDL_BlitSurface</TT |
|
217 ></A |
|
218 >, |
|
219 <A |
|
220 HREF="sdlrect.html" |
|
221 ><SPAN |
|
222 CLASS="STRUCTNAME" |
|
223 >SDL_Rect</SPAN |
|
224 ></A |
|
225 ></P |
|
226 ></DIV |
|
227 ><DIV |
|
228 CLASS="NAVFOOTER" |
|
229 ><HR |
|
230 ALIGN="LEFT" |
|
231 WIDTH="100%"><TABLE |
|
232 SUMMARY="Footer navigation table" |
|
233 WIDTH="100%" |
|
234 BORDER="0" |
|
235 CELLPADDING="0" |
|
236 CELLSPACING="0" |
|
237 ><TR |
|
238 ><TD |
|
239 WIDTH="33%" |
|
240 ALIGN="left" |
|
241 VALIGN="top" |
|
242 ><A |
|
243 HREF="sdlblitsurface.html" |
|
244 ACCESSKEY="P" |
|
245 >Prev</A |
|
246 ></TD |
|
247 ><TD |
|
248 WIDTH="34%" |
|
249 ALIGN="center" |
|
250 VALIGN="top" |
|
251 ><A |
|
252 HREF="index.html" |
|
253 ACCESSKEY="H" |
|
254 >Home</A |
|
255 ></TD |
|
256 ><TD |
|
257 WIDTH="33%" |
|
258 ALIGN="right" |
|
259 VALIGN="top" |
|
260 ><A |
|
261 HREF="sdldisplayformat.html" |
|
262 ACCESSKEY="N" |
|
263 >Next</A |
|
264 ></TD |
|
265 ></TR |
|
266 ><TR |
|
267 ><TD |
|
268 WIDTH="33%" |
|
269 ALIGN="left" |
|
270 VALIGN="top" |
|
271 >SDL_BlitSurface</TD |
|
272 ><TD |
|
273 WIDTH="34%" |
|
274 ALIGN="center" |
|
275 VALIGN="top" |
|
276 ><A |
|
277 HREF="video.html" |
|
278 ACCESSKEY="U" |
|
279 >Up</A |
|
280 ></TD |
|
281 ><TD |
|
282 WIDTH="33%" |
|
283 ALIGN="right" |
|
284 VALIGN="top" |
|
285 >SDL_DisplayFormat</TD |
|
286 ></TR |
|
287 ></TABLE |
|
288 ></DIV |
|
289 ></BODY |
|
290 ></HTML |
|
291 > |