This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
sdlsetalpha.html
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>SDL_SetAlpha</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_SetColorKey"
HREF="sdlsetcolorkey.html"><LINK
REL="NEXT"
TITLE="SDL_SetClipRect"
HREF="sdlsetcliprect.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="sdlsetcolorkey.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="sdlsetcliprect.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="SDLSETALPHA"
74
75
></A
>SDL_SetAlpha</H1
76
77
78
><DIV
CLASS="REFNAMEDIV"
><A
79
NAME="AEN2096"
80
81
82
83
84
85
86
></A
><H2
>Name</H2
>SDL_SetAlpha -- Adjust the alpha properties of a surface</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
87
NAME="AEN2099"
88
89
90
91
92
93
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
94
NAME="AEN2100"
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_SetAlpha</B
></CODE
>(SDL_Surface *surface, Uint32 flag, Uint8 alpha);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
118
NAME="AEN2106"
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
></A
><H2
>Description</H2
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>This function and the semantics of SDL alpha blending have changed since version 1.1.4. Up until version 1.1.5, an alpha value of 0 was considered opaque and a value of 255 was considered transparent. This has now been inverted: 0 (<TT
CLASS="LITERAL"
>SDL_ALPHA_TRANSPARENT</TT
>) is now considered transparent and 255 (<TT
CLASS="LITERAL"
>SDL_ALPHA_OPAQUE</TT
>) is now considered opaque.</P
></BLOCKQUOTE
></DIV
><P
><TT
CLASS="FUNCTION"
>SDL_SetAlpha</TT
142
143
> is used for setting the per-surface alpha
value and/or enabling and disabling alpha blending.</P
144
><P
145
>The<TT
146
147
148
149
CLASS="PARAMETER"
><I
>surface</I
></TT
150
151
> parameter specifies which surface whose alpha
attributes you wish to adjust. <TT
152
153
154
155
CLASS="PARAMETER"
><I
>flags</I
></TT
156
157
> is used to specify
whether alpha blending should be used (<TT
158
159
CLASS="LITERAL"
>SDL_SRCALPHA</TT
160
161
162
>) and
whether the surface should use RLE acceleration for blitting
(<TT
163
164
165
166
167
168
169
CLASS="LITERAL"
>SDL_RLEACCEL</TT
>). <TT
CLASS="PARAMETER"
><I
>flags</I
></TT
170
171
172
> can be an OR'd
combination of these two options, one of these options or 0. If
<TT
173
174
CLASS="LITERAL"
>SDL_SRCALPHA</TT
175
176
177
> is not passed as a flag then all alpha
information is ignored when blitting the surface. The
<TT
178
179
180
181
CLASS="PARAMETER"
><I
>alpha</I
></TT
182
183
184
> parameter is the per-surface alpha value; a
surface need not have an alpha channel to use per-surface alpha and blitting
can still be accelerated with <TT
185
186
CLASS="LITERAL"
>SDL_RLEACCEL</TT
187
>.</P
188
189
190
191
192
193
194
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
195
196
>The per-surface alpha value of 128 is considered a special case and
is optimised, so it's much faster than other per-surface values.</P
197
198
199
200
201
202
203
></BLOCKQUOTE
></DIV
><P
>Alpha effects surface blitting in the following ways:</P
><DIV
CLASS="INFORMALTABLE"
><A
204
NAME="AEN2126"
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
></A
><P
></P
><TABLE
BORDER="0"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>RGBA->RGB with <TT
CLASS="LITERAL"
>SDL_SRCALPHA</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The source is alpha-blended with the destination, using the alpha channel. <TT
CLASS="LITERAL"
>SDL_SRCCOLORKEY</TT
> and the per-surface alpha are ignored.</P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>RGBA->RGB without <TT
CLASS="LITERAL"
>SDL_SRCALPHA</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The RGB data is copied from the source. The source alpha channel and the per-surface alpha value are ignored.</P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>RGB->RGBA with <TT
CLASS="LITERAL"
>SDL_SRCALPHA</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
257
258
>The source is alpha-blended with the destination using the per-surface alpha
value. If <TT
259
260
CLASS="LITERAL"
>SDL_SRCCOLORKEY</TT
261
262
263
> is set, only the pixels not
matching the colorkey value are copied. The alpha channel of the copied pixels
is set to opaque.</P
264
265
266
267
268
269
270
271
272
273
274
275
276
277
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>RGB->RGBA without <TT
CLASS="LITERAL"
>SDL_SRCALPHA</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
278
279
>The RGB data is copied from the source and the alpha value of the copied pixels
is set to opaque. If <TT
280
281
CLASS="LITERAL"
>SDL_SRCCOLORKEY</TT
282
283
> is set, only the pixels
not matching the colorkey value are copied. </P
284
285
286
287
288
289
290
291
292
293
294
295
296
297
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>RGBA->RGBA with <TT
CLASS="LITERAL"
>SDL_SRCALPHA</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
298
299
300
>The source is alpha-blended with the destination using the source alpha
channel. The alpha channel in the destination surface is left untouched.
<TT
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
CLASS="LITERAL"
>SDL_SRCCOLORKEY</TT
> is ignored.</P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>RGBA->RGBA without <TT
CLASS="LITERAL"
>SDL_SRCALPHA</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The RGBA data is copied to the destination surface. If <TT
CLASS="LITERAL"
>SDL_SRCCOLORKEY</TT
> is set, only the pixels not matching the colorkey value are copied.</P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>RGB->RGB with <TT
CLASS="LITERAL"
>SDL_SRCALPHA</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The source is alpha-blended with the destination using the per-surface alpha value. If <TT
CLASS="LITERAL"
>SDL_SRCCOLORKEY</TT
> is set, only the pixels not matching the colorkey value are copied.</P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>RGB->RGB without <TT
CLASS="LITERAL"
>SDL_SRCALPHA</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The RGB data is copied from the source. If <TT
CLASS="LITERAL"
>SDL_SRCCOLORKEY</TT
> is set, only the pixels not matching the colorkey value are copied.</P
></TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Note that RGBA->RGBA blits (with SDL_SRCALPHA set) keep the alpha
of the destination surface. This means that you cannot compose two arbitrary
RGBA surfaces this way and get the result you would expect from "overlaying"
them; the destination alpha will work as a mask.</P
><P
>Also note that per-pixel and per-surface alpha cannot be combined;
the per-pixel alpha is always used if available</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
385
NAME="AEN2179"
386
387
388
389
390
391
392
393
394
395
396
397
></A
><H2
>Return Value</H2
><P
>This function returns <SPAN
CLASS="RETURNVALUE"
>0</SPAN
>, or
<SPAN
CLASS="RETURNVALUE"
>-1</SPAN
> if there was an error.</P
398
399
400
401
></DIV
><DIV
CLASS="REFSECT1"
><A
402
NAME="AEN2184"
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
></A
><H2
>See Also</H2
><P
><A
HREF="sdlmaprgba.html"
><TT
CLASS="FUNCTION"
>SDL_MapRGBA</TT
></A
>,
<A
HREF="sdlgetrgba.html"
><TT
CLASS="FUNCTION"
>SDL_GetRGBA</TT
></A
>,
<A
HREF="sdldisplayformatalpha.html"
><TT
CLASS="FUNCTION"
>SDL_DisplayFormatAlpha</TT
></A
>,
<A
HREF="sdlblitsurface.html"
><TT
CLASS="FUNCTION"
>SDL_BlitSurface</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
441
SUMMARY="Footer navigation table"
442
443
444
445
446
447
448
449
450
451
452
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlsetcolorkey.html"
453
ACCESSKEY="P"
454
455
456
457
458
459
460
461
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
462
ACCESSKEY="H"
463
464
465
466
467
468
469
470
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlsetcliprect.html"
471
ACCESSKEY="N"
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_SetColorKey</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="video.html"
487
ACCESSKEY="U"
488
489
490
491
492
493
494
495
496
497
498
499
500
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_SetClipRect</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>