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