Mercurial > sdl-ios-xcode
annotate docs/html/sdlfillrect.html @ 432:80a35d43a58f
*** empty log message ***
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Thu, 01 Aug 2002 23:08:41 +0000 |
| parents | e5bc29de3f0a |
| children | 355632dca928 |
| rev | line source |
|---|---|
| 0 | 1 <HTML |
| 2 ><HEAD | |
| 3 ><TITLE | |
| 4 >SDL_FillRect</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_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 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="sdlblitsurface.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="sdldisplayformat.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="SDLFILLRECT" | |
| 71 >SDL_FillRect</A | |
| 72 ></H1 | |
| 73 ><DIV | |
| 74 CLASS="REFNAMEDIV" | |
| 75 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
76 NAME="AEN1967" |
| 0 | 77 ></A |
| 78 ><H2 | |
| 79 >Name</H2 | |
| 80 >SDL_FillRect -- This function performs a fast fill of the given rectangle with some color</DIV | |
| 81 ><DIV | |
| 82 CLASS="REFSYNOPSISDIV" | |
| 83 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
84 NAME="AEN1970" |
| 0 | 85 ></A |
| 86 ><H2 | |
| 87 >Synopsis</H2 | |
| 88 ><DIV | |
| 89 CLASS="FUNCSYNOPSIS" | |
| 90 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
91 NAME="AEN1971" |
| 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 >int <B | |
| 103 CLASS="FSFUNC" | |
| 104 >SDL_FillRect</B | |
| 105 ></CODE | |
| 106 >(SDL_Surface *dst, SDL_Rect *dstrect, Uint32 color);</CODE | |
| 107 ></P | |
| 108 ><P | |
| 109 ></P | |
| 110 ></DIV | |
| 111 ></DIV | |
| 112 ><DIV | |
| 113 CLASS="REFSECT1" | |
| 114 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
115 NAME="AEN1977" |
| 0 | 116 ></A |
| 117 ><H2 | |
| 118 >Description</H2 | |
| 119 ><P | |
| 120 >This function performs a fast fill of the given rectangle with | |
| 121 <TT | |
| 122 CLASS="PARAMETER" | |
| 123 ><I | |
| 124 >color</I | |
| 125 ></TT | |
| 126 >. If <TT | |
| 127 CLASS="PARAMETER" | |
| 128 ><I | |
| 129 >dstrect</I | |
| 130 ></TT | |
| 131 > | |
| 132 is <TT | |
| 133 CLASS="LITERAL" | |
| 134 >NULL</TT | |
| 135 >, the whole surface will be filled with | |
| 136 <TT | |
| 137 CLASS="PARAMETER" | |
| 138 ><I | |
| 139 >color</I | |
| 140 ></TT | |
| 141 >.</P | |
| 142 ><P | |
| 143 >The color should be a pixel of the format used by the surface, and | |
| 144 can be generated by the | |
| 145 <A | |
| 146 HREF="sdlmaprgb.html" | |
| 147 >SDL_MapRGB</A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
148 > or <A |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
149 HREF="sdlmaprgba.html" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
150 >SDL_MapRGBA</A |
| 0 | 151 > |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
152 functions. If the color value contains an alpha value then the |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
153 destination is simply "filled" with that alpha information, no blending |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
154 takes place.</P |
| 0 | 155 ><P |
| 156 >If there is a clip rectangle set on the destination (set via | |
| 157 <A | |
| 158 HREF="sdlsetcliprect.html" | |
| 159 >SDL_SetClipRect</A | |
| 160 >) then this | |
| 161 function will clip based on the intersection of the clip rectangle and | |
| 162 the <TT | |
| 163 CLASS="PARAMETER" | |
| 164 ><I | |
| 165 >dstrect</I | |
| 166 ></TT | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
167 > rectangle and the dstrect rectangle |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
168 will be modified to represent the area actually filled.</P |
| 0 | 169 ></DIV |
| 170 ><DIV | |
| 171 CLASS="REFSECT1" | |
| 172 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
173 NAME="AEN1990" |
| 0 | 174 ></A |
| 175 ><H2 | |
| 176 >Return Value</H2 | |
| 177 ><P | |
| 178 >This function returns <SPAN | |
| 179 CLASS="RETURNVALUE" | |
| 180 >0</SPAN | |
| 181 > on success, or | |
| 182 <SPAN | |
| 183 CLASS="RETURNVALUE" | |
| 184 >-1</SPAN | |
| 185 > on error.</P | |
| 186 ></DIV | |
| 187 ><DIV | |
| 188 CLASS="REFSECT1" | |
| 189 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
190 NAME="AEN1995" |
| 0 | 191 ></A |
| 192 ><H2 | |
| 193 >See Also</H2 | |
| 194 ><P | |
| 195 ><A | |
| 196 HREF="sdlmaprgb.html" | |
| 197 ><TT | |
| 198 CLASS="FUNCTION" | |
| 199 >SDL_MapRGB</TT | |
| 200 ></A | |
| 201 >, | |
| 202 <A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
203 HREF="sdlmaprgb.html" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
204 ><TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
205 CLASS="FUNCTION" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
206 >SDL_MapRGBA</TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
207 ></A |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
208 >, |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
209 <A |
| 0 | 210 HREF="sdlblitsurface.html" |
| 211 ><TT | |
| 212 CLASS="FUNCTION" | |
| 213 >SDL_BlitSurface</TT | |
| 214 ></A | |
| 215 >, | |
| 216 <A | |
| 217 HREF="sdlrect.html" | |
| 218 ><SPAN | |
| 219 CLASS="STRUCTNAME" | |
| 220 >SDL_Rect</SPAN | |
| 221 ></A | |
| 222 ></P | |
| 223 ></DIV | |
| 224 ><DIV | |
| 225 CLASS="NAVFOOTER" | |
| 226 ><HR | |
| 227 ALIGN="LEFT" | |
| 228 WIDTH="100%"><TABLE | |
| 229 WIDTH="100%" | |
| 230 BORDER="0" | |
| 231 CELLPADDING="0" | |
| 232 CELLSPACING="0" | |
| 233 ><TR | |
| 234 ><TD | |
| 235 WIDTH="33%" | |
| 236 ALIGN="left" | |
| 237 VALIGN="top" | |
| 238 ><A | |
| 239 HREF="sdlblitsurface.html" | |
| 240 >Prev</A | |
| 241 ></TD | |
| 242 ><TD | |
| 243 WIDTH="34%" | |
| 244 ALIGN="center" | |
| 245 VALIGN="top" | |
| 246 ><A | |
| 247 HREF="index.html" | |
| 248 >Home</A | |
| 249 ></TD | |
| 250 ><TD | |
| 251 WIDTH="33%" | |
| 252 ALIGN="right" | |
| 253 VALIGN="top" | |
| 254 ><A | |
| 255 HREF="sdldisplayformat.html" | |
| 256 >Next</A | |
| 257 ></TD | |
| 258 ></TR | |
| 259 ><TR | |
| 260 ><TD | |
| 261 WIDTH="33%" | |
| 262 ALIGN="left" | |
| 263 VALIGN="top" | |
| 264 >SDL_BlitSurface</TD | |
| 265 ><TD | |
| 266 WIDTH="34%" | |
| 267 ALIGN="center" | |
| 268 VALIGN="top" | |
| 269 ><A | |
| 270 HREF="video.html" | |
| 271 >Up</A | |
| 272 ></TD | |
| 273 ><TD | |
| 274 WIDTH="33%" | |
| 275 ALIGN="right" | |
| 276 VALIGN="top" | |
| 277 >SDL_DisplayFormat</TD | |
| 278 ></TR | |
| 279 ></TABLE | |
| 280 ></DIV | |
| 281 ></BODY | |
| 282 ></HTML | |
| 283 > |