Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_ConvertSurface.3 @ 1271:092722dbc766
Whoops! (hope this compiles...)
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Thu, 26 Jan 2006 07:38:43 +0000 |
parents | e5bc29de3f0a |
children | 546f7c1eb755 |
rev | line source |
---|---|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_ConvertSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
0 | 2 .SH "NAME" |
3 SDL_ConvertSurface\- Converts a surface to the same format as another surface\&. | |
4 .SH "SYNOPSIS" | |
5 .PP | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
6 \fB#include "SDL/SDL\&.h" |
0 | 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\&. | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
16 .PP |
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
17 This function can only be called after SDL_Init\&. |
0 | 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 | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
24 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |