SDL 1.2.13
[crawl:crawl-sdl.git] / docs / man3 / SDL_DisplayFormat.3
1 .TH "SDL_DisplayFormat" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_DisplayFormat \- Convert a surface to the display format
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBSDL_Surface *\fBSDL_DisplayFormat\fP\fR(\fBSDL_Surface *surface\fR);
9 .SH "DESCRIPTION"
10 .PP
11 This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer, suitable for fast blitting onto the display surface\&. It calls \fISDL_ConvertSurface\fR
12 .PP
13 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\&.
14 .PP
15 If you want an alpha channel, see \fISDL_DisplayFormatAlpha\fR\&.
16 .SH "RETURN VALUE"
17 .PP
18 If the conversion fails or runs out of memory, it returns \fBNULL\fR
19 .SH "SEE ALSO"
20 .PP
21 \fI\fBSDL_ConvertSurface\fP\fR, \fI\fBSDL_DisplayFormatAlpha\fP\fR \fI\fBSDL_SetAlpha\fP\fR, \fI\fBSDL_SetColorKey\fP\fR, \fI\fBSDL_Surface\fR\fR
22 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01