Go to most recent revision | Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 5131 | clevermous | 1 | |
| 2 | > |
||
| 3 | > |
||
| 4 | >SDL_SetColorKey |
||
| 5 | > |
||
| 6 | NAME="GENERATOR" |
||
| 7 | CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
||
| 8 | "> |
||
| 9 | REL="HOME" |
||
| 10 | TITLE="SDL Library Documentation" |
||
| 11 | HREF="index.html"> |
||
| 12 | REL="UP" |
||
| 13 | TITLE="Video" |
||
| 14 | HREF="video.html"> |
||
| 15 | REL="PREVIOUS" |
||
| 16 | TITLE="SDL_SaveBMP" |
||
| 17 | HREF="sdlsavebmp.html"> |
||
| 18 | REL="NEXT" |
||
| 19 | TITLE="SDL_SetAlpha" |
||
| 20 | HREF="sdlsetalpha.html"> |
||
| 21 | > |
||
| 22 | CLASS="REFENTRY" |
||
| 23 | BGCOLOR="#FFF8DC" |
||
| 24 | TEXT="#000000" |
||
| 25 | LINK="#0000ee" |
||
| 26 | VLINK="#551a8b" |
||
| 27 | ALINK="#ff0000" |
||
| 28 | > |
||
| 29 | CLASS="NAVHEADER" |
||
| 30 | > |
||
| 31 | WIDTH="100%" |
||
| 32 | BORDER="0" |
||
| 33 | CELLPADDING="0" |
||
| 34 | CELLSPACING="0" |
||
| 35 | > |
||
| 36 | > |
||
| 37 | COLSPAN="3" |
||
| 38 | ALIGN="center" |
||
| 39 | >SDL Library Documentation |
||
| 40 | > |
||
| 41 | > |
||
| 42 | > |
||
| 43 | WIDTH="10%" |
||
| 44 | ALIGN="left" |
||
| 45 | VALIGN="bottom" |
||
| 46 | > |
||
| 47 | HREF="sdlsavebmp.html" |
||
| 48 | >Prev |
||
| 49 | > |
||
| 50 | > |
||
| 51 | WIDTH="80%" |
||
| 52 | ALIGN="center" |
||
| 53 | VALIGN="bottom" |
||
| 54 | > |
||
| 55 | > |
||
| 56 | WIDTH="10%" |
||
| 57 | ALIGN="right" |
||
| 58 | VALIGN="bottom" |
||
| 59 | > |
||
| 60 | HREF="sdlsetalpha.html" |
||
| 61 | >Next |
||
| 62 | > |
||
| 63 | > |
||
| 64 | > |
||
| 65 | > |
||
| 66 | ALIGN="LEFT" |
||
| 67 | WIDTH="100%"> |
||
| 68 | > |
||
| 69 | > |
||
| 70 | NAME="SDLSETCOLORKEY" |
||
| 71 | >SDL_SetColorKey |
||
| 72 | > |
||
| 73 | > |
||
| 74 | CLASS="REFNAMEDIV" |
||
| 75 | > |
||
| 76 | NAME="AEN1630" |
||
| 77 | > |
||
| 78 | > |
||
| 79 | >Name |
||
| 80 | >SDL_SetColorKey -- Sets the color key (transparent pixel) in a blittable surface and |
||
| 81 | RLE acceleration. |
||
| 82 | > |
||
| 83 | CLASS="REFSYNOPSISDIV" |
||
| 84 | > |
||
| 85 | NAME="AEN1633" |
||
| 86 | > |
||
| 87 | > |
||
| 88 | >Synopsis |
||
| 89 | > |
||
| 90 | CLASS="FUNCSYNOPSIS" |
||
| 91 | > |
||
| 92 | NAME="AEN1634" |
||
| 93 | > |
||
| 94 | > |
||
| 95 | > |
||
| 96 | > |
||
| 97 | CLASS="FUNCSYNOPSISINFO" |
||
| 98 | >#include "SDL.h" |
||
| 99 | > |
||
| 100 | > |
||
| 101 | > |
||
| 102 | CLASS="FUNCDEF" |
||
| 103 | >int |
||
| 104 | CLASS="FSFUNC" |
||
| 105 | >SDL_SetColorKey |
||
| 106 | > |
||
| 107 | >(SDL_Surface *surface, Uint32 flag, Uint32 key); |
||
| 108 | > |
||
| 109 | > |
||
| 110 | > |
||
| 111 | > |
||
| 112 | > |
||
| 113 | > |
||
| 114 | CLASS="REFSECT1" |
||
| 115 | > |
||
| 116 | NAME="AEN1640" |
||
| 117 | > |
||
| 118 | > |
||
| 119 | >Description |
||
| 120 | > |
||
| 121 | > Sets the color key (transparent pixel) in a blittable surface and enables or |
||
| 122 | disables RLE blit acceleration. |
||
| 123 | > |
||
| 124 | >RLE acceleration can substantially speed up blitting of images with large |
||
| 125 | horizontal runs of transparent pixels (i.e., pixels that match the |
||
| 126 | |||
| 127 | CLASS="PARAMETER" |
||
| 128 | > |
||
| 129 | >key |
||
| 130 | > |
||
| 131 | > value). The |
||
| 132 | CLASS="PARAMETER" |
||
| 133 | > |
||
| 134 | >key |
||
| 135 | > |
||
| 136 | > must be of the same pixel format as the |
||
| 137 | CLASS="PARAMETER" |
||
| 138 | > |
||
| 139 | >surface |
||
| 140 | > |
||
| 141 | >, |
||
| 142 | HREF="sdlmaprgb.html" |
||
| 143 | > |
||
| 144 | CLASS="FUNCTION" |
||
| 145 | >SDL_MapRGB |
||
| 146 | > |
||
| 147 | > is often useful for obtaining an acceptable value. |
||
| 148 | > |
||
| 149 | >If |
||
| 150 | CLASS="PARAMETER" |
||
| 151 | > |
||
| 152 | >flag |
||
| 153 | > |
||
| 154 | > is |
||
| 155 | CLASS="LITERAL" |
||
| 156 | >SDL_SRCCOLORKEY |
||
| 157 | > then |
||
| 158 | |||
| 159 | CLASS="PARAMETER" |
||
| 160 | > |
||
| 161 | >key |
||
| 162 | > |
||
| 163 | > is the transparent pixel value in the source image of a |
||
| 164 | blit. |
||
| 165 | > |
||
| 166 | >If |
||
| 167 | CLASS="PARAMETER" |
||
| 168 | > |
||
| 169 | >flag |
||
| 170 | > |
||
| 171 | > is OR'd with |
||
| 172 | |||
| 173 | CLASS="LITERAL" |
||
| 174 | >SDL_RLEACCEL |
||
| 175 | > then the surface will be draw using RLE |
||
| 176 | acceleration when drawn with |
||
| 177 | |||
| 178 | HREF="sdlblitsurface.html" |
||
| 179 | >SDL_BlitSurface |
||
| 180 | >. The surface will |
||
| 181 | actually be encoded for RLE acceleration the first time |
||
| 182 | |||
| 183 | HREF="sdlblitsurface.html" |
||
| 184 | >SDL_BlitSurface |
||
| 185 | > or |
||
| 186 | |||
| 187 | HREF="sdldisplayformat.html" |
||
| 188 | >SDL_DisplayFormat |
||
| 189 | > is called on the |
||
| 190 | surface. |
||
| 191 | > |
||
| 192 | >If |
||
| 193 | CLASS="PARAMETER" |
||
| 194 | > |
||
| 195 | >flag |
||
| 196 | > |
||
| 197 | > is 0, this function clears |
||
| 198 | any current color key. |
||
| 199 | > |
||
| 200 | > |
||
| 201 | CLASS="REFSECT1" |
||
| 202 | > |
||
| 203 | NAME="AEN1661" |
||
| 204 | > |
||
| 205 | > |
||
| 206 | >Return Value |
||
| 207 | > |
||
| 208 | >This function returns |
||
| 209 | CLASS="RETURNVALUE" |
||
| 210 | >0 |
||
| 211 | >, or |
||
| 212 | |||
| 213 | CLASS="RETURNVALUE" |
||
| 214 | >-1 |
||
| 215 | > if there was an error. |
||
| 216 | > |
||
| 217 | > |
||
| 218 | CLASS="REFSECT1" |
||
| 219 | > |
||
| 220 | NAME="AEN1666" |
||
| 221 | > |
||
| 222 | > |
||
| 223 | >See Also |
||
| 224 | > |
||
| 225 | > |
||
| 226 | HREF="sdlblitsurface.html" |
||
| 227 | > |
||
| 228 | CLASS="FUNCTION" |
||
| 229 | >SDL_BlitSurface |
||
| 230 | > |
||
| 231 | >, |
||
| 232 | |||
| 233 | HREF="sdldisplayformat.html" |
||
| 234 | > |
||
| 235 | CLASS="FUNCTION" |
||
| 236 | >SDL_DisplayFormat |
||
| 237 | > |
||
| 238 | >, |
||
| 239 | |||
| 240 | HREF="sdlmaprgb.html" |
||
| 241 | > |
||
| 242 | CLASS="FUNCTION" |
||
| 243 | >SDL_MapRGB |
||
| 244 | > |
||
| 245 | >, |
||
| 246 | |||
| 247 | HREF="sdlsetalpha.html" |
||
| 248 | > |
||
| 249 | CLASS="FUNCTION" |
||
| 250 | >SDL_SetAlpha |
||
| 251 | > |
||
| 252 | > |
||
| 253 | > |
||
| 254 | > |
||
| 255 | CLASS="NAVFOOTER" |
||
| 256 | > |
||
| 257 | ALIGN="LEFT" |
||
| 258 | WIDTH="100%"> |
||
| 259 | WIDTH="100%" |
||
| 260 | BORDER="0" |
||
| 261 | CELLPADDING="0" |
||
| 262 | CELLSPACING="0" |
||
| 263 | > |
||
| 264 | > |
||
| 265 | WIDTH="33%" |
||
| 266 | ALIGN="left" |
||
| 267 | VALIGN="top" |
||
| 268 | > |
||
| 269 | HREF="sdlsavebmp.html" |
||
| 270 | >Prev |
||
| 271 | > |
||
| 272 | > |
||
| 273 | WIDTH="34%" |
||
| 274 | ALIGN="center" |
||
| 275 | VALIGN="top" |
||
| 276 | > |
||
| 277 | HREF="index.html" |
||
| 278 | >Home |
||
| 279 | > |
||
| 280 | > |
||
| 281 | WIDTH="33%" |
||
| 282 | ALIGN="right" |
||
| 283 | VALIGN="top" |
||
| 284 | > |
||
| 285 | HREF="sdlsetalpha.html" |
||
| 286 | >Next |
||
| 287 | > |
||
| 288 | > |
||
| 289 | > |
||
| 290 | > |
||
| 291 | WIDTH="33%" |
||
| 292 | ALIGN="left" |
||
| 293 | VALIGN="top" |
||
| 294 | >SDL_SaveBMP |
||
| 295 | > |
||
| 296 | WIDTH="34%" |
||
| 297 | ALIGN="center" |
||
| 298 | VALIGN="top" |
||
| 299 | > |
||
| 300 | HREF="video.html" |
||
| 301 | >Up |
||
| 302 | > |
||
| 303 | > |
||
| 304 | WIDTH="33%" |
||
| 305 | ALIGN="right" |
||
| 306 | VALIGN="top" |
||
| 307 | >SDL_SetAlpha |
||
| 308 | > |
||
| 309 | > |
||
| 310 | > |
||
| 311 | > |
||
| 312 | > |
||
| 313 | > |