Skip to content

Latest commit

 

History

History
22 lines (22 loc) · 1.22 KB

SDL_DisplayFormatAlpha.3

File metadata and controls

22 lines (22 loc) · 1.22 KB
 
Sep 14, 2001
Sep 14, 2001
1
.TH "SDL_DisplayFormatAlpha" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
Apr 26, 2001
Apr 26, 2001
2
.SH "NAME"
Dec 29, 2007
Dec 29, 2007
3
SDL_DisplayFormatAlpha \- Convert a surface to the display format
Apr 26, 2001
Apr 26, 2001
4
5
6
7
8
9
10
11
12
13
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBSDL_Surface *\fBSDL_DisplayFormatAlpha\fP\fR(\fBSDL_Surface *surface\fR);
.SH "DESCRIPTION"
.PP
This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer plus an alpha channel, suitable for fast blitting onto the display surface\&. It calls \fISDL_ConvertSurface\fR
.PP
If you want to take advantage of hardware colorkey or alpha blit acceleration, you should set the colorkey and alpha value before calling this function\&.
Jun 10, 2001
Jun 10, 2001
14
15
.PP
This function can be used to convert a colourkey to an alpha channel, if the \fBSDL_SRCCOLORKEY\fP flag is set on the surface\&. The generated surface will then be transparent (alpha=0) where the pixels match the colourkey, and opaque (alpha=255) elsewhere\&.
Apr 26, 2001
Apr 26, 2001
16
17
18
19
20
21
.SH "RETURN VALUE"
.PP
If the conversion fails or runs out of memory, it returns \fBNULL\fR
.SH "SEE ALSO"
.PP
\fISDL_ConvertSurface\fR, \fISDL_SetAlpha\fR, \fISDL_SetColorKey\fR, \fISDL_DisplayFormat\fR, \fISDL_Surface\fR
Oct 10, 2009
Oct 10, 2009
22
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01