e14743d1 |
1 | .TH "SDL_ConvertSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
2 | .SH "NAME" |
3 | SDL_ConvertSurface \- Converts a surface to the same format as another surface\&. |
4 | .SH "SYNOPSIS" |
5 | .PP |
6 | \fB#include "SDL/SDL\&.h" |
7 | .sp |
8 | \fBSDL_Surface *\fBSDL_ConvertSurface\fP\fR(\fBSDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags\fR); |
9 | .SH "DESCRIPTION" |
10 | .PP |
11 | Creates a new surface of the specified format, and then copies and maps the given surface to it\&. If this function fails, it returns \fBNULL\fP\&. |
12 | .PP |
13 | The \fBflags\fR parameter is passed to \fI\fBSDL_CreateRGBSurface\fP\fR and has those semantics\&. |
14 | .PP |
15 | This function is used internally by \fI\fBSDL_DisplayFormat\fP\fR\&. |
16 | .PP |
17 | This function can only be called after SDL_Init\&. |
18 | .SH "RETURN VALUE" |
19 | .PP |
20 | Returns either a pointer to the new surface, or \fBNULL\fP on error\&. |
21 | .SH "SEE ALSO" |
22 | .PP |
23 | \fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR |
24 | .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |